DOCS-5309 GitLab Integration Edits + Metrics Versioning Organization (#…

…15085) * Update README + Order Metrics * Link Nit Co-authored-by: Florent Clarret <[email protected]> * Update gitlab/README.md * Remove [Legacy] Co-authored-by: Alex Lopez <[email protected]> * README Updates * README Update * SME Review --------- Co-authored-by: Florent Clarret <[email protected]> Co-authored-by: Alex Lopez <[email protected]>
DataDog · Sep 19, 2023 · b452edd · b452edd
1 parent 2c9f3f9
commit b452edd
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/gitlab/README.md b/gitlab/README.md
@@ -12,6 +12,12 @@ For more in-depth monitoring of your GitLab pipelines, check out [CI Pipeline Vi
 
 ## Setup
 
+This OpenMetrics-based integration has a latest mode (enabled by setting `openmetrics_endpoint` to point to the target endpoint) and a legacy mode (enabled by setting `prometheus_url` instead). To get all the most up-to-date features, Datadog recommends enabling the latest mode. For more information, see [Latest and Legacy Versioning For OpenMetrics-based Integrations][18].
+
+Metrics marked as `[OpenMetricsV1]` or `[OpenMetricsV2]` are only available using the corresponding mode of the GitLab integration. All other metrics are collected by both modes. 
+
+To use the legacy mode of Prometheus or OpenMetrics instead of the latest mode of OpenMetrics, change the `use_openmetrics` option to `use_prometheus`, and change the `openmetrics_endpoint` option to `prometheus_url`. For more information, see the [Prometheus and OpenMetrics metrics collection from a host documentation][30].
+
 ### Installation
 
 The GitLab check is included in the [Datadog Agent][2] package, so you don't need to install anything else on your GitLab servers.
@@ -105,8 +111,6 @@ Collecting logs is disabled by default in the Datadog Agent. To enable it, see [
 
 See [metadata.csv][12] for a list of metrics provided by this integration. 
 
-**Note**: Metrics marked as `[Legacy]`, `[OpenMetricsV1]`, or `[OpenMetricsV2]` are only available using the corresponding implementation of the GitLab integration. Metrics not marked are collected by all three implementations.
-
 ### Events
 
 The GitLab check does not include any events.
@@ -135,4 +139,5 @@ Need help? Contact [Datadog support][14].
 [14]: https://docs.datadoghq.com/help/
 [15]: https://docs.gitlab.com/ee/user/admin_area/monitoring/health_check.html#readiness
 [16]: https://github.com/DataDog/integrations-core/blob/7.43.x/gitlab/datadog_checks/gitlab/data/conf.yaml.example
-[17]: https://app.datadoghq.com/ci/getting-started
+[17]: https://app.datadoghq.com/ci/getting-started
+[18]: https://docs.datadoghq.com/integrations/guide/versions-for-openmetrics-based-integrations