Settings API - Span failure detection configuration schema table

  • Published Sep 25, 2025

Span failure detection configuration (builtin:span-failure-detection-config)

Configure a list of span failure detection rules which are evaluated in order.

Dynatrace failure detection automatically detects the vast majority of error conditions in your environment. However, not all services follow the OpenTelemetry specification to heart, so there may be cases where the default span failure detection settings don't meet your particular needs. E.g. your library doesn't use the event 'exception' for exceptions, but another event such as 'fatal-error'. Or you use a custom 'internal.severity' span attribute to transport error information. In such cases, you can configure failure rules which are evaluated in order. As soon as a rule matches, subsequent rules will not be evaluated.

Note: This config applies to your whole tenant and to any span captured by Dynatrace.

Schema IDSchema groupsScope
builtin:span-failure-detection-config
  • group:service-detection
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-failure-detection-config
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:span-failure-detection-config
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-failure-detection-config

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

PropertyTypeDescriptionRequired
Enabled
enabled		boolean

If this is true, the rule will be evaluated.

required
Rule
rule		Rule-required
The Rule object
PropertyTypeDescriptionRequired
Rule name
ruleName		text-required
Rule verdict, the rule defines whether a span indicates a failure or success
spanVerdictIfRuleMatches		enum
  • SPAN_VERDICT_FAILURE
  • SPAN_VERDICT_SUCCESS
required
Conditions
conditions		Set<Condition>

Specify all conditions which should be evaluated for this rule. A rule is applied if all of the listed conditions match.

required
The Condition object
PropertyTypeDescriptionRequired
Source
source		enum
  • SPAN_NAME
  • SPAN_STATUS_CODE
  • SPAN_STATUS_MESSAGE
  • SPAN_KIND
  • SPAN_ATTRIBUTE
  • SPAN_EVENT
  • RESOURCE_ATTRIBUTE
  • INSTRUMENTATION_SCOPE_NAME
  • INSTRUMENTATION_SCOPE_VERSION
required
Event conditions
eventConditions		Set<EventCondition>

Specify event conditions which should be evaluated for this rule. A rule is applied if all of the specified conditions match.

required
Key
sourceKey		text-required
Data Type
dataType		enum
  • STRING
  • INTEGER
  • FLOAT
  • BOOLEAN
required
Comparison Type
stringComparisonType		enum
  • EQUALS
  • DOES_NOT_EQUAL
  • CONTAINS
  • DOES_NOT_CONTAIN
  • STARTS_WITH
  • DOES_NOT_START_WITH
  • ENDS_WITH
  • DOES_NOT_END_WITH
required
Comparison Type
attrKeyStringComparisonType		enum

Note: Exists/Does not exist ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key

  • EQUALS
  • DOES_NOT_EQUAL
  • CONTAINS
  • DOES_NOT_CONTAIN
  • STARTS_WITH
  • DOES_NOT_START_WITH
  • ENDS_WITH
  • DOES_NOT_END_WITH
  • EXISTS
  • DOES_NOT_EXIST
required
Comparison Type
numComparisonType		enum

Note: Exists/Does not exist ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key

  • EQUALS
  • DOES_NOT_EQUAL
  • GREATER_THAN
  • NOT_GREATER_THAN
  • LOWER_THAN
  • NOT_LOWER_THAN
  • GREATER_THAN_OR_EQUAL
  • NOT_GREATER_THAN_OR_EQUAL
  • LOWER_THAN_OR_EQUAL
  • NOT_LOWER_THAN_OR_EQUAL
  • EXISTS
  • DOES_NOT_EXIST
required
Selection Type
boolComparisonType		enum
  • ONE_OF
  • NOT_ANY_OF
required
Comparison Type
attrKeyBoolComparisonType		enum

Note: Exists/Does not exist ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key

  • EQUALS
  • DOES_NOT_EQUAL
  • EXISTS
  • DOES_NOT_EXIST
required
Value
boolValue		enum
  • TRUE
  • FALSE
required
Value
intValue		integer-required
Values
intValues		set

Any value from the list should match for the condition to be evaluated to true

required
Value
floatValue		float-required
Values
floatValues		set

Any value from the list should match for the condition to be evaluated to true

required
Values
strValues		set

Any value from the list should match for the condition to be evaluated to true

required
Span status code is set to
spanStatusCodeValue		Set<SpanStatusCode>

Enable one or more status codes to be checked.

  • ERROR
  • OK
  • UNSET
required
Values
spanKindValue		Set<SpanKind>

Enable one or more status kinds.

  • INTERNAL
  • SERVER
  • CLIENT
  • PRODUCER
  • CONSUMER
required
Case sensitive
caseSensitive		boolean

Affects value(s)

required
The EventCondition object
PropertyTypeDescriptionRequired
Source
source		enum
  • SPAN_EVENT_NAME
  • SPAN_EVENT_ATTRIBUTE
required
Key
sourceKey		text-required
Data Type
dataType		enum
  • STRING
  • INTEGER
  • FLOAT
  • BOOLEAN
required
Comparison Type
stringComparisonType		enum
  • EQUALS
  • DOES_NOT_EQUAL
  • CONTAINS
  • DOES_NOT_CONTAIN
  • STARTS_WITH
  • DOES_NOT_START_WITH
  • ENDS_WITH
  • DOES_NOT_END_WITH
required
Comparison Type
attrKeyStringComparisonType		enum

Note: Exists/Does not exist ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key

  • EQUALS
  • DOES_NOT_EQUAL
  • CONTAINS
  • DOES_NOT_CONTAIN
  • STARTS_WITH
  • DOES_NOT_START_WITH
  • ENDS_WITH
  • DOES_NOT_END_WITH
  • EXISTS
  • DOES_NOT_EXIST
required
Comparison Type
numComparisonType		enum

Note: Exists/Does not exist ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key

  • EQUALS
  • DOES_NOT_EQUAL
  • GREATER_THAN
  • NOT_GREATER_THAN
  • LOWER_THAN
  • NOT_LOWER_THAN
  • GREATER_THAN_OR_EQUAL
  • NOT_GREATER_THAN_OR_EQUAL
  • LOWER_THAN_OR_EQUAL
  • NOT_LOWER_THAN_OR_EQUAL
  • EXISTS
  • DOES_NOT_EXIST
required
Comparison Type
attrKeyBoolComparisonType		enum

Note: Exists/Does not exist ignores any type information i.e. the condition only checks for the existence/non-existence of the attribute key

  • EQUALS
  • DOES_NOT_EQUAL
  • EXISTS
  • DOES_NOT_EXIST
required
Value
boolValue		enum
  • TRUE
  • FALSE
required
Value
intValue		integer-required
Values
intValues		set

If regular comparison type i.e. Equals is used, then any of the listed values should match for the condition to be evaluated to true

If negated comparison type i.e. Does not equal is used, then none of the listed values should match for the condition to be evaluated to true

required
Value
floatValue		float-required
Values
floatValues		set

If regular comparison type i.e. Equals is used, then any of the listed values should match for the condition to be evaluated to true

If negated comparison type i.e. Does not equal is used, then none of the listed values should match for the condition to be evaluated to true

required
Values
strValues		set

If regular comparison type i.e. Equals is used, then any of the listed values should match for the condition to be evaluated to true

If negated comparison type i.e. Does not equal is used, then none of the listed values should match for the condition to be evaluated to true

required
Case sensitive
caseSensitive		boolean

Affects value(s)

required