---
title: "Jenkins integration | Grafana Cloud documentation"
description: "Learn about Jenkins Grafana Cloud integration."
---

> For a curated documentation index, see [llms.txt](/llms.txt). For the complete documentation index, see [llms-full.txt](/llms-full.txt).

# 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](https://plugins.jenkins.io/prometheus/) must be installed in your Jenkins instance.

## Install Jenkins integration for Grafana Cloud

1. In your Grafana Cloud stack, click **Connections** in the left-hand menu.
2. Find **Jenkins** and click its tile to open the integration.
3. Review the prerequisites in the **Configuration Details** tab and set up Grafana Alloy to send Jenkins metrics to your Grafana Cloud instance.
4. 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

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
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

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
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](/docs/alloy/latest/reference/components/discovery.relabel/) component to discover your Jenkins Prometheus endpoint and apply appropriate labels, followed by a [prometheus.scrape](/docs/alloy/latest/reference/components/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.

## 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\_executor\_free\_value
- jenkins\_executor\_in\_use\_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

md ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```md
# 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](/docs/grafana-cloud/fundamentals/active-series-and-dpm/) and [Cloud tier pricing](/products/cloud/pricing/).