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 (<your-dynatrace-url>//ui/settings/builtin:failure-detection.environment.rules) to configure which services these parameters apply to.
These settings are not applied to Unified services.
builtin:failure-detection.environment.parametersgroup:service-monitoringgroup:failure-detection
environment| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:failure-detection.environment.parameters |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:failure-detection.environment.parameters | |
| Environment ActiveGate | https://{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
namedescriptionbrokenLinksHTTP 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.
The httpResponseCodes object
serverSideErrorsfailOnMissingResponseCodeServerSideclientSideErrorsfailOnMissingResponseCodeClientSideThe brokenLinks object
http404NotFoundFailuresbrokenLinkDomainsIf 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.
The exceptionRules object
ignoreAllExceptionssuccessForcingExceptionsDefine exceptions which indicate that an entire 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.
ignoredExceptionsSome 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 on the entry node of the service, it will not be considered as a failure. Other exceptions occurring at the same request might still mark the request as failed.
customHandledExceptionsThere 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.
customErrorRulesSome 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.
ignoreSpanFailureDetectionThe exception object
classPatternThe pattern will match if it is contained within the actual class name.
messagePatternOptionally, define an exception message pattern. The pattern will match if the actual exception message contains the pattern.
The customErrorRule object
requestAttributeThe compareOperation object
compareOperationTypetextValuecaseSensitiveintValuedoubleValue