---
title: Telegraf Documentation
description: Telegraf plugin for collecting metrics from Jenkins
url: https://docs.influxdata.com/telegraf/v1/input-plugins/jenkins/
estimated_tokens: 3021
product: Telegraf
version: v1
---

-   Telegraf v1.9.0+

# Jenkins Input Plugin

This plugin gathers information about the nodes and jobs running in a [Jenkins](https://www.jenkins.io/) instance. The plugin uses the Jenkins API and does not require a plugin on the server.

**Introduced in:** Telegraf v1.9.0 **Tags:** applications **OS support:** all

## Global configuration options

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.

## Configuration

```toml
# Read jobs and cluster metrics from Jenkins instances
[[inputs.jenkins]]
  ## The Jenkins URL in the format "schema://host:port"
  url = "http://my-jenkins-instance:8080"
  # username = "admin"
  # password = "admin"

  ## Set response_timeout
  response_timeout = "5s"

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use SSL but skip chain & host verification
  # insecure_skip_verify = false

  ## Optional Max Job Build Age filter
  ## Default 1 hour, ignore builds older than max_build_age
  # max_build_age = "1h"

  ## Optional Sub Job Depth filter
  ## Jenkins can have unlimited layer of sub jobs
  ## This config will limit the layers of pulling, default value 0 means
  ## unlimited pulling until no more sub jobs
  # max_subjob_depth = 0

  ## Optional Sub Job Per Layer
  ## In workflow-multibranch-plugin, each branch will be created as a sub job.
  ## This config will limit to call only the lasted branches in each layer,
  ## empty will use default value 10
  # max_subjob_per_layer = 10

  ## Jobs to include or exclude from gathering
  ## When using both lists, job_exclude has priority.
  ## Wildcards are supported: [ "jobA/*", "jobB/subjob1/*"]
  # job_include = [ "*" ]
  # job_exclude = [ ]

  ## Nodes to include or exclude from gathering
  ## When using both lists, node_exclude has priority.
  # node_include = [ "*" ]
  # node_exclude = [ ]

  ## Worker pool for jenkins plugin only
  ## Empty this field will use default value 5
  # max_connections = 5

  ## When set to true will add node labels as a comma-separated tag. If none,
  ## are found, then a tag with the value of 'none' is used. Finally, if a
  ## label contains a comma it is replaced with an underscore.
  # node_labels_as_tag = false
```

## Metrics

-   jenkins
    
    -   tags:
        -   source
        -   port
    -   fields:
        -   busy\_executors
        -   total\_executors
-   jenkins\_node
    
    -   tags:
        -   arch
        -   disk\_path
        -   temp\_path
        -   node\_name
        -   status (“online”, “offline”)
        -   source
        -   port
    -   fields:
        -   disk\_available (Bytes)
        -   temp\_available (Bytes)
        -   memory\_available (Bytes)
        -   memory\_total (Bytes)
        -   swap\_available (Bytes)
        -   swap\_total (Bytes)
        -   response\_time (ms)
        -   num\_executors
-   jenkins\_job
    
    -   tags:
        -   name
        -   parents
        -   result
        -   source
        -   port
    -   fields:
        -   duration (ms)
        -   number
        -   result\_code (0 = SUCCESS, 1 = FAILURE, 2 = NOT\_BUILD, 3 = UNSTABLE, 4 = ABORTED)

## Sample Queries

```sql
SELECT mean("memory_available") AS "mean_memory_available", mean("memory_total") AS "mean_memory_total", mean("temp_available") AS "mean_temp_available" FROM "jenkins_node" WHERE time > now() - 15m GROUP BY time(:interval:) FILL(null)
```

```sql
SELECT mean("duration") AS "mean_duration" FROM "jenkins_job" WHERE time > now() - 24h GROUP BY time(:interval:) FILL(null)
```

## Example Output

```text
jenkins,host=myhost,port=80,source=my-jenkins-instance busy_executors=4i,total_executors=8i 1580418261000000000
jenkins_node,arch=Linux\ (amd64),disk_path=/var/jenkins_home,temp_path=/tmp,host=myhost,node_name=master,source=my-jenkins-instance,port=8080 swap_total=4294963200,memory_available=586711040,memory_total=6089498624,status=online,response_time=1000i,disk_available=152392036352,temp_available=152392036352,swap_available=3503263744,num_executors=2i 1516031535000000000
jenkins_job,host=myhost,name=JOB1,parents=apps/br1,result=SUCCESS,source=my-jenkins-instance,port=8080 duration=2831i,result_code=0i 1516026630000000000
jenkins_job,host=myhost,name=JOB2,parents=apps/br2,result=SUCCESS,source=my-jenkins-instance,port=8080 duration=2285i,result_code=0i 1516027230000000000
```

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [Jenkins Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/jenkins/README.md)