Settings API - General failure detection parameters schema table
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. Please note that these settings are not applicable to services of type 'Span service'. For complete details, see configure service failure detection.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:failure-detection.service.general-parameters |
| SERVICE - Service |
Parameters
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Override global failure detection settings | boolean | - | 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 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. | 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 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. | 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 |