Settings API - Failure detection schema table

  • Published Jun 30, 2025

Failure detection (builtin:failure-detection-rulesets)

Define rulesets to detect failures based on span attributes defined in the Semantic Dictionary and custom attributes. Rulesets are evaluated in order and the first matching one defines the failure detection result.

Schema IDSchema groupsScope
builtin:failure-detection-rulesets
  • group:service-detection
CLOUD_APPLICATION_NAMESPACE - Kubernetes namespace
KUBERNETES_CLUSTER - Kubernetes cluster
HOST_GROUP - Host Group
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection-rulesets
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:failure-detection-rulesets
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection-rulesets

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 enabled, the ruleset will be evaluated.

required
Ruleset
ruleset		Ruleset-required
The Ruleset object
PropertyTypeDescriptionRequired
Ruleset name
rulesetName		text-required
Description
description		text-optional
Matching condition
condition		text

Limits the scope of the failure detection ruleset using DQL matcher conditions on span and resource attributes.

A ruleset is applied only if the condition matches, otherwise the evaluation continues.

If empty, the condition will always match.

optional
HTTP status codes
failOnHttpResponseStatusCodes		failOnHttpResponseStatusCodes

Evaluated attribute: http.response.status_code

Failure detection result: reason="http_code", verdict="failure"

required
gRPC status codes
failOnGrpcStatusCodes		failOnGrpcStatusCodes

Evaluated attribute: rpc.grpc.status_code

Failure detection result: reason="grpc_code", verdict="failure"

required
Span status code
failOnSpanStatusError		failOnSpanStatusError

Evaluated attribute: span.status_code

Failure detection result: reason="span_status", verdict="failure"

required
Exceptions
failOnExceptions		failOnExceptions

Evaluated expression: iAny(span.events[][span_event.name] == "exception" and span.events[][exception.escaped] != false)

Failure detection result: reason="exception", verdict="failure", exception_ids

required
Custom failure rules
failOnCustomRules		Set<customRule>

Define failure reasons based on span and request attributes.

Failure detection result: reason="custom_rule", verdict="failure", custom_rule_name

required
overridesoverrides-required
The failOnHttpResponseStatusCodes object
PropertyTypeDescriptionRequired
Status codes which indicate a failure on the server side
statusCodes		text-required
The failOnGrpcStatusCodes object
PropertyTypeDescriptionRequired
Status codes which indicate a failure on the server side
statusCodes		text-required
The failOnSpanStatusError object
PropertyTypeDescriptionRequired
Fail on span status "error"
enabled		boolean-required
The failOnExceptions object
PropertyTypeDescriptionRequired
Fail on exceptions
enabled		boolean-required
ignoredExceptionsSet<singleException>-required
The customRule object
PropertyTypeDescriptionRequired
Enabled
enabled		boolean-required
Rule name
ruleName		text-required
DQL condition
dqlCondition		text

Custom rule based on span attributes using DQL matcher.

required
The overrides object
PropertyTypeDescriptionRequired
HTTP status codes
forceSuccessOnHttpResponseStatusCodes		forceSuccessOnHttpResponseStatusCodes

Evaluated attribute: http.response.status_code

Failure detection result: reason="http_code", verdict="success"

required
gRPC status codes
forceSuccessOnGrpcResponseStatusCodes		forceSuccessOnGrpcResponseStatusCodes

Evaluated attribute: rpc.grpc.status_code

Failure detection result: reason="grpc_code", verdict="success"

required
Span status code
forceSuccessOnSpanStatusOk		forceSuccessOnSpanStatusOk

Evaluated attribute: span.status_code

Failure detection result: reason="span_status", verdict="success"

required
Force success on specific exceptions
forceSuccessOnExceptions		Set<singleException>

Define escaped exceptions that should force success.

Evaluated expression: iAny(span.events[][span_event.name] == "exception" and span.events[][exception.escaped] != false)

Failure detection result: reason="exception", verdict="success", exception_ids

required
Custom success forcing rules
forceSuccessWithCustomRules		Set<customRule>

Override failures based on span and request attribute conditions.

Failure detection result: reason="custom_rule", verdict="success", custom_rule_name

required
The singleException object
PropertyTypeDescriptionRequired
Enabled
enabled		boolean-required
Exception type contains
type		text

Evaluated attribute: span.events[][exception.type]

optional
Exception message contains
message		text

Evaluated attribute: span.events[][exception.message]

optional
The forceSuccessOnHttpResponseStatusCodes object
PropertyTypeDescriptionRequired
Status codes which force success on the server side
statusCodes		text-optional
The forceSuccessOnGrpcResponseStatusCodes object
PropertyTypeDescriptionRequired
Status codes which force success on the server side
statusCodes		text-optional
The forceSuccessOnSpanStatusOk object
PropertyTypeDescriptionRequired
Force success on span status "ok"
enabled		boolean-required