• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Span capturing

Settings API - Span capturing schema table

Span capturing (builtin:span-capturing)

OpenTelemetry/OpenTracing spans are captured by default. Define rules to exclude specific spans.

Note: This config does not apply to Trace ingest.

Schema IDSchema groupsScope
builtin:span-capturing
  • group:service-monitoring
  • group:service-monitoring.spans
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-capturing
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:span-capturing
Environment ActiveGatehttps://{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

PropertyLabelTypeDescriptionRequired
spanCaptureRuleSpan Capture RuleSpanCaptureRule-required

Request body objects

The SpanMatcher object
PropertyLabelTypeDescriptionRequired
sourceSourceenum-required
sourceKeyKeytext-required
typeComparison Typeenum

affects value

required
valueValuetext

evaluated at span start

required
spanKindValueValueenum-required
caseSensitiveCase sensitiveboolean

affects value and key

required
The SpanCaptureRule object
PropertyLabelTypeDescriptionRequired
ruleNameRule nametext-required
ruleActionRule actionenum-required
matchersMatcherslist-required