Jerem

Jerem is a golang bot that scrap JIRA project to extract Metrics. Those Metrics can then be send to a Warp 10 Backend.

Jerem and Metrics

Jerem was build to send data to the OVH Metrics Data Platform. Copy the config.sample.yml file into a local or edit directly your config.yml. Jerem only require the following valid configuration keys:

metrics:
  url: https://warp.gra1.metrics.ovh.net
  token: METRICS_READ_TOKEN  # On the Metrics Data Platform, you can follow this [documentation](https://docs.ovh.com/gb/en/metrics/order/) to get a valid token.

Scrap a JIRA Project

Once your datasource is correctly set, you will want to add JIRA project to JEREM to scrap. Copy the config.sample.yml file into a local or edit directly your config.yml. First set your will need to configure JIRA based on the following configure keys:

jira:
  username: jira.bot
  password: 123456789
  url: https://jira.com

If you have custom closed JIRA status for a ticket, you can set the following jira config key:

jira:  
  closed.statuses:
    - Done

By default the closed JIRA status are (Resolved, Closed, Done). A list is expected for this optional parameter.

Then adding the project is simply done by editing the projects key. A single JIRA project require only two keys in the configuration file: it's project name and it's board id.

projects:
  - name: OB  # The JIRA board project name
    board: 0  # The JIRA board id (can be found in the board URL)
    jql_filter: component = test # Optional parameter to filter JIRAs inside a project
    label: OB_test # Optional parameter to override the project name with a custom label

Then you can simply add a second project:

projects:
  - name: OB
    board: 0
    jql_filter: component = test
    label: OB_test
  - name: K8S
    board: 1  

Compile and run jerem

You will need to have Golang set-up locally: check their golang installation step. Once jerem is well configure, you can simply run:

# Compile
make compile

# Run (will load local config.yaml file)
./bin/jerem

# Run with a remote config file
./bin/jerem --config /Path/to/config.yaml

Contributing

Instructions on how to contribute to Jerem are available on the Contributing page.

License

Jerem is released under a 3-BSD clause license.

Grafana's dashboards

In the grafana folder we are going to integrate all dashboards computed from Jerem metrics:

• program_management.json : the template for the grafana project management overview.

This dashboard needs a valid Warp 10 data source set up, with an RTOKEN variable set. To set up custom project for the program management dashboard, you need to update the Project variable. The value is a WarpScript string list. A valid value can be [ 'SAN' 'OTHER' ]. This render a dashboard in which we can switch on the SAN or to OTHER program management dashboard.

About Jerem

Here we keep track of all blog posts about the Agile methodology related to Jerem:

• The birth of agile telemetry at OVHcloud – Part I
• Jerem: An Agile Bot
• Agile telemetry at OVHCloud – Part II
• Agile telemetry at OVHCloud – Part III

Get in touch

• Gitter: metrics