Jenkins

·

The Jenkins collector monitors Jenkins through plugin Metrics data collection, including but not limited to the number of tasks, system cpu usage, jvm cpu usage, and so on

Configuration¶

Preconditions¶

• JenKins version >= 2.332.1; Already tested version:

  • 2.332.1
  • 2.452.4
  • 2.479.1
  • 2.504.2

• Install JenKins see here

• Download the Metric plug-in, management plug-in page,Metric plug-in page
• Generate Metric Access keys on the JenKins administration page your_manage_host/configure

Collector Configuration¶

[[inputs.jenkins]]
  ## Set true if you want to collect metric from url below.
  enable_collect = true

  ## The Jenkins URL in the format "schema://host:port",required
  url = "http://my-jenkins-instance:8080"

  ## Metric Access Key ,generate in your-jenkins-host:/configure,required
  key = ""

  # ##(optional) collection interval, default is 30s
  # interval = "30s"

  ddinfo_resp = '''{ "endpoints": ["/v0.3/traces"] }'''

  ## Set response_timeout
  # response_timeout = "5s"

  ## Set true to enable election(default: true)
  # election = true

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

  ## set true to receive jenkins CI event
  enable_ci_visibility = true

  ## which port to listen to jenkins CI event
  ci_event_port = ":9539"

  # [inputs.jenkins.log]
  # files = []
  # #grok pipeline script path
  # pipeline = "jenkins.p"

  [inputs.jenkins.tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"
  # ...

  [inputs.jenkins.ci_extra_tags]
  # some_tag = "some_value"
  # more_tag = "some_other_value"

Jenkins CI Visibility¶

The Jenkins collector can realize CI visualization by receiving the CI Event from the Jenkins Datadog plugin.

Jenkins CI Visibility opening method:

• Ensure that the Jenkins CI Visibility feature is turned on in the configuration file and the listening port number is configured (such as :9539), restart DataKit;
• Install Jenkins Datadog plugin in Jenkins;
• Select Use the Datadog Agent to report to Datadog (recommended) in Manage Jenkins > Configure System > Datadog Plugin and configure Agent Host as the DataKit IP address. Both DogStatsD Port and Traces Collection Port are configured to the port number configured in the Jenkins collector configuration file above, such as 9539(do not add :);
• Check Enable CI Visibility；
• Click Save to Save the settings.

After configuration, Jenkins can send CI events to DataKit through Datadog Plugin.

Metric¶

For all of the following data collections, the global election tags will added automatically, we can add extra tags in [inputs.jenkins.tags] if needed:

[inputs.jenkins.tags]
# some_tag = "some_value"
# more_tag = "some_other_value"
# ...

You can specify additional tags for the Jenkins CI Event in the configuration by [inputs.jenkins.ci_extra_tags]:

[inputs.jenkins.ci_extra_tags]
# some_tag = "some_value"
# more_tag = "some_other_value"

jenkins¶

jenkins_pipeline¶

jenkins_job¶

Log Collection¶

To collect the JenKins log, open files in jenkins.conf and write to the absolute path of the JenKins log file. For example:

    [[inputs.JenKins]]
      ...
      [inputs.JenKins.log]
        files = ["/var/log/jenkins/jenkins.log"]

When log collection is turned on, a log with a log source of jenkins is generated by default.

Note: DataKit must be installed on the host where JenKins is located to collect JenKins logs.

Log Pipeline Feature Cut Field Description¶

• JenKins Universal Log Cutting

Example of common log text:

2021-05-18 03:08:58.053+0000 [id=32] INFO jenkins.InitReactorRunner$1#onAttained: Started all plugins

The list of cut fields is as follows: