• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Failure detection parameters

Settings API - Failure detection parameters schema table

Failure detection parameters (builtin:failure-detection.environment.parameters)

Failure detection parameters that determine whether a service call is considered successful or failed. Use failure detection rules to configure which services these parameters apply to.

Schema IDSchema groupsScope
builtin:failure-detection.environment.parameters
  • group:service-monitoring
  • group:failure-detection
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.environment.parameters
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:failure-detection.environment.parameters
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.environment.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
nameNametext-required
descriptionDescriptiontext-optional
httpResponseCodesHTTP response codeshttpResponseCodes-required
brokenLinksHTTP 404 (broken links)brokenLinks

HTTP 404 response codes are thrown when a web server can't find a certain page. 404s are classified as broken links on the client side and therefore aren't considered to be service failures. By enabling this setting, you can have 404s treated as server-side service failures.

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
The brokenLinks object
PropertyLabelTypeDescriptionRequired
http404NotFoundFailuresConsider 404 HTTP response codes as failuresboolean-required
brokenLinkDomainsRules for broken links to related domainsset

If your application relies on other hosts at other domains, add the associated domain names here. Once configured, Dynatrace will consider 404s thrown by hosts at these domains to be service failures related to your application.

required
The httpResponseCodes object
PropertyLabelTypeDescriptionRequired
serverSideErrorsHTTP response codes which indicate an error on the server sidetext-required
failOnMissingResponseCodeServerSideTreat missing HTTP response code as server side errorsboolean-required
clientSideErrorsHTTP response codes which indicate client side errorstext-required
failOnMissingResponseCodeClientSideTreat missing HTTP response code as client side errorboolean-required