Jira integration for Grafana Cloud
Jira is a tool for planning, tracking, and releasing software. A Jira instance can be hosted by Jira on its own cloud or you can host it on AWS, Azure, or an on-premise server. This integration enables the agent to send metrics from a Jira instance you host to Grafana Cloud along with a useful pre-built dashboard for visualization.
This integration includes 4 useful alerts and 1 pre-built dashboard to help monitor and visualize Jira metrics.
Before you begin
In order for the integration to work, the
Prometheus Exporter for Jira must be installed and enabled on the Jira instance.
This can be installed through the Atlassian Marketplace. If you are running a Jira Server instance, you can use the free exporter, Jira Prometheus Exporter. If you are running on the Data Center version of Jira, you have to use the PRO version Jira Prometheus Exporter PRO. Click the installation tab to view instructions on how to install these exporters to your Jira instance.
Install Jira integration for Grafana Cloud
- In your Grafana Cloud stack, click Connections in the left-hand menu.
- Find Jira and click its tile to open the integration.
- Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Jira metrics to your Grafana Cloud instance.
- Click Install to add this integration’s pre-built dashboard and alerts to your Grafana Cloud instance, and you can start monitoring your Jira setup.
Post-install configuration for the Jira integration
After enabling the metrics generation, instruct Grafana Agent to scrape your JIRA nodes.
Jira exposes a
/plugins/servlet/prometheus/metrics endpoint. To scrape it, add the provided snippet to your agent configuration file.
Make sure to change
targets in the snippet according to your environment.
Configuration snippets for Grafana Agent
metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:
- job_name: "integrations/jira" metrics_path: "/plugins/servlet/prometheus/metrics" relabel_configs: - replacement: '<your-instance-name>' target_label: instance static_configs: - targets: ['localhost:8080']
Full example configuration for Grafana Agent
Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the Jira integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.
integrations: prometheus_remote_write: - basic_auth: password: <your_prom_pass> username: <your_prom_user> url: <your_prom_url> agent: enabled: true relabel_configs: - action: replace source_labels: - agent_hostname target_label: instance - action: replace target_label: job replacement: "integrations/agent-check" metric_relabel_configs: - action: keep regex: (prometheus_target_.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds) source_labels: - __name__ # Add here any snippet that belongs to the `integrations` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. logs: configs: - clients: - basic_auth: password: <your_loki_pass> username: <your_loki_user> url: <your_loki_url> name: integrations positions: filename: /tmp/positions.yaml scrape_configs: # Add here any snippet that belongs to the `logs.configs.scrape_configs` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. metrics: configs: - name: integrations remote_write: - basic_auth: password: <your_prom_pass> username: <your_prom_user> url: <your_prom_url> scrape_configs: # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section. # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line. - job_name: "integrations/jira" metrics_path: "/plugins/servlet/prometheus/metrics" relabel_configs: - replacement: '<your-instance-name>' target_label: instance static_configs: - targets: ['localhost:8080'] global: scrape_interval: 60s wal_directory: /tmp/grafana-agent-wal
The Jira integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.
The Jira integration includes the following useful alerts:
|LicenseExpired||Critical: JIRA license expired|
|LicenseWarning||Warning: License expiring soon|
|NoUserCapacity||Critical: All available accounts are taken|
|EmailErrorsHigh||Critical: Email errors are high.|
The most important metrics provided by the Jira integration, which are used on the pre-built dashboard and Prometheus alerts, are as follows:
# 0.0.4 - September 2023 * New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working. * New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label. # 0.0.3 - September 2022 * Update dashboard panels descriptions. # 0.0.2 - October 2021 * Update mixin to latest version: - Update the datasource template variable label to 'Data Source' - Update all rate queries to use `$__rate_interval` so they respect the default resolution # 0.0.1 - June 2021 * Initial release
By connecting your Jira instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.