Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update Dynatrace Metrics documentation #6179

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Docs: Update Dynatrace Metrics documentation #6179

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
996091e
Docs: Update Dynatrace Metrics documentation
abernix Oct 21, 2024
d4f0d34
Update dynatrace.mdx
abernix Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/source/configuration/telemetry/exporters/metrics/dynatrace.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,20 @@ 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)
- 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:

```yaml title="router.yaml"
telemetry:
exporters:
metrics:
otlp:
enabled: true
temporality: delta
# Endpoint for your region.
endpoint: <dynatrace-endpoint>
protocol: http
Expand All @@ -33,7 +37,8 @@ telemetry:

<Note>

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`.

</Note>

Expand Down