From 5ba046afc2efc84b53f07f6e628863577d619fd1 Mon Sep 17 00:00:00 2001 From: Maksym Ochenashko Date: Fri, 30 Aug 2024 16:53:38 +0300 Subject: [PATCH] docs: add `SpanLimits` configuration section --- docs/sdk/configuration.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/sdk/configuration.md b/docs/sdk/configuration.md index e21618b1d..421dfb0a6 100644 --- a/docs/sdk/configuration.md +++ b/docs/sdk/configuration.md @@ -192,3 +192,16 @@ The following options for `otel.traces.sampler` are supported out of the box: - `parentbased_always_off` - respects its parent span's sampling decision, but otherwise never samples. - `parentbased_traceidratio`, where `otel.traces.sampler.arg` sets the ratio - respects its parent span's sampling decision, but otherwise samples probabilistically based on the configured rate. + +### Span limits + +These properties can be used to control the maximum size of spans by placing limits on attributes, events, and links. + +| System property | Environment variable | Description | +|------------------------------------------|--------------------------------------------------|-----------------------------------------------------------------------| +| otel.span.attribute.count.limit | OTEL\\_SPAN\\_ATTRIBUTE\\_COUNT\\_LIMIT | The maximum allowed span attribute count. Default is `128`. | +| otel.span.event.count.limit | OTEL\\_SPAN\\_EVENT\\_COUNT\\_LIMIT | The maximum allowed span event count. Default is `128`. | +| otel.span.link.count.limit | OTEL\\_SPAN\\_LINK\\_COUNT\\_LIMIT | The maximum allowed span link count. Default is `128`. | +| otel.event.attribute.count.limit | OTEL\\_EVENT\\_ATTRIBUTE\\_COUNT\\_LIMIT | The maximum allowed attribute per span event count. Default is `128`. | +| otel.link.attribute.count.limit | OTEL\\_LINK\\_ATTRIBUTE\\_COUNT\\_LIMIT | The maximum allowed attribute per span link count. Default is `128`. | +| otel.span.attribute.value.length.limit | OTEL\\_SPAN\\_ATTRIBUTE\\_VALUE\\_LENGTH\\_LIMIT | The maximum allowed attribute value size. No limit by default. |