Home
Quick Start: 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.
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.
You can export CSV files that can be used with various spreadsheets, like the excellent ones from Focused Objective or with tools like Actionable Agile.
Alternatively, this tool can directly generate HTML files with pretty charts in them.
- Installation (below)
- Configuring how it connects to Jira.
- Configuring the common portions of the export
- Specifically configuring it to export raw data or to generate HTML reports. (You'll need to set one of these)
- Running it (see below)
- Change log
At a high level, the steps to use this are as follows.
- If you're running this on ruby 3.0+ then invoke this on the command line
gem install jirametrics. If you're running this on java then see the JRuby notes - Create a file with Jira connection details. This tells the tool how to connect to your Jira instance.
- Create a file with all the configuration details. This specifies what output you want. Could be CSV's containing data. Could be an HTML report.
- Run
jirametrics goto pull all the data out of Jira and generate CVS or reports. Other commands are below.
| Command | Description |
|---|---|
| go | Same as calling download, followed by export. It's just a shorter way to do it all at once. |
| download | Download all the data from Jira |
| export | Generate the respective output files. These could be CSV's or HTML reports, as specified in the configuration |
| Option | Description |
|---|---|
| config | By default, the tool assumes that you've put your configuration in a file called config.rb. If you want to use different names then you can specify that with the --config <filename> option. This is useful if you want to have multiple configuration files and only call one or another. |
| name | If you have a large configuration file and only want to run a subset of the projects within it, you can use the --name <name> option. Example: jirametrics go --name "a*" will run all the projects starting with the letter 'a'. The name it compares against is the one specified on the project section. |