• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Anomaly detection for applications

Settings API - Anomaly detection for applications schema table

Anomaly detection for applications (builtin:anomaly-detection.rum-web)

Dynatrace automatically detects application-related performance anomalies such as response time degradations, failure rate increases, and traffic spikes. Use these settings to configure detection sensitivity, set alert thresholds, or disable alerting for certain applications.

To avoid false-positive problem notifications, automated anomaly detection is only available for applications and services that have run for at least 20% of a week (7 days).

Schema IDSchema groupsScope
builtin:anomaly-detection.rum-web
  • group:anomaly-detection
APPLICATION_METHOD - User Action
APPLICATION - Web application
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.rum-web
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:anomaly-detection.rum-web
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.rum-web

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

PropertyLabelTypeDescriptionRequired
responseTimeResponse timeresponseTime-required
errorRateError rateerrorRate-required
trafficDropsDetect traffic dropsappTrafficDrops-required
trafficSpikesDetect traffic spikesappTrafficSpikes-required

Request body objects

The responseTimeAutoAll object
PropertyLabelTypeDescriptionRequired
degradationMillisecondsAbsolute thresholdfloat-required
degradationPercentRelative thresholdfloat-required
The responseTimeAutoSlowest object
PropertyLabelTypeDescriptionRequired
slowestDegradationMillisecondsAbsolute thresholdfloat-required
slowestDegradationPercentRelative thresholdfloat-required
The overAlertingProtectionAuto object
PropertyLabelTypeDescriptionRequired
actionsPerMinuteMinimum number of actions per minutefloat

Only alert if there are at least

required
minutesAbnormalStateOnly alert if the abnormal state remains for at leastfloat-required
The responseTimeAuto object
PropertyLabelTypeDescriptionRequired
responseTimeAllAll user actionsresponseTimeAutoAll

Alert if the median response time of all user actions degrades beyond both the absolute and relative thresholds:

required
responseTimeSlowestSlowest 10%responseTimeAutoSlowest

Alert if the response time of the slowest 10% of requests degrades beyond both the absolute and relative thresholds:

required
overAlertingProtectionAvoid over-alertingoverAlertingProtectionAuto-required
The responseTimeFixedAll object
PropertyLabelTypeDescriptionRequired
degradationMillisecondsAlert if the key performance metric degrades beyond this many ms within an observation period of 5 minutesfloat-required
The responseTimeFixedSlowest object
PropertyLabelTypeDescriptionRequired
slowestDegradationMillisecondsAlert if the key performance metric of the slowest 10% degrades beyond this many ms within an observation period of 5 minutesfloat-required
The responseTimeFixed object
PropertyLabelTypeDescriptionRequired
responseTimeAllAll user actionsresponseTimeFixedAll

Alert if the key performance metric of all requests degrades beyond this threshold:

required
responseTimeSlowestSlowest 10%responseTimeFixedSlowest

Alert if the key performance metric of the slowest 10% of requests degrades beyond this threshold:

required
overAlertingProtectionAvoid over-alertingoverAlertingProtectionAuto-required
sensitivitySensitivityenum-required
The responseTime object
PropertyLabelTypeDescriptionRequired
enabledDetect key performance metric degradationsboolean-required
detectionModeDetection strategy for key performance metric degradationsenum-required
responseTimeAuto-responseTimeAuto-required
responseTimeFixed-responseTimeFixed-required
The trafficSpikes object
PropertyLabelTypeDescriptionRequired
trafficSpikePercentageAlert if the observed traffic is more than this percentage of the expected valuefloat-required
minutesAbnormalStateMinutes an application has to stay in abnormal state before alertfloat-required
The trafficDrops object
PropertyLabelTypeDescriptionRequired
trafficDropPercentageAlert if the observed traffic is less than this percentage of the expected valuefloat-required
abnormalStateAbnormalStateMinutes the observed traffic has to stay in abnormal state before alertfloat-required
The errorRateAuto object
PropertyLabelTypeDescriptionRequired
absoluteIncreaseAbsolute thresholdfloat-required
relativeIncreaseRelative thresholdfloat-required
overAlertingProtectionAvoid over-alertingoverAlertingProtectionAuto-required
The errorRateFixed object
PropertyLabelTypeDescriptionRequired
maxFailureRateIncreaseAlert if this custom error rate threshold is exceeded during any 5-minute-periodfloat-required
errorRateReqPerMinMinimum number of actions per minutefloat

To avoid over-alerting for low traffic applications

required
errorRateSensitivitySensitivityenum-required
minutesAbnormalStateAmount of minutes the observed traffic has to stay in abnormal state before alertfloat-required
The appTrafficDrops object
PropertyLabelTypeDescriptionRequired
enabledDetect traffic dropsboolean-required
trafficDrops-trafficDrops

Dynatrace learns your typical application traffic over an observation period of one week.

Depending on this expected value Dynatrace detects abnormal traffic drops within your application.

required
The appTrafficSpikes object
PropertyLabelTypeDescriptionRequired
enabledDetect traffic spikesboolean-required
trafficSpikes-trafficSpikes

Dynatrace learns your typical application traffic over an observation period of one week.

Depending on this expected value Dynatrace detects abnormal traffic spikes within your application.

required
The errorRate object
PropertyLabelTypeDescriptionRequired
enabledDetect increases in JavaScript errorsboolean-required
errorRateDetectionModeDetection strategy for increases in JavaScript errorsenum-required
errorRateAuto-errorRateAuto

Alert if the percentage of failing user actions increases by both the absolute and relative thresholds:

required
errorRateFixed-errorRateFixed-required