Database anomaly detection API - PUT configuration
Updates the configuration of anomaly detection for database services.
The request consumes an application/json
payload.
PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/databaseServices |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/anomalyDetection/databaseServices |
Authentication
To execute this request, you need an access token with WriteConfig
scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | Database | The JSON body of the request. Contains parameters of the database service anomaly detection configuration. | body | optional |
Request body objects
The DatabaseAnomalyDetectionConfig
object
The configuration of the anomaly detection for database services.
Element | Type | Description | Required |
---|---|---|---|
databaseConnectionFailureCount | Database | Parameters of the failed database connections detection. The alert is triggered when failed connections number exceeds connectionFailsCount during any timePeriodMinutes minutes period. | required |
failureRateIncrease | Failure | Configuration of failure rate increase detection. | required |
loadDrop | Load | The configuration of load drops detection. | optional |
loadSpike | Load | The configuration of load spikes detection. | optional |
metadata | Configuration | Metadata useful for debugging | optional |
responseTimeDegradation | Response | Configuration of response time degradation detection. | required |
The DatabaseConnectionFailureDetectionConfig
object
Parameters of the failed database connections detection.
The alert is triggered when failed connections number exceeds connectionFailsCount during any timePeriodMinutes minutes period.
Element | Type | Description | Required |
---|---|---|---|
connectionFailsCount | integer | Number of failed database connections during any timePeriodMinutes minutes period to trigger an alert. | optional |
enabled | boolean | The detection is enabled ( | required |
timePeriodMinutes | integer | The X minutes time period during which the connectionFailsCount is evaluated. | optional |
The FailureRateIncreaseDetectionConfig
object
Configuration of failure rate increase detection.
Element | Type | Description | Required |
---|---|---|---|
automaticDetection | Failure | Parameters of failure rate increase auto-detection. Required if detectionMode is 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% | optional |
detectionMode | string | How to detect failure rate increase: automatically, or based on fixed thresholds, or do not detect.
| required |
thresholds | Failure | Fixed thresholds for failure rate increase detection. Required if detectionMode is | optional |
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%
Element | Type | Description | Required |
---|---|---|---|
failingServiceCallPercentageIncreaseAbsolute | integer | Absolute increase of failing service calls to trigger an alert, %. | required |
failingServiceCallPercentageIncreaseRelative | integer | Relative increase of failing service calls to trigger an alert, %. | required |
The FailureRateIncreaseThresholdConfig
object
Fixed thresholds for failure rate increase detection.
Required if detectionMode is DETECT_USING_FIXED_THRESHOLDS
. Not applicable otherwise.
Element | Type | Description | Required |
---|---|---|---|
sensitivity | string | Sensitivity of the threshold. With With
| required |
threshold | integer | Failure rate during any 5-minute period to trigger an alert, %. | required |
The LoadDropDetectionConfig
object
The configuration of load drops detection.
Element | Type | Description | Required |
---|---|---|---|
enabled | boolean | The detection is enabled ( | required |
loadDropPercent | integer | Alert if the observed load is less than X % of the expected value. | optional |
minAbnormalStateDurationInMinutes | integer | Alert if the service stays in abnormal state for at least X minutes. | optional |
The LoadSpikeDetectionConfig
object
The configuration of load spikes detection.
Element | Type | Description | Required |
---|---|---|---|
enabled | boolean | The detection is enabled ( | required |
loadSpikePercent | integer | Alert if the observed load is more than X % of the expected value. | optional |
minAbnormalStateDurationInMinutes | integer | Alert if the service stays in abnormal state for at least X minutes. | optional |
The ConfigurationMetadata
object
Metadata useful for debugging
Element | Type | Description | Required |
---|---|---|---|
clusterVersion | string | Dynatrace version. | optional |
configurationVersions | integer[] | A sorted list of the version numbers of the configuration. | optional |
currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. | optional |
The ResponseTimeDegradationDetectionConfig
object
Configuration of response time degradation detection.
Element | Type | Description | Required |
---|---|---|---|
automaticDetection | Response | Parameters of the response time degradation auto-detection. Required if the detectionMode is Violation of any criterion triggers an alert. | optional |
detectionMode | string | How to detect response time degradation: automatically, or based on fixed thresholds, or do not detect.
| required |
thresholds | Response | Fixed thresholds for response time degradation detection. Required if detectionMode is | optional |
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.
Element | Type | Description | Required |
---|---|---|---|
loadThreshold | string | Minimal service load to detect response time degradation. Response time degradation of services with smaller load won't trigger alerts.
| required |
responseTimeDegradationMilliseconds | integer | Alert if the response time degrades beyond X milliseconds. | required |
responseTimeDegradationPercent | integer | Alert if the response time degrades beyond X %. | required |
slowestResponseTimeDegradationMilliseconds | integer | Alert if the response time of the slowest 10% degrades beyond X milliseconds. | required |
slowestResponseTimeDegradationPercent | integer | Alert if the response time of the slowest 10% degrades beyond X %. | required |
The ResponseTimeDegradationThresholdConfig
object
Fixed thresholds for response time degradation detection.
Required if detectionMode is DETECT_USING_FIXED_THRESHOLDS
. Not applicable otherwise.
Element | Type | Description | Required |
---|---|---|---|
loadThreshold | string | Minimal service load to detect response time degradation. Response time degradation of services with smaller load won't trigger alerts.
| required |
responseTimeThresholdMilliseconds | integer | Response time during any 5-minute period to trigger an alert, in milliseconds. | required |
sensitivity | string | Sensitivity of the threshold. With With
| required |
slowestResponseTimeThresholdMilliseconds | integer | Response time of the 10% slowest during any 5-minute period to trigger an alert, in milliseconds. | required |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"databaseConnectionFailureCount": {"connectionFailsCount": 5,"enabled": "true","timePeriodMinutes": 5},"failureRateIncrease": {"detectionMode": "DETECT_USING_FIXED_THRESHOLDS","thresholds": {"sensitivity": "LOW","threshold": 10}},"loadDrop": {"enabled": true,"loadDropPercent": 40,"minAbnormalStateDurationInMinutes": 5},"loadSpike": {"enabled": false},"responseTimeDegradation": {"automaticDetection": {"loadThreshold": "ONE_REQUEST_PER_MINUTE","responseTimeDegradationMilliseconds": 250,"responseTimeDegradationPercent": 90,"slowestResponseTimeDegradationMilliseconds": 500,"slowestResponseTimeDegradationPercent": 200},"detectionMode": "DETECT_AUTOMATICALLY"}}
Response
Response codes
Code | Type | Description |
---|---|---|
204 | - | Success. Configuration has been updated. Response doesn't have a body. |
400 | Error | Failed. The input is invalid |
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json
payload.
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/databaseServices/validator |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/anomalyDetection/databaseServices/validator |
Authentication
To execute this request, you need an access token with WriteConfig
scope.
To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
Code | Type | Description |
---|---|---|
204 | - | Validated. The submitted configuration is valid. Response doesn't have a body. |
400 | Error | Failed. The input is invalid |
Example
In this example, the request updates the configuration of anomaly detection for database services from the GET request example. It activates response time degradation detection in automatic mode and sets the following thresholds:
- Alert if the response time degrades by more than 5 ms and by 50%.
- Alert if the response time of the slowest 10% degrades by more than 20 ms and by 100%.
- To avoid over-alerting, do not alert for low-load services with fewer than 10 requests per minute.
The API token is passed in the Authorization header.
You can download or copy the example request body to try it out on your own. Be sure to create a backup copy of your current configuration with the GET database anomaly detection configuration call.
Curl
curl -X PUT \https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/databaseServices \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \-H 'Content-Type: application/json' \-d '{"responseTimeDegradation": {"detectionMode": "DETECT_AUTOMATICALLY","automaticDetection": {"responseTimeDegradationMilliseconds": 5,"responseTimeDegradationPercent": 50,"slowestResponseTimeDegradationMilliseconds": 5,"slowestResponseTimeDegradationPercent": 100,"loadThreshold": "TEN_REQUESTS_PER_MINUTE"}},"failureRateIncrease": {"detectionMode": "DETECT_USING_FIXED_THRESHOLDS","thresholds": {"threshold": 0,"sensitivity": "LOW"}},"databaseConnectionFailureCount": {"enabled": true,"connectionFailsCount": 5,"timePeriodMinutes": 5}}'
Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/databaseServices
Request body
{"responseTimeDegradation": {"detectionMode": "DETECT_AUTOMATICALLY","automaticDetection": {"responseTimeDegradationMilliseconds": 5,"responseTimeDegradationPercent": 50,"slowestResponseTimeDegradationMilliseconds": 5,"slowestResponseTimeDegradationPercent": 100,"loadThreshold": "TEN_REQUESTS_PER_MINUTE"}},"failureRateIncrease": {"detectionMode": "DETECT_USING_FIXED_THRESHOLDS","thresholds": {"threshold": 0,"sensitivity": "LOW"}},"databaseConnectionFailureCount": {"enabled": true,"connectionFailsCount": 5,"timePeriodMinutes": 5}}
Response code
204
Result
The updated configuration has the following parameters: