Host anomaly detection API - GET configuration

Gets the configuration of anomaly detection for hosts.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/anomalyDetection/hosts
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/anomalyDetection/hosts

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

CodeTypeDescription
200HostsAnomalyDetectionConfig

Success

Response body objects

The HostsAnomalyDetectionConfig object

Configuration of anomaly detection for hosts.

ElementTypeDescription
connectionLostDetectionConnectionLostDetectionConfig

Configuration of lost connection detection.

diskLowInodesDetectionDiskLowInodesDetectionConfig

Configuration of low disk inodes number detection.

diskLowSpaceDetectionDiskLowSpaceDetectionConfig

Configuration of low disk space detection.

diskSlowWritesAndReadsDetectionDiskSlowWritesAndReadsDetectionConfig

Configuration of slow running disks detection.

highCpuSaturationDetectionHighCpuSaturationDetectionConfig

Configuration of high CPU saturation detection

highGcActivityDetectionHighGcActivityDetectionConfig

Configuration of high Garbage Collector activity detection.

highMemoryDetectionHighMemoryDetectionConfig

Configuration of high memory usage detection.

highNetworkDetectionHighNetworkDetectionConfig

Configuration of high network utilization detection.

metadataConfigurationMetadata

Metadata useful for debugging

networkDroppedPacketsDetectionNetworkDroppedPacketsDetectionConfig

Configuration of high number of dropped packets detection.

networkErrorsDetectionNetworkErrorsDetectionConfig

Configuration of high number of network errors detection.

networkHighRetransmissionDetectionNetworkHighRetransmissionDetectionConfig

Configuration of high retransmission rate detection.

networkTcpProblemsDetectionNetworkTcpProblemsDetectionConfig

Configuration of TCP connectivity problems detection.

outOfMemoryDetectionOutOfMemoryDetectionConfig

Configuration of Java out of memory problems detection.

outOfThreadsDetectionOutOfThreadsDetectionConfig

Configuration of Java out of threads problems detection.

The ConnectionLostDetectionConfig object

Configuration of lost connection detection.

ElementTypeDescription
enabledboolean

The detection is enabled (true) or disabled (false).

enabledOnGracefulShutdownsboolean

Alert (true) on graceful host shutdowns.

The DiskLowInodesDetectionConfig object

Configuration of low disk inodes number detection.

ElementTypeDescription
customThresholdsDiskLowInodesThresholds

Custom thresholds for low disk inodes number. If not set, automatic mode is used.

enabledboolean

The detection is enabled (true) or disabled (false).

The DiskLowInodesThresholds object

Custom thresholds for low disk inodes number. If not set, automatic mode is used.

ElementTypeDescription
freeInodesPercentageinteger

Alert if percentage of available inodes is lower than X% in 3 out of 5 samples.

The DiskLowSpaceDetectionConfig object

Configuration of low disk space detection.

ElementTypeDescription
customThresholdsDiskLowSpaceThresholds

Custom thresholds for low disk space. If not set, automatic mode is used.

enabledboolean

The detection is enabled (true) or disabled (false).

The DiskLowSpaceThresholds object

Custom thresholds for low disk space. If not set, automatic mode is used.

ElementTypeDescription
freeSpacePercentageinteger

Alert if free disk space is lower than X% in 3 out of 5 samples.

The DiskSlowWritesAndReadsDetectionConfig object

Configuration of slow running disks detection.

ElementTypeDescription
customThresholdsDiskSlowWriteAndReadsThresholds

Custom thresholds for slow running disks. If not set, the automatic mode is used.

enabledboolean

The detection is enabled (true) or disabled (false).

The DiskSlowWriteAndReadsThresholds object

Custom thresholds for slow running disks. If not set, the automatic mode is used.

ElementTypeDescription
writeAndReadTimeinteger

Alert if disk read/write time is higher than X milliseconds in 3 out of 5 samples.

The HighCpuSaturationDetectionConfig object

Configuration of high CPU saturation detection

ElementTypeDescription
customThresholdsHighCpuSaturationThresholds

Custom thresholds for high CPU saturation. If not set then the automatic mode is used.

enabledboolean

The detection is enabled (true) or disabled (false).

The HighCpuSaturationThresholds object

Custom thresholds for high CPU saturation. If not set then the automatic mode is used.

ElementTypeDescription
cpuSaturationinteger

Alert if CPU usage is higher than X% in 3 out of 5 samples.

The HighGcActivityDetectionConfig object

Configuration of high Garbage Collector activity detection.

ElementTypeDescription
customThresholdsHighGcActivityThresholds

Custom thresholds for high GC activity. If not set, automatic mode is used.

Meeting any of these conditions triggers an alert.

enabledboolean

The detection is enabled (true) or disabled (false).

The HighGcActivityThresholds object

Custom thresholds for high GC activity. If not set, automatic mode is used.

Meeting any of these conditions triggers an alert.

ElementTypeDescription
gcSuspensionPercentageinteger

GC suspension is higher than X% in 3 out of 5 samples.

gcTimePercentageinteger

GC time is higher than X% in 3 out of 5 samples.

The HighMemoryDetectionConfig object

Configuration of high memory usage detection.

ElementTypeDescription
customThresholdsHighMemoryThresholds

Custom thresholds for high memory usage. If not set then the automatic mode is used.

Both conditions must be met to trigger an alert.

enabledboolean

The detection is enabled (true) or disabled (false).

The HighMemoryThresholds object

Custom thresholds for high memory usage. If not set then the automatic mode is used.

Both conditions must be met to trigger an alert.

ElementTypeDescription
pageFaultsPerSecondNonWindowsinteger

Memory page fault rate is higher than X faults per second on Linux.

pageFaultsPerSecondWindowsinteger

Memory page fault rate is higher than X faults per second on Windows.

usedMemoryPercentageNonWindowsinteger

Memory usage is higher than X% on Linux.

usedMemoryPercentageWindowsinteger

Memory usage is higher than X% on Windows.

The HighNetworkDetectionConfig object

Configuration of high network utilization detection.

ElementTypeDescription
customThresholdsHighNetworkThresholds

Custom thresholds for high network utilization. If not set, automatic mode is used.

enabledboolean

The detection is enabled (true) or disabled (false).

The HighNetworkThresholds object

Custom thresholds for high network utilization. If not set, automatic mode is used.

ElementTypeDescription
utilizationPercentageinteger

Alert if sent/received traffic utilization is higher than X% in 3 out of 5 samples.

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
clusterVersionstring

Dynatrace version.

configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

The NetworkDroppedPacketsDetectionConfig object

Configuration of high number of dropped packets detection.

ElementTypeDescription
customThresholdsNetworkDroppedPacketsThresholds

Custom thresholds for dropped packets. If not set, automatic mode is used.

All of these conditions must be met to trigger an alert.

enabledboolean

The detection is enabled (true) or disabled (false).

The NetworkDroppedPacketsThresholds object

Custom thresholds for dropped packets. If not set, automatic mode is used.

All of these conditions must be met to trigger an alert.

ElementTypeDescription
droppedPacketsPercentageinteger

Receive/transmit dropped packet percentage is higher than X% in 3 out of 5 samples.

totalPacketsRateinteger

Total receive/transmit packets rate is higher than X packets per second in 3 out of 5 samples.

The NetworkErrorsDetectionConfig object

Configuration of high number of network errors detection.

ElementTypeDescription
customThresholdsNetworkErrorsThresholds

Custom thresholds for network errors. If not set, automatic mode is used.

All of these conditions must be met to trigger an alert.

enabledboolean

The detection is enabled (true) or disabled (false).

The NetworkErrorsThresholds object

Custom thresholds for network errors. If not set, automatic mode is used.

All of these conditions must be met to trigger an alert.

ElementTypeDescription
errorsPercentageinteger

Receive/transmit error packet percentage is higher than X% in 3 out of 5 samples.

totalPacketsRateinteger

Total receive/transmit packets rate is higher than X packets per second in 3 out of 5 samples.

The NetworkHighRetransmissionDetectionConfig object

Configuration of high retransmission rate detection.

ElementTypeDescription
customThresholdsNetworkHighRetransmissionThresholds

Custom thresholds for high retransmission rate. If not set, automatic mode is used.

All of these conditions must be met to trigger an alert.

enabledboolean

The detection is enabled (true) or disabled (false).

The NetworkHighRetransmissionThresholds object

Custom thresholds for high retransmission rate. If not set, automatic mode is used.

All of these conditions must be met to trigger an alert.

ElementTypeDescription
retransmissionRatePercentageinteger

Retransmission rate is higher than X% in 3 out of 5 samples.

retransmittedPacketsNumberPerMinuteinteger

Number of retransmitted packets is higher than X packets per minute in 3 out of 5 samples.

The NetworkTcpProblemsDetectionConfig object

Configuration of TCP connectivity problems detection.

ElementTypeDescription
customThresholdsNetworkTcpProblemsThresholds

Custom thresholds for TCP connection problems. If not set, automatic mode is used.

All of these conditions must be met to trigger an alert.

enabledboolean

The detection is enabled (true) or disabled (false).

The NetworkTcpProblemsThresholds object

Custom thresholds for TCP connection problems. If not set, automatic mode is used.

All of these conditions must be met to trigger an alert.

ElementTypeDescription
failedConnectionsNumberPerMinuteinteger

Number of failed connections is higher than X connections per minute in 3 out of 5 samples.

newConnectionFailuresPercentageinteger

Percentage of new connection failures is higher than X% in 3 out of 5 samples.

The OutOfMemoryDetectionConfig object

Configuration of Java out of memory problems detection.

ElementTypeDescription
customThresholdsOutOfMemoryThresholds

Custom thresholds for Java out of memory. If not set, automatic mode is used.

enabledboolean

The detection is enabled (true) or disabled (false).

The OutOfMemoryThresholds object

Custom thresholds for Java out of memory. If not set, automatic mode is used.

ElementTypeDescription
outOfMemoryExceptionsNumberinteger

Alert if the number of Java out of memory exceptions is X per minute or higher.

The OutOfThreadsDetectionConfig object

Configuration of Java out of threads problems detection.

ElementTypeDescription
customThresholdsOutOfThreadsThresholds

Custom thresholds for Java out of threads detection. If not set, automatic mode is used.

enabledboolean

The detection is enabled (true) or disabled (false).

The OutOfThreadsThresholds object

Custom thresholds for Java out of threads detection. If not set, automatic mode is used.

ElementTypeDescription
outOfThreadsExceptionsNumberinteger

Alert if the number of Java out of threads exceptions is X per minute or higher.

Response body JSON model

{
"connectionLostDetection": {
"enabled": true,
"enabledOnGracefulShutdowns": true
},
"diskLowInodesDetection": {
"customThresholds": {
"freeInodesPercentage": 10
},
"enabled": true
},
"diskLowSpaceDetection": {
"customThresholds": {
"freeSpacePercentage": 10
},
"enabled": true
},
"diskSlowWritesAndReadsDetection": {
"customThresholds": {
"writeAndReadTime": 300
},
"enabled": true
},
"highCpuSaturationDetection": {
"customThresholds": {
"cpuSaturation": 90
},
"enabled": true
},
"highGcActivityDetection": {
"customThresholds": {
"gcSuspensionPercentage": 20,
"gcTimePercentage": 35
},
"enabled": true
},
"highMemoryDetection": {
"customThresholds": {
"pageFaultsPerSecondNonWindows": 10,
"pageFaultsPerSecondWindows": 50,
"usedMemoryPercentageNonWindows": 85,
"usedMemoryPercentageWindows": 85
},
"enabled": true
},
"highNetworkDetection": {
"customThresholds": {
"utilizationPercentage": 88
},
"enabled": true
},
"metadata": {
"clusterVersion": "Mock version",
"configurationVersions": [
4,
2
]
},
"networkDroppedPacketsDetection": {
"customThresholds": {
"droppedPacketsPercentage": 8,
"totalPacketsRate": 8
},
"enabled": true
},
"networkErrorsDetection": {
"customThresholds": {
"errorsPercentage": 9,
"totalPacketsRate": 9
},
"enabled": true
},
"networkHighRetransmissionDetection": {
"customThresholds": {
"retransmissionRatePercentage": 15,
"retransmittedPacketsNumberPerMinute": 15
},
"enabled": true
},
"networkTcpProblemsDetection": {
"customThresholds": {
"failedConnectionsNumberPerMinute": 5,
"newConnectionFailuresPercentage": 5
},
"enabled": true
},
"outOfMemoryDetection": {
"customThresholds": {
"outOfMemoryExceptionsNumber": 2
},
"enabled": true
},
"outOfThreadsDetection": {
"customThresholds": {
"outOfThreadsExceptionsNumber": 2
},
"enabled": true
}
}

Example

In this example, the request lists the current configuration of anomaly detection for hosts.

The API token is passed in the Authorization header.

The configuration has the following settings:

Anomaly detection config - hosts

Curl

curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/hosts \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/anomalyDetection/hosts

Response body

{
"metadata": {
"clusterVersion": "1.163.5.20190201-130834",
"configurationVersions": [
91
]
},
"connectionLostDetection": {
"enabled": true,
"enabledOnGracefulShutdowns": false
},
"highCpuSaturationDetection": {
"enabled": true
},
"highMemoryDetection": {
"enabled": true
},
"highGcActivityDetection": {
"enabled": true
},
"outOfMemoryDetection": {
"enabled": true
},
"outOfThreadsDetection": {
"enabled": true
},
"networkDroppedPacketsDetection": {
"enabled": true
},
"networkErrorsDetection": {
"enabled": true
},
"highNetworkDetection": {
"enabled": true
},
"networkTcpProblemsDetection": {
"enabled": true
},
"networkHighRetransmissionDetection": {
"enabled": true
},
"diskLowSpaceDetection": {
"enabled": true
},
"diskSlowWritesAndReadsDetection": {
"enabled": true
},
"diskLowInodesDetection": {
"enabled": true
}
}

Response code

200