Skip to main content

No project description provided

Project description

This package exports metrics about Jira issues as Prometheus metrics.

Usage

Configure API token

You’ll need to provide an API token to access the Jira REST API. Currently HTTP Basic authentication is used. See the Jira documentation for details.

Start HTTP service

Start the HTTP server like this:

$ JIRA_URL=https://example.atlassian.net JIRA_USERNAME=test@example.com JIRA_PASSWORD=APITOKEN jira_exporter --host=127.0.0.1 --port=9653

Pass --ttl=SECONDS to cache API results for the given time or -1 to disable (default is 600). Prometheus considers metrics stale after 300s, so that’s the highest scrape_interval one should use. However it’s usually unnecessary to hit the API that often, since the vulnerability alert information does not change that rapidly.

You can restrict which projects to look at by passing a comma-separated list of project keys (FOO, BAR etc.) with --projects.

Configure Prometheus

scrape_configs:
  - job_name: 'jira'
    scrape_interval: 300s
    static_configs:
      - targets: ['localhost:9653']

We export one metric, a gauge called jira_issues_total, with labels {project="PROJ", status="open"}.

Additionally, a jira_scrape_duration_seconds gauge is exported.

CHANGES

1.1.0 (2020-07-31)

  • Make projects configurable.

1.0.1 (2019-10-30)

  • Use correct listen port.

1.0.0 (2019-10-30)

  • First release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jira_exporter-1.1.0.tar.gz (5.3 kB view details)

Uploaded Source

File details

Details for the file jira_exporter-1.1.0.tar.gz.

File metadata

  • Download URL: jira_exporter-1.1.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.8

File hashes

Hashes for jira_exporter-1.1.0.tar.gz
Algorithm Hash digest
SHA256 63aaddfed014596148ad3c53da4c8bfa2aec75da39fbf09828215b7baf5c0865
MD5 25e7eb492ce7fcb755311507dce9476a
BLAKE2b-256 ac7e32c3afe70948ce9e63ca5ccfe571ec21e103e1e6ca3a6e4b704076b5dd99

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page