DOCS-5309 Linkerd Integration Edits (#15232)

* @alai97 Update README + Update Metrics

* Update README

* Revert "Update README"

This reverts commit deb79ac.

* Copy Nit

Co-authored-by: Ursula Chen <[email protected]>

* Update linkerd/README.md

* README Updates

* SME Review

Co-authored-by: Alex Lopez <[email protected]>

---------

Co-authored-by: Ursula Chen <[email protected]>
Co-authored-by: Alex Lopez <[email protected]>

linkerd/README.md

@@ -12,6 +12,10 @@ This integration sends your Linkerd metrics to Datadog, including application su
 
 ## 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][16].
+
+Metrics marked as `[OpenMetrics V1]` or `[OpenMetrics V2]` are only available using the corresponding mode of the Linkerd integration. Metrics not marked are collected by all modes.
+
 ### Installation
 
 The Linkerd check is included in the [Datadog Agent][2] package, so you don't need to install anything else on your server.
@@ -26,8 +30,7 @@ The Linkerd check is included in the [Datadog Agent][2] package, so you don't ne
 To configure this check for an Agent running on a host:
 
 1. Edit the `linkerd.d/conf.yaml` file, in the `conf.d/` folder at the root of your [Agent's configuration directory][3].
-   See [sample linkerd.d/conf.yaml][4] for all available configuration options.
-   **Note**: This is a new default OpenMetrics check example. If you previously implemented this integration, see the [legacy example][5].
+   See the [sample `linkerd.d/conf.yaml`][4] for all available configuration options using the latest OpenMetrics check example. If you previously implemented this integration, see the [legacy example][5].
 
 2. [Restart the Agent][6].
 
@@ -84,7 +87,7 @@ See [metadata.csv][11] for a list of metrics provided by this integration.
 
 For Linkerd v1, see the [finagle metrics guide][12] for metric descriptions and [this gist][13] for an example of metrics exposed by Linkerd.
 
-**Note**: Linkerd is a Prometheus-based integration. Depending on your Linkerd configuration, some metrics might not be exposed by Linkerd. If any metric is not present in the curl output, the Datadog Agent is unable to collect that particular metric.
+Linkerd is a Prometheus-based integration. Depending on your Linkerd configuration, some metrics might not be exposed by Linkerd. If any metric is not present in the cURL output, the Datadog Agent is unable to collect that particular metric.
 
 To list the metrics exposed by your current configuration, run:
 
@@ -96,7 +99,7 @@ Where `linkerd_prometheus_endpoint` is the Linkerd Prometheus endpoint (you shou
 
 If you need to use a metric that is not provided by default, you can add an entry to `linkerd.yaml`.
 
-Simply follow the examples present in the [default configuration][4].
+For more information, see the examples in the [default configuration][4].
 
 
 ### Service Checks
@@ -123,3 +126,4 @@ Need help? Contact [Datadog support][15].
 [13]: https://gist.githubusercontent.com/arbll/2f63a5375a4d6d5acface6ca8a51e2ab/raw/bc35ed4f0f4bac7e2643a6009f45f9068f4c1d12/gistfile1.txt
 [14]: https://github.com/DataDog/integrations-core/blob/master/linkerd/assets/service_checks.json
 [15]: https://docs.datadoghq.com/help/
+[16]: https://docs.datadoghq.com/integrations/guide/versions-for-openmetrics-based-integrations

linkerd/metadata.csv

@@ -1,5 +1,5 @@
 metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric
-linkerd.prometheus.health,gauge,,,,Whether the check is able to connect to the metrics endpoint,0,linkerd,,
+linkerd.prometheus.health,gauge,,,,Whether the check is able to connect to the metrics endpoint.,0,linkerd,,
 linkerd.jvm.start_time,gauge,,millisecond,,A gauge of the start time of the Java virtual machine in milliseconds since the epoch (Linkerd v1 only).,0,linkerd,,
 linkerd.jvm.thread.count,gauge,,thread,,A gauge of the number of live threads including both daemon and non-daemon threads (Linkerd v1 only).,0,linkerd,,
 linkerd.jvm.nonheap.committed,gauge,,byte,,"For the non-heap memory, a gauge of the amount of memory, in bytes, committed for the JVM to use (Linkerd v1 only).",-1,linkerd,,
@@ -39,52 +39,52 @@ linkerd.rt.client.request_latency_ms.quantile,gauge,,millisecond,,Stats of the l
 linkerd.rt.server.connections,gauge,,connection,,Number of active connections for the server (Linkerd v1 only).,0,linkerd,server active connections,
 linkerd.rt.server.connects_s,rate,,connection,second,Number of connection par second for the server (Linkerd v1 only).,0,linkerd,server connects/s,
 linkerd.rt.server.request_latency_ms.quantile,gauge,,millisecond,,Stats of the latency of requests in milliseconds for the server (Linkerd v1 only).,-1,linkerd,server requests latency,
-linkerd.request_total,count,,request,,[OpenMetricsV1] Total count of HTTP requests.,0,linkerd,,
-linkerd.request.count,count,,request,,[OpenMetricsV2] Total count of HTTP requests.,0,linkerd,,
+linkerd.request_total,count,,request,,[OpenMetrics V1] Total count of HTTP requests.,0,linkerd,,
+linkerd.request.count,count,,request,,[OpenMetrics V2] Total count of HTTP requests.,0,linkerd,,
 linkerd.response_latency.sum,gauge,,millisecond,,Elapsed times between a request's headers being received and its response stream completing.,0,linkerd,,
 linkerd.response_latency.count,gauge,,response,,Number of responses on which the linkerd.response_latency.sum metric is evaluated.,0,linkerd,,
-linkerd.response_total,count,,response,,[OpenMetricsV1] Total count of HTTP responses.,0,linkerd,,
-linkerd.response.count,count,,response,,[OpenMetricsV2] Total count of HTTP responses.,0,linkerd,,
-linkerd.retry_skipped_total,count,,response,,[OpenMetricsV1] Total count of retryable HTTP responses that were not retried.,-1,linkerd,,
-linkerd.retry_skipped.count,count,,response,,[OpenMetricsV2] Total count of retryable HTTP responses that were not retried.,-1,linkerd,,
-linkerd.route.request_total,count,,request,,[OpenMetricsV1] Total count of route HTTP requests.,0,linkerd,,
-linkerd.route.request.count,count,,request,,[OpenMetricsV2] Total count of route HTTP requests.,0,linkerd,,
+linkerd.response_total,count,,response,,[OpenMetrics V1] Total count of HTTP responses.,0,linkerd,,
+linkerd.response.count,count,,response,,[OpenMetrics V2] Total count of HTTP responses.,0,linkerd,,
+linkerd.retry_skipped_total,count,,response,,[OpenMetrics V1] Total count of retryable HTTP responses that were not retried.,-1,linkerd,,
+linkerd.retry_skipped.count,count,,response,,[OpenMetrics V2] Total count of retryable HTTP responses that were not retried.,-1,linkerd,,
+linkerd.route.request_total,count,,request,,[OpenMetrics V1] Total count of route HTTP requests.,0,linkerd,,
+linkerd.route.request.count,count,,request,,[OpenMetrics V2] Total count of route HTTP requests.,0,linkerd,,
 linkerd.route.response_latency.sum,gauge,,millisecond,,Elapsed times between a route request's headers being received and its response stream completing.,0,linkerd,,
 linkerd.route.response_latency.count,gauge,,response,,Number of responses on which the linkerd.route.response_latency.sum metric is evaluated.,0,linkerd,,
-linkerd.route.response_total,count,,response,,[OpenMetricsV1] Total count of route HTTP responses.,0,linkerd,,
-linkerd.route.response.count,count,,response,,[OpenMetricsV2] Total count of route HTTP responses.,0,linkerd,,
-linkerd.route.retry_skipped_total,count,,response,,[OpenMetricsV1] Total count of retryable route HTTP responses that were not retried.,-1,linkerd,,
-linkerd.route.retry_skipped.count,count,,response,,[OpenMetricsV2] Total count of retryable route HTTP responses that were not retried.,-1,linkerd,,
-linkerd.route.actual_request_total,count,,request,,[OpenMetricsV1] Total count of actual route HTTP requests.,0,linkerd,,
-linkerd.route.actual_request.count,count,,request,,[OpenMetricsV2] Total count of actual route HTTP requests.,0,linkerd,,
+linkerd.route.response_total,count,,response,,[OpenMetrics V1] Total count of route HTTP responses.,0,linkerd,,
+linkerd.route.response.count,count,,response,,[OpenMetrics V2] Total count of route HTTP responses.,0,linkerd,,
+linkerd.route.retry_skipped_total,count,,response,,[OpenMetrics V1] Total count of retryable route HTTP responses that were not retried.,-1,linkerd,,
+linkerd.route.retry_skipped.count,count,,response,,[OpenMetrics V2] Total count of retryable route HTTP responses that were not retried.,-1,linkerd,,
+linkerd.route.actual_request_total,count,,request,,[OpenMetrics V1] Total count of actual route HTTP requests.,0,linkerd,,
+linkerd.route.actual_request.count,count,,request,,[OpenMetrics V2] Total count of actual route HTTP requests.,0,linkerd,,
 linkerd.route.actual_response_latency.sum,gauge,,millisecond,,Elapsed times between a actual route request's headers being received and its response stream completing.,0,linkerd,,
 linkerd.route.actual_response_latency.count,gauge,,millisecond,,Number of responses on which the linkerd.route.actual_response_latency.sum is evaluated.,0,linkerd,,
-linkerd.route.actual_response_total,count,,response,,[OpenMetricsV1] Total count of actual route HTTP responses.,0,linkerd,,
-linkerd.route.actual_response.count,count,,response,,[OpenMetricsV2] Total count of actual route HTTP responses.,0,linkerd,,
-linkerd.route.actual_retry_skipped_total,count,,response,,[OpenMetricsV1] Total count of retryable actual route HTTP responses that were not retried.,-1,linkerd,,
-linkerd.route.actual_retry_skipped.count,count,,response,,[OpenMetricsV2] Total count of retryable actual route HTTP responses that were not retried.,-1,linkerd,,
-linkerd.tcp.open_total,count,,connection,,[OpenMetricsV1] Total count of opened connections.,0,linkerd,,
-linkerd.tcp.open.count,count,,connection,,[OpenMetricsV2] Total count of opened connections.,0,linkerd,,
+linkerd.route.actual_response_total,count,,response,,[OpenMetrics V1] Total count of actual route HTTP responses.,0,linkerd,,
+linkerd.route.actual_response.count,count,,response,,[OpenMetrics V2] Total count of actual route HTTP responses.,0,linkerd,,
+linkerd.route.actual_retry_skipped_total,count,,response,,[OpenMetrics V1] Total count of retryable actual route HTTP responses that were not retried.,-1,linkerd,,
+linkerd.route.actual_retry_skipped.count,count,,response,,[OpenMetrics V2] Total count of retryable actual route HTTP responses that were not retried.,-1,linkerd,,
+linkerd.tcp.open_total,count,,connection,,[OpenMetrics V1] Total count of opened connections.,0,linkerd,,
+linkerd.tcp.open.count,count,,connection,,[OpenMetrics V2] Total count of opened connections.,0,linkerd,,
 linkerd.tcp.open_connections,gauge,,connection,,Number of currently-open connections.,0,linkerd,,
-linkerd.tcp.read_bytes_total,count,,byte,,[OpenMetricsV1] Total count of bytes read from peers.,0,linkerd,,
-linkerd.tcp.read_bytes.count,count,,byte,,[OpenMetricsV2] Total count of bytes read from peers.,0,linkerd,,
-linkerd.tcp.write_bytes_total,count,,byte,,[OpenMetricsV1] Total count of bytes written to peers.,0,linkerd,,
-linkerd.tcp.write_bytes.count,count,,byte,,[OpenMetricsV2] Total count of bytes written to peers.,0,linkerd,,
-linkerd.tcp.close_total,count,,connection,,[OpenMetricsV1] Total count of closed connections.,0,linkerd,,
-linkerd.tcp.close.count,count,,connection,,[OpenMetricsV2] Total count of closed connections.,0,linkerd,,
+linkerd.tcp.read_bytes_total,count,,byte,,[OpenMetrics V1] Total count of bytes read from peers.,0,linkerd,,
+linkerd.tcp.read_bytes.count,count,,byte,,[OpenMetrics V2] Total count of bytes read from peers.,0,linkerd,,
+linkerd.tcp.write_bytes_total,count,,byte,,[OpenMetrics V1] Total count of bytes written to peers.,0,linkerd,,
+linkerd.tcp.write_bytes.count,count,,byte,,[OpenMetrics V2] Total count of bytes written to peers.,0,linkerd,,
+linkerd.tcp.close_total,count,,connection,,[OpenMetrics V1] Total count of closed connections.,0,linkerd,,
+linkerd.tcp.close.count,count,,connection,,[OpenMetrics V2] Total count of closed connections.,0,linkerd,,
 linkerd.tcp.connection_duration.sum,gauge,,millisecond,,Connection lifetimes.,0,linkerd,,
 linkerd.tcp.connection_duration.count,gauge,,connection,,Number of connections on which the linkerd.tcp.connection_duration.sum metric is evaluated.,0,linkerd,,
-linkerd.control.request_total,count,,request,,[OpenMetricsV1] Total count of control HTTP requests.,0,linkerd,,
-linkerd.control.request.count,count,,request,,[OpenMetricsV2] Total count of control HTTP requests.,0,linkerd,,
+linkerd.control.request_total,count,,request,,[OpenMetrics V1] Total count of control HTTP requests.,0,linkerd,,
+linkerd.control.request.count,count,,request,,[OpenMetrics V2] Total count of control HTTP requests.,0,linkerd,,
 linkerd.control.response_latency.sum,gauge,,millisecond,,Elapsed times between a control request's headers being received and its response stream completing.,0,linkerd,,
 linkerd.control.response_latency.count,gauge,,response,,Number of control responses on which the linkerd.control.response_latency.sum is evaluated.,0,linkerd,,
-linkerd.control.response_total,count,,response,,[OpenMetricsV1] Total count of control HTTP responses.,0,linkerd,,
-linkerd.control.response.count,count,,response,,[OpenMetricsV2] Total count of control HTTP responses.,0,linkerd,,
-linkerd.control.retry_skipped_total,count,,response,,[OpenMetricsV1] Total count of retryable control HTTP responses that were not retried.,-1,linkerd,,
-linkerd.control.retry_skipped.count,count,,response,,[OpenMetricsV2] Total count of retryable control HTTP responses that were not retried.,-1,linkerd,,
+linkerd.control.response_total,count,,response,,[OpenMetrics V1] Total count of control HTTP responses.,0,linkerd,,
+linkerd.control.response.count,count,,response,,[OpenMetrics V2] Total count of control HTTP responses.,0,linkerd,,
+linkerd.control.retry_skipped_total,count,,response,,[OpenMetrics V1] Total count of retryable control HTTP responses that were not retried.,-1,linkerd,,
+linkerd.control.retry_skipped.count,count,,response,,[OpenMetrics V2] Total count of retryable control HTTP responses that were not retried.,-1,linkerd,,
 linkerd.process.start_time,gauge,,second,,Time that the process started (in seconds since the UNIX epoch).,0,linkerd,,
-linkerd.process.cpu_seconds_total,count,,second,,[OpenMetricsV1] Total user and system CPU time spent in seconds.,0,linkerd,,
-linkerd.process.cpu_seconds.count,count,,second,,[OpenMetricsV2] Total user and system CPU time spent in seconds.,0,linkerd,,
+linkerd.process.cpu_seconds_total,count,,second,,[OpenMetrics V1] Total user and system CPU time spent in seconds.,0,linkerd,,
+linkerd.process.cpu_seconds.count,count,,second,,[OpenMetrics V2] Total user and system CPU time spent in seconds.,0,linkerd,,
 linkerd.process.open_fds,gauge,,file,,Number of open file descriptors.,0,linkerd,,
 linkerd.process.max_fds,gauge,,file,,Maximum number of open file descriptors.,0,linkerd,,
 linkerd.process.virtual_memory,gauge,,byte,,Virtual memory size in bytes.,0,linkerd,,