• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • General failure detection parameters

Settings 2.0 - General failure detection parameters schema

General failure detection parameters (builtin:failure-detection.service.general-parameters)

Dynatrace failure detection automatically detects the vast majority of error conditions in your environment. However, detected service errors don't necessarily mean that the underlying requests have failed. There may be cases where the default service failure detection settings don't meet your particular needs. In such cases, you can configure the settings provided below. For complete details, see configure service failure detection.

Schema IDSchema groupsScope
builtin:failure-detection.service.general-parameters
  • group:failure-detection
SERVICE - Service
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.service.general-parameters
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:failure-detection.service.general-parameters
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.service.general-parameters

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
enabledOverride global failure detection settingsboolean-required
exceptionRulesCustomize failure detection for specific exceptions and errorsexceptionRules-required

Request body objects

The compareOperation object
PropertyLabelTypeDescriptionRequired
compareOperationTypeApply this comparisontext-required
textValueValuetext-required
caseSensitiveCase sensitiveboolean-required
intValueValueinteger-required
doubleValueValuefloat-required
The customErrorRule object
PropertyLabelTypeDescriptionRequired
requestAttributeRequest attributetext-required
conditionRequest attribute conditioncompareOperation-required
The exception object
PropertyLabelTypeDescriptionRequired
classPatternClass patterntext

The pattern will match if it is contained within the actual class name.

optional
messagePatternException message patterntext

Optionally, define an exception message pattern. The pattern will match if the actual exception message contains the pattern.

optional
The exceptionRules object
PropertyLabelTypeDescriptionRequired
ignoreAllExceptionsIgnore all exceptionsboolean-required
successForcingExceptionsSuccess forcing exceptionsset

Define exceptions which indicate that a service call should not be considered as failed. E.g. an exception indicating that the client aborted the operation.

If an exception matching any of the defined patterns occurs on the entry node of the service, it will be considered successful. Compared to ignored exceptions, the request will be considered successful even if other exceptions occur in the same request.

required
ignoredExceptionsIgnored Exceptionsset

Some exceptions that are thrown by legacy or 3rd-party code indicate a specific response, not an error. Use this setting to instruct Dynatrace to treat such exceptions as non-failed requests.

If an exception matching any of the defined patterns occurs in a request, it will not be considered as a failure. Other exceptions occurring at the same request might still mark the request as failed.

required
customHandledExceptionsCustom handled exceptionsset

There may be situations where your application code handles exceptions gracefully in a manner that these failures aren't detected by Dynatrace. Use this setting to define specific gracefully-handled exceptions that should be treated as service failures.

required
customErrorRulesCustom error rulesset

Some custom error situations are only detectable via a return value or other means. To support such cases, define a request attribute that captures the required data. Then define a custom error rule that determines if the request has failed based on the value of the request attribute.

required
ignoreSpanFailureDetectionIgnore span failure detectionboolean-required