Jenkins integration for Grafana Cloud

Jenkins is a free and open source automation server. It helps automate the parts of software development related to building, testing, and deploying, facilitating continuous integration and continuous delivery. It is a server-based system that runs in servlet containers such as Apache Tomcat.

This integration includes 1 pre-built dashboard to help monitor and visualize Jenkins metrics.

Before you begin

In order for the integration to work, the Prometheus plugin must be installed in your Jenkins instance.

Install Jenkins integration for Grafana Cloud

In your Grafana Cloud stack, click Connections in the left-hand menu.
Find Jenkins and click its tile to open the integration.
Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Jenkins metrics to your Grafana Cloud instance.
Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your Jenkins setup.

Configuration snippets for Grafana Alloy

Simple mode

These snippets are configured to scrape a Jenkins server running locally with default ports.

First, manually copy and append the following snippets into your alloy configuration file.

Metrics snippets

discovery.relabel "jenkins_metrics" {
  targets = [{
    __address__ = "localhost:8080",
  }]

  rule {
    target_label = "instance"
    replacement  = constants.hostname
  }
}

prometheus.scrape "jenkins_metrics" {
  targets      = discovery.relabel.jenkins_metrics.output
  forward_to   = [prometheus.remote_write.metrics_service.receiver]
  job_name     = "integrations/jenkins"
  metrics_path = "/prometheus"
}

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your Jenkins nodes, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced metrics snippets

discovery.relabel "jenkins_metrics" {
  targets = [{
    __address__ = "localhost:8080",
  }]

  rule {
    target_label = "instance"
    replacement  = constants.hostname
  }
}

prometheus.scrape "jenkins_metrics" {
  targets      = discovery.relabel.jenkins_metrics.output
  forward_to   = [prometheus.remote_write.metrics_service.receiver]
  job_name     = "integrations/jenkins"
  metrics_path = "/prometheus"
}

To monitor a Jenkins instance, you must use a discovery.relabel component to discover your Jenkins Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within the discovery.relabel component:

__address__: change this from localhost:8080 to the host and port of the remote Jenkins Prometheus metrics endpoint.
constants.hostname: the snippets set the instance label to your Grafana Alloy server hostname using the constants.hostname variable. If you are running Grafana Alloy outside of your Jenkins server host, change the variable to a value that uniquely identifies it.

If you have multiple Jenkins servers to scrape, configure one discovery.relabel for each and scrape them by including each under targets within the prometheus.scrape component.

Grafana Agent static configuration (deprecated)

The following section shows configuration for running Grafana Agent in static mode which is deprecated. You should use Grafana Alloy for all new deployments.

Before you begin

In order for the integration to work, the Prometheus plugin must be installed in your Jenkins instance.

Install Jenkins integration for Grafana Cloud

In your Grafana Cloud stack, click Connections in the left-hand menu.
Find Jenkins and click its tile to open the integration.
Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Jenkins metrics to your Grafana Cloud instance.
Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your Jenkins setup.

Post-install configuration for the Jenkins integration

After enabling the metrics generation, instruct Grafana Agent to scrape your Jenkins nodes.

Jenkins exposes a /prometheus 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

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

    - job_name: integrations/jenkins
      metrics_path: /prometheus
      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 Jenkins 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_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|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/jenkins
      metrics_path: /prometheus
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
        - targets: ['localhost:8080']
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

The Jenkins integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

Jenkins

Jenkins overview dashboard

Metrics

The most important metrics provided by the Jenkins integration, which are used on the pre-built dashboard, are as follows:

http_requests
http_responseCodes_badRequest_total
http_responseCodes_created_total
http_responseCodes_forbidden_total
http_responseCodes_noContent_total
http_responseCodes_notFound_total
http_responseCodes_notModified_total
http_responseCodes_ok_total
http_responseCodes_other_total
http_responseCodes_serverError_total
http_responseCodes_serviceUnavailable_total
jenkins_executor_count_value
jenkins_node_count_value
jenkins_node_online_value
jenkins_plugins_active
jenkins_plugins_failed
jenkins_plugins_inactive
jenkins_plugins_withUpdate
jenkins_queue_blocked_value
jenkins_queue_buildable_value
jenkins_queue_pending_value
jenkins_queue_stuck_value
jenkins_runs_failure_total
jenkins_runs_success_total
up

Changelog

# 1.0.0 - September 2024

* Update dashboard to remove deprecated angular panels
* Added Asserts support

# 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 - April 2023

* Update mixin to latest version:
  - Update panel descriptions

# 0.0.2 - May 2022

* Update mixin to latest version:
  - metrics_path uses `/prometheus` rather than `/api/prometheus`
  - scrape targets `localhost:8080` rather than `jenkins:8080`

# 0.0.1 - July 2021

* Initial release

Cost

By connecting your Jenkins 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.