Application anomaly detection API - GET configuration
Gets the configuration of anomaly detection for applications.
The request produces an application/json payload.
| GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/applications |
| Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/anomalyDetection/applications |
Authentication
To execute this request, you need an access token with ReadConfig scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
The request doesn't provide any configurable parameters.
Response
Response codes
Response body objects
The ApplicationAnomalyDetectionConfig object
The configuration of anomaly detection for applications.
Configuration of failure rate increase detection.
Configuration of response time degradation detection.
The FailureRateIncreaseDetectionConfig object
Configuration of failure rate increase detection.
Parameters of failure rate increase auto-detection. Required if detectionMode is DETECT_AUTOMATICALLY. Not applicable otherwise.
The absolute and relative thresholds both must exceed to trigger an alert.
Example: If the expected error rate is 1.5%, and you set an absolute increase of 1%, and a relative increase of 50%, the thresholds will be: Absolute: 1.5% + 1% = 2.5% Relative: 1.5% + 1.5% * 50% = 2.25%
How to detect failure rate increase: automatically, or based on fixed thresholds, or do not detect.
DETECT_AUTOMATICALLYDETECT_USING_FIXED_THRESHOLDSDONT_DETECT
Fixed thresholds for failure rate increase detection.
Required if detectionMode is DETECT_USING_FIXED_THRESHOLDS. Not applicable otherwise.
The FailureRateIncreaseAutodetectionConfig object
Parameters of failure rate increase auto-detection. Required if detectionMode is DETECT_AUTOMATICALLY. Not applicable otherwise.
The absolute and relative thresholds both must exceed to trigger an alert.
Example: If the expected error rate is 1.5%, and you set an absolute increase of 1%, and a relative increase of 50%, the thresholds will be: Absolute: 1.5% + 1% = 2.5% Relative: 1.5% + 1.5% * 50% = 2.25%
Absolute increase of failing service calls to trigger an alert, %.
Relative increase of failing service calls to trigger an alert, %.
The FailureRateIncreaseThresholdConfig object
Fixed thresholds for failure rate increase detection.
Required if detectionMode is DETECT_USING_FIXED_THRESHOLDS. Not applicable otherwise.
Sensitivity of the threshold.
With low sensitivity, high statistical confidence is used. Brief violations (for example, due to a surge in load) won't trigger alerts.
With high sensitivity, no statistical confidence is used. Each violation triggers alert.
HIGHLOWMEDIUM
Failure rate during any 5-minute period to trigger an alert, %.
The ConfigurationMetadata object
Metadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
The ResponseTimeDegradationDetectionConfig object
Configuration of response time degradation detection.
Parameters of the response time degradation auto-detection. Required if the detectionMode is DETECT_AUTOMATICALLY. Not applicable otherwise.
Violation of any criterion triggers an alert.
How to detect response time degradation: automatically, or based on fixed thresholds, or do not detect.
DETECT_AUTOMATICALLYDETECT_USING_FIXED_THRESHOLDSDONT_DETECT
Fixed thresholds for response time degradation detection.
Required if detectionMode is DETECT_USING_FIXED_THRESHOLDS. Not applicable otherwise.
The ResponseTimeDegradationAutodetectionConfig object
Parameters of the response time degradation auto-detection. Required if the detectionMode is DETECT_AUTOMATICALLY. Not applicable otherwise.
Violation of any criterion triggers an alert.
Minimal service load to detect response time degradation.
Response time degradation of services with smaller load won't trigger alerts.
FIFTEEN_REQUESTS_PER_MINUTEFIVE_REQUESTS_PER_MINUTEONE_REQUEST_PER_MINUTETEN_REQUESTS_PER_MINUTE
Alert if the response time degrades beyond X milliseconds.
Alert if the response time degrades beyond X %.
Alert if the response time of the slowest 10% degrades beyond X milliseconds.
Alert if the response time of the slowest 10% degrades beyond X %.
The ResponseTimeDegradationThresholdConfig object
Fixed thresholds for response time degradation detection.
Required if detectionMode is DETECT_USING_FIXED_THRESHOLDS. Not applicable otherwise.
Minimal service load to detect response time degradation.
Response time degradation of services with smaller load won't trigger alerts.
FIFTEEN_REQUESTS_PER_MINUTEFIVE_REQUESTS_PER_MINUTEONE_REQUEST_PER_MINUTETEN_REQUESTS_PER_MINUTE
Response time during any 5-minute period to trigger an alert, in milliseconds.
Sensitivity of the threshold.
With low sensitivity, high statistical confidence is used. Brief violations (for example, due to a surge in load) won't trigger alerts.
With high sensitivity, no statistical confidence is used. Each violation triggers an alert.
HIGHLOWMEDIUM
Response time of the 10% slowest during any 5-minute period to trigger an alert, in milliseconds.
The TrafficDropDetectionConfig object
The configuration of traffic drops detection.
The detection is enabled (true) or disabled (false).
Alert if the observed traffic is less than X % of the expected value.
The TrafficSpikeDetectionConfig object
The configuration of traffic spikes detection.
The detection is enabled (true) or disabled (false).
Alert if the observed traffic is more than X % of the expected value.
Response body JSON model
{"failureRateIncrease": {"detectionMode": "DETECT_USING_FIXED_THRESHOLDS","thresholds": {"sensitivity": "LOW","threshold": 10}},"responseTimeDegradation": {"automaticDetection": {"loadThreshold": "ONE_REQUEST_PER_MINUTE","responseTimeDegradationMilliseconds": 250,"responseTimeDegradationPercent": 90,"slowestResponseTimeDegradationMilliseconds": 500,"slowestResponseTimeDegradationPercent": 200},"detectionMode": "DETECT_AUTOMATICALLY"},"trafficDrop": {"enabled": true,"trafficDropPercent": 95},"trafficSpike": {"enabled": false}}
Example
In this example, the request lists the current configuration of anomaly detection for applications.
The API token is passed in the Authorization header.
The configuration has the following settings:
Curl
curl -X GET \https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/applications \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/applications
Response body
{"metadata": {"clusterVersion": "1.163.0.20190130-210004","configurationVersions": [2]},"responseTimeDegradation": {"detectionMode": "DETECT_AUTOMATICALLY","automaticDetection": {"responseTimeDegradationMilliseconds": 100,"responseTimeDegradationPercent": 50,"slowestResponseTimeDegradationMilliseconds": 1000,"slowestResponseTimeDegradationPercent": 10,"loadThreshold": "TEN_REQUESTS_PER_MINUTE"}},"trafficDrop": {"enabled": true,"trafficDropPercent": 50},"trafficSpike": {"enabled": false},"failureRateIncrease": {"detectionMode": "DETECT_AUTOMATICALLY","automaticDetection": {"failingServiceCallPercentageIncreaseAbsolute": 5,"failingServiceCallPercentageIncreaseRelative": 50}}}
Response code
200