Skip to content

Jenkins Observability Best Practices

Account Registration

Go to the official website https://guance.com/ to register an account, then log in with your registered account/password.

1631932979(1).png

Install DataKit

Obtain the Token for the OpenWay Address

Click the "Integrations" module, then "DataKit" in the upper left corner, and select the appropriate installation command based on your operating system and system type.

1631933996(1).png

Execute the Installation

Copy the DataKit installation command and run it directly on the server you want to monitor.

  • Installation directory: /usr/local/datakit/
  • Log directory: /var/log/datakit/
  • Main configuration file: /usr/local/datakit/conf.d/datakit.conf
  • Plugin configuration directory: /usr/local/datakit/conf.d/

After DataKit is installed, common Linux host plugins are enabled by default. You can view them in DF — Infrastructure — Built-in Views.

Collector Description
cpu Collects CPU usage of the host
disk Collects disk usage
diskio Collects disk I/O of the host
mem Collects memory usage of the host
swap Collects swap memory usage
system Collects system load of the host
net Collects network traffic of the host
host_process Collects the list of persistent processes (alive for more than 10 minutes) on the host
hostobject Collects basic host information (e.g., OS info, hardware info)
docker Collects container objects and container logs on the host

Click the [Infrastructure] module to view the list of all hosts with DataKit installed and their basic information, such as hostname, CPU, memory, etc.

image.png

Monitoring Scenarios

Create a Scenario

Click the "Scenarios" module -> "Create Scenario"

1631934272(1).png

View the Scenario Dashboard

image.png

Enable Jenkins Collection in DataKit

Obtain Jenkins Access Keys

"Log in to Jenkins" -> "Manage Jenkins" -> "Manage Plugins" -> "Available" -> enter "metrics", click "Install without restart".

After installation, go to "Manage Jenkins" -> "Configure System" -> find Metrics, click "Generate..." on the right, then click "Save".

image.png

Configure DataKit

Create the jenkins.conf file, set the url to the Jenkins URL, and the key to the Metrics key.

$ cd /usr/local/datakit/conf.d/jenkins
$ cp jenkins.conf.sample jenkins.conf
$ vim jenkins.conf

image.png

Restart DataKit

$ Datakit --restart

Jenkins Overview

Jenkins Overview

Jenkins is the leading open-source CI/CD software, providing over 1000 plugins to support building, deploying, and automating any project.

Jenkins Performance Metrics

Metric Description Data Type Unit
executor_count Number of active executors int count
executor_free_count Number of idle executors int count
executor_in_use_count Number of executors in use int count
node_offline_count Number of offline nodes int count
node_online_count Number of online nodes int count
plugins_active Number of active plugins int count
plugins_failed Number of failed plugins int count
project_count Number of projects int count
job_count Number of jobs int count
queue_blocked Number of blocked jobs int count
queue_buildable Number of buildable jobs int count
queue_pending Number of pending jobs int count
queue_size Number of jobs in the build queue int count
queue_stuck Number of stuck jobs int count
system_cpu_load Jenkins system load float %
vm_blocked_count Number of blocked threads in Jenkins JVM int count
vm_count Total number of threads in Jenkins JVM int count
vm_cpu_load Jenkins CPU usage float %
vm_memory_total_used Total memory used by Jenkins int Byte

Feedback

Is this page helpful?