Jira Pond

Summary

Jira pond is a plugin used by lake. The main thing it does is make api requests for you to Jira to fetch data and enrich it into a postgres database. Once this is done, you can use Grafana, hosted by Lake with docker-compose

Currently, this is how data flows:

And this is what you can expect to see for graphs in Grafana

Project Metrics This Covers

Configuration

First, you have to configure lake/config/plugins.js.

1. cp config/plugins.sample.js config/plugins.js
2. Look though this config file to make sure it is set to your needs. cat config/plugins.js

Gathering Data with Jira

Once you have lake running, you can fetch information from Github in one two ways:

1. Send a POST request to http://localhost:3001/

 {
     "jira": {
         "boardId": 123,
     }
 }

2. You can configure lake to get all of your data automatically.

Note: the following instructions are for User Setup. For Developer Setup, simply replace config/docker.sample.js and config/docker.js with config/local.sample.js and config/local.js.

• Make sure you have a file called config/docker.js. You can create one from the sample file: cp config/docker.sample.js config/docker.js
• Open this file for editing with your editor of choice or use vi config/local.js
• In this file, there is a section for cron.
• Set the boardId fo your own board ID in Jira.

NOTE: If you don't know how to find the boardId, see the section below :)

jira: {
  boardId: 123
}

• Restart lake services for the new configurtion to take effect immediately

Find Board Id

1. Navigate to the Jira board in the browser
2. in the URL bar, get the board id from the parameter ?rapidView=

Example: https://<your_jira_url>/secure/RapidBoard.jspa?rapidView=51

Use this board ID in your requests, to collect data from this board

Generating API token

1. Once logged into Jira, visit the url https://id.atlassian.com/manage-profile/security/api-tokens
2. Click the Create API Token button, and give it any label name

3. Copy and save the API token string into the lake plugin config file config/plugins.js

Jira Specific String Configuration

Adjust what is considered “Bug”, “Incident” or “Requirement”. This can be modified in config/plugins.js.

{
  package: 'jira-pond',
  name: 'jira',
  configuration: {
    enrichment: {
      issue: {
        mapping: {
          // This maps issue types in your Jira system to the standard issue type in dev lake
          // In lake, we define bugs as issues found in development process whereas
          // incidents are issues found in production environment
          // Format: <Standard Type>: [<Jira Type>]
          type: {
            // This mapping powers the metrics like Bug Count, But Age, and etc
            // Replace 'Bug' with your own issue types for bugs.
            Bug: ['Bug'],
            // This mapping powers the metrics like Incident Count, Incident Age, and etc
            // Replace 'Incident' with your own issue types for incidents
            Incident: ['Incident']
          }
        },
        // Enables lake to track which epic an issue belongs to
        // Replace 'customfiled_10014' with your own field ID for the epic key
        epicKeyField: 'customfield_10014'
      }
    }
  }
}