Skip to content

magicdude4eva/docker-jirametrics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📊 Flow Metrics JiraMetrics

GitHub stars Build GitHub forks GitHub issues GitHub last commit License

A Dockerized setup for JiraMetrics, automating the generation and serving of Jira flow metrics reports.

Features

  • Automated reports: Updates every 30 minutes via cron.
  • Self-contained: HTML reports served via lightweight HTTP server.
  • Easy setup: Uses Docker and docker-compose.

Prerequisites

  • Docker and Docker Compose installed.

Usage

  1. Clone this repository or download this repository
  2. Download Rancher Desktop or use WSL2 / Docker Engine etc
  3. Adjust config in ./myreports -> refer to JiraMetrics for configuration:
  4. Run docker-compose up --build.
  5. Access reports at http://localhost:8000.

Environment Variables

Variable Default Value Description
INSTALL_PRE false Install pre-release version of JiraMetrics.
CRON_SCHEDULE */30 * * * * Cron schedule for report updates (e.g., every 30 min).

Data Persistence

  • Reports and configuration files are stored in the ./myreports directory on your host machine.
  • This directory is mounted to /config inside the container.

First Run

  • On first run, if the ./myreports/target directory is empty, the container will automatically generate initial reports.

Upgrades

  • The container checks for updates on startup (unless INSTALL_PRE=true).
  • Updates are applied automatically if a new version is available.

Configuration

  • Set INSTALL_PRE=true in docker-compose.yml for pre-release builds.
  • Adjust CRON_SCHEDULE to change update frequency.

Example Configuration

Custom Reports

This repository includes custom Ruby scripts to enhance the standard JiraMetrics reports with additional capacity and flow analysis.

📊 Capacity Report (myreports/capacity_report.rb)

A comprehensive capacity analysis tool that provides insights into team work distribution across Feature, Bug, and Other/Overhead buckets. image

image

Features:

  • Analyzes worklog data from Jira (via jirametrics.org JSON exports)
  • Monthly breakdown of ignored maintenance issues with per-month hours
  • Sub-task parent distribution analysis
  • Monthly trend visualization with focus mix and delta to previous month
  • Capacity split by bucket (Feature/Bug/Other)
  • Breakdown by issue type and worklog author
  • Top representative issues per bucket
  • Cross-team summary and pattern analysis
  • Early warning signals for capacity breaches

Usage:

ruby myreports/capacity_report.rb myreports/config.rb

Output includes:

  • Per-team capacity analysis with color-coded buckets
  • Monthly trends showing Feature/Bug/Other percentage mix
  • Ignored issues with monthly worklog breakdown
  • Top contributors with focus spread visualization
  • Cross-team pattern analysis with breach detection

Capacity Thresholds:

  • Bug % > 20%: Quality debt & interrupt load consuming capacity (muda)
  • Other % > 25%: Overhead crowding out value delivery (mura)
  • Feature % < 50%: Less than half effort on value-adding work
  • SPOF > 30%: Single point of failure risk (muri)
  • Trend arrows: Early warning for metrics trending toward thresholds

📈 Flow Metrics Enhancements (myreports/flow_metric_project.rb)

Added custom charts to the standard flow metrics reports:

Daily WIP by Issue Type Chart

  • Shows Work In Progress per day, grouped by issue type
  • Color-coded by type: Bug (red), Story (blue), Task (green), Other (gray)
  • Helps identify when bugs are consuming capacity that should be on features

About JiraMetrics

This project uses mikebowler/jirametrics, a tool for analyzing Jira workflows, cycle time, and throughput. See jirametrics.org for details.

Feature: Dataquality report gives insight into the state of data

image

Feature: WIP grouped by age / grouped by stalled

image image

Feature: Throughput chart by issue type and by completion status

image image

Feature: Cumulative Flow Diagram

image

📄 License

This project is licensed under the MIT License.


❤️ Contributing

PRs welcome! File issues or ideas via GitHub.

Donations are always welcome

🍻 Support my work
All my software is free and built in my personal time. If it helps you or your business, please consider a small donation via PayPal — it keeps the coffee ☕ and ideas flowing!

💸 Crypto Donations
You can also send crypto to one of the addresses below:

(BTC)   bc1qdgdkk7l98pje8ny9u4xavsvrea8dw6yu8jpnyf
(ETH)   0x5986f713A538D6bCaC0865564dCD45E2600A3469  
(POL)   0x5986f713A538D6bCaC0865564dCD45E2600A3469
(CRO)   0xb83c3Fe378F5224fAdD7a0f8a7dD33a6C96C422C (Cronos or Crypto.com Paystring magicdude$paystring.crypto.com)
(BNB)   0x5986f713A538D6bCaC0865564dCD45E2600A3469
(LTC)   ltc1qexst2exxksfyg7erfzlfrm23twkjgf7e5fn64t
(DOGE)  DMQsxc9XGF6526drBJDZeX7AjFDJsEz4mN
(SOL)   t4bYQCUuoCUrp7kJ4Mz314npcTuKoUSXj28UgdMrfTb

🧾 Recommended Platforms

  • 👉 Curve.com: Add your Crypto.com card to Apple Pay
  • 🔐 Crypto.com: Stake and get your free Crypto Visa card
  • 📈 Binance: Trade altcoins easily

About

Dockerized JiraMetrics for automated, scheduled generation and serving of Jira reports. Uses CRuby, Graphviz, and a lightweight HTTP server to update and serve self-contained HTML reports every 30 minutes. Ideal for teams tracking flow metrics, cycle time, and workflow efficiency. Built on top of mikebowler/jirametrics.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors