https://github.com/whyeasy/jira-sd-exporter

A Prometheus Exporter for Jira Service Desk Cloud.
https://github.com/whyeasy/jira-sd-exporter

Last synced: 16 days ago
JSON representation

A Prometheus Exporter for Jira Service Desk Cloud.

• Host: GitHub
• URL: https://github.com/whyeasy/jira-sd-exporter
• Owner: Whyeasy
• License: apache-2.0
• Created: 2020-08-17T07:25:47.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-07-02T13:13:45.000Z (over 3 years ago)
• Last Synced: 2024-06-20T10:14:53.967Z (6 months ago)
• Language: Go
• Size: 41 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![build](https://github.com/Whyeasy/jira-sd-exporter/workflows/build/badge.svg)

![status-badge](https://goreportcard.com/badge/github.com/Whyeasy/jira-sd-exporter)

![Github go.mod Go version](https://img.shields.io/github/go-mod/go-version/Whyeasy/jira-sd-exporter)

# jira-sd-exporter

A Prometheus Exporter for Jira Service Desk Cloud.

Currently this exporter retrieves the following metrics:

- Service Desk project Info within Jira (Key, Name and ID) `jira_sd_project_info`

- Total amount of tickets(Project key, Done) `jira_sd_ticket`

- Total amount of breached SLAs(Project key, Done) `jira_sd_sla`

## Requirements

Provide your Jira cloud URI; `--jiraURI ` or as env variable `JIRA_URI`

Provide a Jira API Key; `--jiraAPIKey` or as env variable `JIRA_API_KEY`

Provide the Jira user who created the API key; `--jiraAPIUser` or as env variable `JIRA_API_USER`

### Optional

Change listening port of the exporter; `--listenAddress ` or as env variable `LISTEN_ADDRESS`. Default = `8080`

Change listening path of the exporter; `--listenPath ` or as env variable `LISTEN_PATH`. Default = `/metrics`

Change the interval of retrieving data in the background; `--interval ` or as env variable `INTERVAL`. Default is `60`

To include or exclude projects from the Bugs metrics, please provide a comma separated string with the project keys. Please only provide 1.

Either with `--jiraKeyExclude ` or `--jiraKeyInclude `. You can also provide it via env variables `JIRA_KEY_EXCL` or `JIRA_KEY_INCL`.

If you use a custom field to assign issues/tickets to a custom team field. You can provide this custom field; `--jiraTeamCustomField ` or as env variable `JIRA_TEAM_CUSTOM_FIELD`. Please provide the full field, `customfield_`

If you want to monitor if your SLAs are breached or not. You can provide these SLAs with a comma separated string to retrieve these; `--jiraSLACustomFields ` or as env variables `JIRA_SLA_CUSTOM_FIELD`. Please provide the full field, `customfield_,customfield_`