<br />

<br />

This document describes how to configure your Google Kubernetes Engine deployment
so that you can use Google Cloud Managed Service for Prometheus to collect metrics from

Jenkins. This document shows you how to do the following:

- Set up Jenkins to report metrics.
- Access a predefined dashboard in Cloud Monitoring to view the metrics.
- Configure alerting rules to monitor the metrics.

<br />

These instructions apply only if you are using [managed collection](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt)
with Managed Service for Prometheus.
If you are using self-deployed collection, then see the

[Jenkins documentation](https://github.com/jenkinsci/prometheus-plugin)

for installation information.

These instructions are provided as an example and are expected to work in
most Kubernetes environments.

If you are having trouble installing an
application or exporter due to restrictive security or organizational policies,
then we recommend you consult open-source documentation for support.

For information about Jenkins, see [Jenkins](https://www.jenkins.io/).

## Prerequisites

To collect metrics from

the Jenkins exporter

by using
Managed Service for Prometheus and managed collection, your deployment must
meet the following requirements:

- Your cluster must be running Google Kubernetes Engine version 1.28.15-gke.2475000 or later.
- You must be running Managed Service for Prometheus with managed collection enabled. For more information, see [Get started with managed collection](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt).

  <br />

- To use dashboards available in Cloud Monitoring for the Jenkins integration, you must use `jenkins` version 2.0.11 or later.

  For more information about available dashboards, see

  [View dashboards](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/exporters/jenkins.md.txt#monitoring-dashboard).

<br />

Jenkins exposes Prometheus-format metrics only after you install the [Metrics](https://plugins.jenkins.io/metrics/) and [Prometheus](https://plugins.jenkins.io/prometheus/) plugins.

<br />

If you installed the [Jenkins community helm chart](https://github.com/jenkinsci/helm-charts/tree/main/charts/jenkins), you can append the Metrics and Prometheus plugins
in the `controller.installPlugins` values field:

<br />

```
  controller:
    installPlugins:
      - kubernetes:3734.v562b_b_a_627ea_c
      - workflow-aggregator:590.v6a_d052e5a_a_b_5
      - git:4.13.0
      - configuration-as-code:1569.vb_72405b_80249
      - metrics
      - prometheus:2.0.11
  
```

<br />

Alternatively, you can create your own Jenkins container image with the following Dockerfile:

<br />

```
  FROM jenkins/jenkins:lts
  RUN jenkins-plugin-cli --plugins prometheus metrics
  
```

<br />

To verify that the Jenkins exporter is emitting metrics on the expected endpoints,
do the following:

1. Set up port-forwarding with the following command:

   ```
   kubectl -n NAMESPACE_NAME port-forward POD_NAME 8080
   ```
2. Access the endpoint `localhost:8080/prometheus` by using the browser
   or the `curl` utility in another terminal session.

## Define a PodMonitoring resource

For target discovery, the Managed Service for Prometheus Operator
requires a PodMonitoring resource that corresponds to
the Jenkins exporter in the same namespace.

You can use the following PodMonitoring configuration:

```yaml
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: jenkins
  labels:
    app.kubernetes.io/name: jenkins
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: http
    scheme: http
    interval: 30s
    path: /prometheus
  selector:
    matchLabels:
      app.kubernetes.io/name: jenkins
```
Ensure that the values of the `port` and `matchLabels` fields match those of the Jenkins pods you want to monitor. By default, Jenkins [Helm installations](https://github.com/jenkinsci/helm-charts/tree/main/charts/jenkins) include a `port` value of `http` and a `app.kubernetes.io/name` label with the value `jenkins`.

To apply configuration changes from a local file, run the following command:

```
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
```

<br />

You can also
[use Terraform](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt#terraform-scrape)
to manage your configurations.

## Define rules and alerts

You can use the following `Rules` configuration to define
alerts on your Jenkins metrics:

```yaml
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: jenkins-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: jenkins-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: jenkins
    interval: 30s
    rules:
    - alert: JenkinsHealthScoreBelowOne
      annotations:
        description: |-
          Jenkins health score below one
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Jenkins health score below one (instance {{ $labels.instance }})
      expr: jenkins_health_check_score < 1
      for: 5m
      labels:
        severity: critical
    - alert: JenkinsPluginFailure
      annotations:
        description: |-
          Jenkins plugin failure
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Jenkins plugin failure (instance {{ $labels.instance }})
      expr: jenkins_plugins_failed > 0
      for: 5m
      labels:
        severity: critical
```

To apply configuration changes from a local file, run the following command:

```
kubectl apply -n NAMESPACE_NAME -f FILE_NAME
```

<br />

You can also
[use Terraform](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/setup-managed.md.txt#terraform-scrape)
to manage your configurations.

For more information about applying rules to your cluster, see
[Managed rule evaluation and alerting](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/rules-managed.md.txt).
You can adjust the alert thresholds to suit your application.

## Verify the configuration

You can use Metrics Explorer to verify that you correctly configured
the Jenkins exporter. It might take one or two minutes for
Cloud Monitoring to ingest your metrics.

To verify the metrics are ingested, do the following:

1. In the Google Cloud console, go to the
   **Metrics explorer** page:

   [Go to **Metrics explorer**](https://console.cloud.google.com/monitoring/metrics-explorer)

   <br />

   If you use the search bar to find this page, then select the result whose subheading is
   **Monitoring**.
2. In the toolbar of the query-builder pane, select the button whose name is **PromQL**.
3. Enter and run the following query:  

   ```
   up{job="jenkins", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}
   ```

<br />

## View dashboards

The Cloud Monitoring integration includes

the **Jenkins Prometheus Overview** dashboard.

Dashboards are automatically installed when you configure the integration.
You can also view static previews of dashboards without installing the
integration.


To view an installed dashboard, do the following:

1. In the Google Cloud console, go to the **Dashboards** page:

   [Go to **Dashboards**](https://console.cloud.google.com/monitoring/dashboards)

   <br />

   If you use the search bar to find this page, then select the result whose subheading is
   **Monitoring**.
2. Select the **Dashboard List** tab.
3. Choose the **Integrations** category.
4. Click the name of the dashboard, for example, **Jenkins Prometheus Overview**.

<br />

To view a static preview of the dashboard, do the following:

1. In the Google Cloud console, go to the
   ![](https://docs.cloud.google.com/static/monitoring/images/integrations-icon.png) **Integrations**
   page:

   [Go to **Integrations**](https://console.cloud.google.com/monitoring/integrations)

   <br />

   If you use the search bar to find this page, then select the result whose subheading is
   **Monitoring**.
2. Click the **Kubernetes Engine** deployment-platform filter.
3. Locate the Jenkins integration and click **View Details**.
4. Select the **Dashboards** tab.

<br />

## Troubleshooting

For information about troubleshooting metric ingestion problems, see
[Problems with collection from exporters](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting.md.txt#exporter-problems) in [Troubleshooting ingestion-side problems](https://docs.cloud.google.com/stackdriver/docs/managed-prometheus/troubleshooting.md.txt#ingest-problems).