Skip to content

docs: configurable cardinality limit for otel #111

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

Merged
endigma merged 1 commit into from
Jul 3, 2025
Merged

docs: configurable cardinality limit for otel #111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion docs/router/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,18 @@ telemetry:

## Metrics

| Environment Variable | YAML | Required | Description | Default Value |
| ------------------------------------ | ---------------------------- | ---------------------- | ------------------------------------------------------------------------------------------------- | ------------- |
| METRICS_EXPERIMENT_CARDINALITY_LIMIT | experiment_cardinality_limit | <Icon icon="square" /> | Sets a hard limit on the number of Metric Points that can be collected during a collection cycle. | 2000 |

<Warning>
The `experiment_cardinality_limit` option is experimental because it relies on experimental functionality in the OpenTelemetry SDK for Go. This feature helps prevent excessive memory usage by limiting the number of unique metric combinations (cardinality) that can be collected in a single collection cycle.

See the specification for more information: https://opentelemetry.io/docs/specs/otel/metrics/sdk/#cardinality-limits

This option may change or be removed in future versions as the OpenTelemetry SDK stabilizes this functionality.
</Warning>

### OTLP

| Environment Variable | YAML | Required | Description | Default Value |
Expand Down Expand Up @@ -572,6 +584,7 @@ telemetry:
# See "https://cosmo-docs.wundergraph.com/router/metrics-and-monitoring" for more information
telemetry:
metrics:
experiment_cardinality_limit: 2000
otlp:
enabled: true
router_runtime: true
Expand Down Expand Up @@ -2005,4 +2018,4 @@ cache_warmup:
timeout: 30s
source:
path: "./cache-warmer/operations"
```
```