From 996091e37fdc18e51fa81143b262a0c87cb00f9a Mon Sep 17 00:00:00 2001 From: Jesse Rosenberger Date: Mon, 21 Oct 2024 18:17:00 +0300 Subject: [PATCH 1/2] Docs: Update Dynatrace Metrics documentation This ensures that `temporality: delta` is included in the suggestions for Dynatrace. --- .../telemetry/exporters/metrics/dynatrace.mdx | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx b/docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx index 41942dbb38..db3baba4ac 100644 --- a/docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx +++ b/docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx @@ -13,9 +13,12 @@ For general tracing configuration, refer to [Router Metrics Configuration](./ove To configure the router: - Enable the [OTLP exporter](./otlp#configuration) -- Set the `protocol` as `http`; Dynatrace [doesn't currently support](https://docs.dynatrace.com/docs/extend-dynatrace/opentelemetry/getting-started/otlp-export) `grpc` -- Provide your Dynatrace endpoint -- Provide your Dynatrace API token in the `Authorization` header; the header should start with [`Api-token` and then your Dynatrace token](https://docs.dynatrace.com/docs/extend-dynatrace/opentelemetry/getting-started/otlp-export#authentication-export-to-activegate) +- Set `temporality: delta` (Using _Delta_ is required as _Cumulative_ temporality is **not** supported by Dynatrace) +- Set the `protocol` as `http` (Dynatrace [doesn't currently support](https://docs.dynatrace.com/docs/extend-dynatrace/opentelemetry/getting-started/otlp-export) gRPC) +- Provide your [Dynatrace endpoint](https://docs.dynatrace.com/docs/dynatrace-api/environment-api/opentelemetry/post-metrics) (e.g., ensuring that it contains `{your-environment-id}` in the hostname and ends in `/api/v2/otlp/v1/metrics`) +- Provide your Dynatrace API token in the `Authorization` header (the header should start with [`Api-Token` and then your Dynatrace token](https://docs.dynatrace.com/docs/extend-dynatrace/opentelemetry/getting-started/otlp-export#authentication-export-to-activegate) + +For example: ```yaml title="router.yaml" telemetry: @@ -23,6 +26,7 @@ telemetry: metrics: otlp: enabled: true + temporality: delta # Endpoint for your region. endpoint: protocol: http @@ -33,7 +37,8 @@ telemetry: -You must specify `protocol: http` or the exporter will fail to connect to Dynatrace. Additionally, if your Dynatrace endpoint does not contain a port, you must append `:443` to the endpoint. For example: `https://subdomain.live.dynatrace.com:443/api/v2/otlp/v1/traces`. +You must specify `protocol: http` or the exporter will fail to connect to Dynatrace. You must use `temporality: delta` or some metrics will fail to be delivered to your deployment. + Additionally, if your Dynatrace endpoint does not contain a port, you **must** explicitly include `:443` as the port after the host address. For example: `https://subdomain.live.dynatrace.com:443/api/v2/otlp/v1/metrics`. From d4f0d34aa8bccf4fde42920d916a2becbc7b93af Mon Sep 17 00:00:00 2001 From: Jesse Rosenberger Date: Mon, 21 Oct 2024 18:18:44 +0300 Subject: [PATCH 2/2] Update dynatrace.mdx --- .../configuration/telemetry/exporters/metrics/dynatrace.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx b/docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx index db3baba4ac..dfd00f1c8d 100644 --- a/docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx +++ b/docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx @@ -15,7 +15,7 @@ To configure the router: - Enable the [OTLP exporter](./otlp#configuration) - Set `temporality: delta` (Using _Delta_ is required as _Cumulative_ temporality is **not** supported by Dynatrace) - Set the `protocol` as `http` (Dynatrace [doesn't currently support](https://docs.dynatrace.com/docs/extend-dynatrace/opentelemetry/getting-started/otlp-export) gRPC) -- Provide your [Dynatrace endpoint](https://docs.dynatrace.com/docs/dynatrace-api/environment-api/opentelemetry/post-metrics) (e.g., ensuring that it contains `{your-environment-id}` in the hostname and ends in `/api/v2/otlp/v1/metrics`) +- Set the `endpoint` to your [Dynatrace OpenTelemetry metrics endpoint](https://docs.dynatrace.com/docs/dynatrace-api/environment-api/opentelemetry/post-metrics) (e.g., ensuring that it contains `{your-environment-id}` in the hostname and ends in `/api/v2/otlp/v1/metrics`) - Provide your Dynatrace API token in the `Authorization` header (the header should start with [`Api-Token` and then your Dynatrace token](https://docs.dynatrace.com/docs/extend-dynatrace/opentelemetry/getting-started/otlp-export#authentication-export-to-activegate) For example: