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 ID | Schema groups | Scope |
|---|---|---|
builtin:failure-detection.environment.parameters |
| environment |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| name | Name | text | - | required |
| description | Description | text | - | optional |
| httpResponseCodes | HTTP response codes | httpResponseCodes | - | required |
| brokenLinks | HTTP 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 |
| exceptionRules | Customize failure detection for specific exceptions and errors | exceptionRules | - | required |
Request body objects
The compareOperation object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| compareOperationType | Apply this comparison | text | - | required |
| textValue | Value | text | - | required |
| caseSensitive | Case sensitive | boolean | - | required |
| intValue | Value | integer | - | required |
| doubleValue | Value | float | - | required |
The customErrorRule object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| requestAttribute | Request attribute | text | - | required |
| condition | Request attribute condition | compareOperation | - | required |
The exception object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| classPattern | Class pattern | text | The pattern will match if it is contained within the actual class name. | optional |
| messagePattern | Exception message pattern | text | Optionally, define an exception message pattern. The pattern will match if the actual exception message contains the pattern. | optional |
The exceptionRules object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| ignoreAllExceptions | Ignore all exceptions | boolean | - | required |
| successForcingExceptions | Success forcing exceptions | set | 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 |
| ignoredExceptions | Ignored Exceptions | set | 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 |
| customHandledExceptions | Custom handled exceptions | set | 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 |
| customErrorRules | Custom error rules | set | 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 |
| ignoreSpanFailureDetection | Ignore span failure detection | boolean | - | required |
The brokenLinks object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| http404NotFoundFailures | Consider 404 HTTP response codes as failures | boolean | - | required |
| brokenLinkDomains | Rules for broken links to related domains | set | 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
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| serverSideErrors | HTTP response codes which indicate an error on the server side | text | - | required |
| failOnMissingResponseCodeServerSide | Treat missing HTTP response code as server side errors | boolean | - | required |
| clientSideErrors | HTTP response codes which indicate client side errors | text | - | required |
| failOnMissingResponseCodeClientSide | Treat missing HTTP response code as client side error | boolean | - | required |