Flow Metrics

Actionable Metrics

Extract Flow Metrics from Jira. Visualize your team’s delivery performance.

Actionable Metrics connects to your Jira instance and exports work item data in ActionableAgile format, giving you instant visibility into cycle time, throughput, work item age, and more. Run it as a simple containerized tool with zero cloud dependencies.


Why Actionable Metrics?


Quick Start

cd actionable-metrics

2. Configure Environment

cp .env.example .env

Edit .env and add your access token:

ACCESS_TOKEN=glpat-xxxxxxxxxxxxxxxxxxxx

3. Run the Container

Linux/macOS:

./run_actionable_metrics_image.sh

Windows:

run_actionable_metrics_image.cmd

This creates:

4. Set Up Jira Credentials

Edit credentials.yaml:

server: https://your-company.atlassian.net
user: your.email@company.com
auth_method: basic_auth
pass: your-jira-api-token

Generate your Jira API token at: https://id.atlassian.com/manage/api-tokens

5. Generate Configuration

Inside the container:

board-to-configuration

Enter your board number (from URL: rapidView=XX). A configuration file will be created in configurations/new_generated/.

6. Configure Your Workflow

Edit the generated YAML file:

  1. Map all statuses to workflow columns
  2. Add (!!! arrival_column !!!) in the first “in progress” column
  3. Keep (!!! departure_column !!!) in the “done” column
  4. Save to configurations/your_project.yaml

Example:

Workflow:
  Backlog:
    - Inbox
    - Prioritized
  In Progress:
    - (!!! arrival_column !!!)
    - In Progress
  Done:
    - (!!! departure_column !!!)
    - Done

calculation_window: 30

7. Process Data

make-actionable-agile-data

Output files will be saved to ./output/.


Available Commands

Command Description
make-actionable-agile-data Export Jira data to ActionableAgile format
board-to-configuration Generate configuration from a Jira board
workflow-viewer Visualize your workflow configuration

Run any command with --help for detailed options.


Troubleshooting

Issue Solution
Docker permission errors on Linux Add your user to the docker group
Cannot pull container image Verify ACCESS_TOKEN in .env
Connection failures Check internet connectivity and firewall settings
Container won’t start Ensure Docker or Podman is running

Resources