Improve docs on CI infra correlation #34013
Open
+9
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Preview links (active after the
|
estherk15
approved these changes
Jan 21, 2026
Contributor
estherk15
left a comment
estherk15
left a comment
There was a problem hiding this comment.
Left some option suggestions, but none block this PR! Approved for docs!
| To test that you have performed the setup successfully, you can try running a GitLab pipeline and checking if it appears on the [**Executions** page][8]. | ||
|
|
||
| You are required to enable the collection of job logs. You can check if Datadog is receiving the logs correctly by clicking on the Logs tab of your pipeline execution. | ||
| You are required to enable the collection of job logs. You can check if Datadog is receiving the logs correctly by clicking on the Logs tab of your pipeline execution. Ensure GitLab job logs are indexed and include messages in the form `Instance <hostname> connected`. Users also need [log read access][11] to see the Infrastructure tab. Logs for GitLab jobs include the `datadog.product:cipipeline` and `source:gitlab` tags, which you can use in [Log Indexes][10] filters. |
Contributor
There was a problem hiding this comment.
Suggested change
| You are required to enable the collection of job logs. You can check if Datadog is receiving the logs correctly by clicking on the Logs tab of your pipeline execution. Ensure GitLab job logs are indexed and include messages in the form `Instance <hostname> connected`. Users also need [log read access][11] to see the Infrastructure tab. Logs for GitLab jobs include the `datadog.product:cipipeline` and `source:gitlab` tags, which you can use in [Log Indexes][10] filters. | |
| You must enable job log collection. You can check if Datadog is receiving the logs correctly by clicking on the Logs tab of your pipeline execution. Ensure GitLab job logs are indexed and include messages in the form `Instance <hostname> connected`. Users also need [log read access][11] to see the Infrastructure tab. GitLab jobs logs include the `datadog.product:cipipeline` and `source:gitlab` tags, which you can use in [Log Indexes][10] filters. |
|
|
||
| {{% tab "Docker Autoscaler" %}} | ||
| CI Visibility supports Infrastructure metrics for "Docker Autoscaler" executors. For more information, see the [Correlate Infrastructure Metrics with GitLab Jobs guide][1]. | ||
| CI Visibility supports Infrastructure metrics for "Docker Autoscaler" executors through log-based correlation. Make sure GitLab job logs are indexed so Datadog can link jobs to hosts, and ensure those logs include messages in the form `Instance <hostname> connected`. Logs for GitLab jobs include the `datadog.product:cipipeline` and `source:gitlab` tags, which you can use in [Log Indexes][2] filters. Users also need [log read access][3] to see the Infrastructure data in this scenario. For more information, see the [Correlate Infrastructure Metrics with GitLab Jobs guide][1]. |
Contributor
There was a problem hiding this comment.
Suggested change
| CI Visibility supports Infrastructure metrics for "Docker Autoscaler" executors through log-based correlation. Make sure GitLab job logs are indexed so Datadog can link jobs to hosts, and ensure those logs include messages in the form `Instance <hostname> connected`. Logs for GitLab jobs include the `datadog.product:cipipeline` and `source:gitlab` tags, which you can use in [Log Indexes][2] filters. Users also need [log read access][3] to see the Infrastructure data in this scenario. For more information, see the [Correlate Infrastructure Metrics with GitLab Jobs guide][1]. | |
| CI Visibility supports Infrastructure metrics for "Docker Autoscaler" executors through log-based correlation. To enable this, make sure GitLab job logs are indexed so Datadog can link jobs to hosts, and that the logs include messages in the form `Instance <hostname> connected`. GitLab job logs include the `datadog.product:cipipeline` and `source:gitlab` tags, which you can use in [Log Indexes][2] filters. Users also need [log read access][3] to see the Infrastructure data in this scenario. For more information, see the [Correlate Infrastructure Metrics with GitLab Jobs guide][1]. |
|
|
||
| {{% tab "Instance" %}} | ||
| CI Visibility supports Infrastructure metrics for "Instance" executors. For more information, see the [Correlate Infrastructure Metrics with GitLab Jobs guide][1]. | ||
| CI Visibility supports Infrastructure metrics for "Instance" executors through log-based correlation. Make sure GitLab job logs are indexed so Datadog can link jobs to hosts, and ensure those logs include messages in the form `Instance <hostname> connected`. Logs for GitLab jobs include the `datadog.product:cipipeline` and `source:gitlab` tags, which you can use in [Log Indexes][2] filters. Users also need [log read access][3] to see the Infrastructure information in this scenario. For more information, see the [Correlate Infrastructure Metrics with GitLab Jobs guide][1]. |
Contributor
There was a problem hiding this comment.
If it looks good to you, apply the previous suggestion here as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Add some extra explanation on what logs exactly are needed for some GitLab infra correlation setups.
Merge instructions
Merge readiness: