Merge pull request DataDog#15139 from DataDog/drodriguezhdez/ci_app_jenkins_correlate_workers

jtappa · web-flow · commit 7295d0d0a13c · 2022-09-02T07:57:14.000-07:00
[CIAPP] Add instructions to correlate pipelines executed in Jenkins workers with infrastructure metrics.
diff --git a/content/en/continuous_integration/setup_pipelines/jenkins.md b/content/en/continuous_integration/setup_pipelines/jenkins.md
@@ -20,8 +20,7 @@ further_reading:
 ## Compatibility
 
 Supported Jenkins versions:
-* For 3.x versions of the plugin: Jenkins >= 2.164.1
-* For 4.x versions of the plugin: Jenkins >= 2.303.3
+* Jenkins >= 2.346.1
 
 ## Prerequisite
 
@@ -142,6 +141,27 @@ Re/Initialize Datadog-Plugin Agent Http Client
 TRACE -> http://<HOST>:<TRACE_PORT>/v0.3/traces
 {{< /code-block >}}
 
+### Infrastructure metric correlation
+
+If you are using Jenkins workers, you can corralate pipelines with the infrastructure that is running them. For this feature to work:
+
+1. Install the [Datadog Agent][1] in every Jenkins worker.
+2. Set and export a new environment variable called `DD_CI_HOSTNAME` in every Jenkins worker with the worker hostname. 
+  * It must be the same hostname that the Datadog Agent is reporting in the infrastructure metrics for that worker.
+  * You can use fixed values or other environment variables as valid values.
+
+```bash
+# Using fixed value
+export DD_CI_HOSTNAME=my-hostname
+
+# Using other environment variable
+export DD_CI_HOSTNAME=$HOSTNAME
+```
+
+This is only required for Jenkins workers. For the Jenkins controller, the infrastructure metric correlation does not require additional actions.
+
+**Note**: Infrastructure metric correlation is supported since Jenkins Plugin v5.0.0+
+
 ## Enable job log collection
 
 This is an optional step that enables the collection of job logs. It involves two steps: enabling the job collection port on the Datadog Agent, and enabling job collection on the Datadog Plugin.
