Settings API - Span capturing schema table
Span capturing (builtin:span-capturing)
OpenTelemetry spans are captured by default. Define rules to exclude specific spans.
Note: This config does not apply to Trace ingest.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:span-capturing |
| environment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-capturing |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:span-capturing | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-capturing |
Authentication
To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Property | Type | Description | Required |
|---|---|---|---|
Span Capture RulespanCaptureRule | SpanCaptureRule | - | required |
The SpanCaptureRule object
| Property | Type | Description | Required |
|---|---|---|---|
Rule nameruleName | text | - | required |
Rule actionruleAction | enum |
| required |
Matchersmatchers | SpanMatcher[] | - | required |
The SpanMatcher object
| Property | Type | Description | Required |
|---|---|---|---|
Sourcesource | enum |
| required |
KeysourceKey | text | - | required |
Comparison Typetype | enum | affects value
| required |
Valuevalue | text | evaluated at span start | required |
ValuespanKindValue | enum |
| required |
Case sensitivecaseSensitive | boolean | affects value and key | required |