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
  • group:service-monitoring
  • group:service-monitoring.spans
environment
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

Property
Type
Description
Required
Span Capture Rule
spanCaptureRule
-
required
The SpanCaptureRule object
Property
Type
Description
Required
Rule name
ruleName
text
-
required
Rule action
ruleAction
enum
  • CAPTURE
  • IGNORE
required
Matchers
matchers
-
required
The SpanMatcher object
Property
Type
Description
Required
Source
source
enum
  • SPAN_NAME
  • SPAN_KIND
  • ATTRIBUTE
  • INSTRUMENTATION_SCOPE_NAME
  • INSTRUMENTATION_SCOPE_VERSION
required
Key
sourceKey
text
-
required
Comparison Type
type
enum

affects value

  • EQUALS
  • CONTAINS
  • STARTS_WITH
  • ENDS_WITH
  • DOES_NOT_EQUAL
  • DOES_NOT_CONTAIN
  • DOES_NOT_START_WITH
  • DOES_NOT_END_WITH
required
Value
value
text

evaluated at span start

required
Value
spanKindValue
enum
  • INTERNAL
  • SERVER
  • CLIENT
  • PRODUCER
  • CONSUMER
required
Case sensitive
caseSensitive
boolean

affects value and key

required