What is it?

It’s a way to pull useful metrics out of Jira™¹.

Jira collects and maintains all kinds of useful data about your workflow. Unfortunately it does a horrible job of exposing that in any meaningful way. This project addresses that gap by giving you a way to pull that data out of Jira and either dumping it into CSV files that you can then manipulate yourself or by creating an HTML report with key findings.

If you just want to see something working fast, without wading through a lot of documentation on configuration, jump to the QuickStart and come back to the rest later.

How do I make it work?

At a high level, there are four steps, and we’ll walk through each.

1. Install JiraMetrics
2. Configure it to talk to your Jira instance(s).
3. Configure what kind of output you want and options you want to use. This is all in a single configuration file, which is described here.
   • HTML report using standard_project. Significantly easier to get set up but more limited in customization, as it makes a lot of assumptions about how you want things.
   • HTML report with full configuration. Highly customizable, but that means that you need to spend more time customizing it.
   • CSV files, suitable for import into other tools.
4. Run the tool and look at the output in the target directory.
   • See command line options

Other things you might want to know

• At the top of every report is a data quality section. Here’s more information on that.
• We release new versions fairly frequently. The full changelog can be found here.
• Getting errors or weird behaviour when running the tool? Check out the Frequently Asked Questions
• If you find a bug or have an idea for a feature, report it here
• If you want to contribute then check out the github projects for the tool itself or for the documentation and submit a PR.
• Dark/Light mode just works out of the box. If you have your machine configured for dark mode, that’s what you’ll see.

Presentation: Getting Great Metrics out of Jira

This talk walks through the kinds of metrics you can pull with JiraMetrics and walks through many of the charts.

---

Configuration Index

There are a lot of configuration items that can be set. Here’s an index to get you to the ones you want, quickly.

• Exporter.configure
  • target_path
  • jira_config
  • timezone_offset
  • project
    • file_prefix
    • download
    • board
      • cycletime
    • file (when exporting data in CSV)
      • file_suffix
      • only_use_row_if
      • columns
        • write_headers
        • column_entry_times
        • Type specific values
    • file (when creating an HTML report)
      • file_suffix
      • discard_changes_before
      • html_report
        • board_id
        • All Charts
          • cycletime_scatterplot
          • cycletime_histogram
          • throughput_chart
          • aging_work_in_progress_chart
          • daily_wip_by_age_chart
          • daily_wip_by_blocked_stalled_chart
          • daily_wip_by_parent
          • daily_wip_chart
          • expedited_chart
          • sprint_burndown
          • estimate_accuracy_chart
          • dependency_chart
            • issue_rules
            • link_rules
      • Styling the report
    • status_category_mapping
    • anonymize
    • standard_project
    • aggregated_project
    • Project specific settings