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 IDSchema groupsScope
    builtin:failure-detection.service.general-parameters
    • group:failure-detection
    SERVICE - Service
    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

    PropertyTypeDescriptionRequired
    Override global failure detection settings
    enabled    		boolean-required
    Customize failure detection for specific exceptions and errors
    exceptionRules    		exceptionRules-required
    The exceptionRules object
    PropertyTypeDescriptionRequired
    Ignore all exceptions
    ignoreAllExceptions    		boolean-required
    Success forcing exceptions
    successForcingExceptions    		Set<exception>

    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
    Ignored exceptions
    ignoredExceptions    		Set<exception>

    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
    Custom handled exceptions
    customHandledExceptions    		Set<exception>

    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
    Custom error rules
    customErrorRules    		Set<customErrorRule>

    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
    Ignore span failure detection
    ignoreSpanFailureDetection    		boolean-required
    The exception object
    PropertyTypeDescriptionRequired
    Class pattern
    classPattern    		text

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

    		optional
    Exception message pattern
    messagePattern    		text

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

    		optional
    The customErrorRule object
    PropertyTypeDescriptionRequired
    Request attribute
    requestAttribute    		text-required
    Request attribute condition
    condition    		compareOperation-required
    The compareOperation object
    PropertyTypeDescriptionRequired
    Apply this comparison
    compareOperationType    		text-required
    Value
    textValue    		text-required
    Case sensitive
    caseSensitive    		boolean-required
    Value
    intValue    		integer-required
    Value
    doubleValue    		float-required