Settings 2.0 - Span failure detection configuration schema

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 ID	Schema groups	Scope
`builtin:span-failure-detection-config`	`group:service-detection`	`environment`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:span-failure-detection-config`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:span-failure-detection-config`
	Environment ActiveGate	`https://{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

Property	Label	Type	Description	Required
enabled	Enabled	boolean	If this is true, the rule will be evaluated.	required
rule	Rule	Rule	-	required

Request body objects

The `EventCondition` object

Property	Label	Type	Description	Required
source	Source	enum	-	required
sourceKey	Key	text	-	required
dataType	Data Type	enum	-	required
stringComparisonType	Comparison Type	enum	-	required
attrKeyStringComparisonType	Comparison Type	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	required
numComparisonType	Comparison Type	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	required
attrKeyBoolComparisonType	Comparison Type	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	required
boolValue	Value	enum	-	required
intValue	Value	integer	-	required
intValues	Values	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
floatValue	Value	float	-	required
floatValues	Values	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
strValues	Values	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
caseSensitive	Case sensitive	boolean	Affects value(s)	required

The `Condition` object

Property	Label	Type	Description	Required
source	Source	enum	-	required
eventConditions	Event conditions	set	Specify event conditions which should be evaluated for this rule. A rule is applied if all of the specified conditions match.	required
sourceKey	Key	text	-	required
dataType	Data Type	enum	-	required
stringComparisonType	Comparison Type	enum	-	required
attrKeyStringComparisonType	Comparison Type	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	required
numComparisonType	Comparison Type	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	required
boolComparisonType	Selection Type	enum	-	required
attrKeyBoolComparisonType	Comparison Type	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	required
boolValue	Value	enum	-	required
intValue	Value	integer	-	required
intValues	Values	set	Any value from the list should match for the condition to be evaluated to true	required
floatValue	Value	float	-	required
floatValues	Values	set	Any value from the list should match for the condition to be evaluated to true	required
strValues	Values	set	Any value from the list should match for the condition to be evaluated to true	required
spanStatusCodeValue	Span status code is set to	set	Enable one or more status codes to be checked.	required
spanKindValue	Values	set	Enable one or more status kinds.	required
caseSensitive	Case sensitive	boolean	Affects value(s)	required

The `Rule` object

Property	Label	Type	Description	Required
ruleName	Rule name	text	-	required
spanVerdictIfRuleMatches	Rule verdict, the rule defines whether a span indicates a failure or success	enum	-	required
conditions	Conditions	set	Specify all conditions which should be evaluated for this rule. A rule is applied if all of the listed conditions match.	required

Settings 2.0 - Span failure detection configuration schema

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