Host anomaly detection API - GET configuration

Gets the configuration of anomaly detection for hosts.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/hosts
  • SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/anomalyDetection/hosts

Parameters

The request doesn't provide any configurable parameters.

Response format

The HostsAnomalyDetectionConfig object

Configuration of anomaly detection for hosts.

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.
connectionLostDetection ConnectionLostDetectionConfig

How to detect lost connection.
highCpuSaturationDetection HighCpuSaturationDetectionConfig

How to detect high CPU saturation.
highMemoryDetection HighMemoryDetectionConfig

How to detect high memory usage.
highGcActivityDetection HighGcActivityDetectionConfig

How to detect high Garbage Collector activity.
outOfMemoryDetection OutOfMemoryDetectionConfig

How to detect Java out of memory problems.
outOfThreadsDetection OutOfThreadsDetectionConfig

How to detect Java out of threads problems.
networkDroppedPacketsDetection NetworkDroppedPacketsDetectionConfig

How to detect high number of dropped packets.
networkErrorsDetection NetworkErrorsDetectionConfig

How to detect high number of network errors.
highNetworkDetection HighNetworkDetectionConfig

How to detect high network utilization.
networkTcpProblemsDetection NetworkTcpProblemsDetectionConfig

How to detect TCP connectivity problems.
networkHighRetransmissionDetection NetworkHighRetransmissionDetectionConfig

How to detect high retransmission rate.
diskLowSpaceDetection DiskLowSpaceDetectionConfig

How to detect low disk space.
diskSlowWritesAndReadsDetection DiskSlowWritesAndReadsDetectionConfig

How to detect slow running disks.
diskLowInodesDetection DiskLowInodesDetectionConfig

How to detect low disk inodes number.

The DiskLowInodesDetectionConfig object

Configuration of low disk inodes number detection.

Element Type Description
enabled boolean

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

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

The DiskLowInodesThresholds object

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

Element Type Description
freeInodesPercentage integer

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

The DiskSlowWritesAndReadsDetectionConfig object

Configuration of slow running disks detection.

Element Type Description
enabled boolean

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

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

The DiskSlowWriteAndReadsThresholds object

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

Element Type Description
writeAndReadTime integer

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

The DiskLowSpaceDetectionConfig object

Configuration of low disk space detection.

Element Type Description
enabled boolean

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

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

The DiskLowSpaceThresholds object

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

Element Type Description
freeSpacePercentage integer

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

The NetworkHighRetransmissionDetectionConfig object

Configuration of high retransmission rate detection.

Element Type Description
enabled boolean

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

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

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

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.

Element Type Description
retransmissionRatePercentage integer

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

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.

Element Type Description
enabled boolean

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

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

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

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.

Element Type Description
newConnectionFailuresPercentage integer

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

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

The HighNetworkDetectionConfig object

Configuration of high network utilization detection.

Element Type Description
enabled boolean

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

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

The HighNetworkThresholds object

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

Element Type Description
utilizationPercentage integer

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

The NetworkErrorsDetectionConfig object

Configuration of high number of network errors detection.

Element Type Description
enabled boolean

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

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

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

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.

Element Type Description
errorsPercentage integer

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

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

The NetworkDroppedPacketsDetectionConfig object

Configuration of high number of dropped packets detection.

Element Type Description
enabled boolean

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

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

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

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.

Element Type Description
droppedPacketsPercentage integer

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

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

The OutOfThreadsDetectionConfig object

Configuration of Java out of threads problems detection.

Element Type Description
enabled boolean

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

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

The OutOfThreadsThresholds object

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

Element Type Description
outOfThreadsExceptionsNumber integer

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

The OutOfMemoryDetectionConfig object

Configuration of Java out of memory problems detection.

Element Type Description
enabled boolean

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

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

The OutOfMemoryThresholds object

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

Element Type Description
outOfMemoryExceptionsNumber integer

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

The HighGcActivityDetectionConfig object

Configuration of high Garbage Collector activity detection.

Element Type Description
enabled boolean

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

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

Meeting any of these conditions triggers an alert.

The HighGcActivityThresholds object

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

Meeting any of these conditions triggers an alert.

Element Type Description
gcTimePercentage integer

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

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

The HighMemoryDetectionConfig object

Configuration of high memory usage detection.

Element Type Description
enabled boolean

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

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

Both conditions must be met to trigger an alert.

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.

Element Type Description
pageFaultsPerSecondWindows integer

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

Memory usage is higher than X% on Windows.
pageFaultsPerSecondNonWindows integer

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

Memory usage is higher than X% on Linux.

The HighCpuSaturationDetectionConfig object

Configuration of high CPU saturation detection

Element Type Description
enabled boolean

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

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

The HighCpuSaturationThresholds object

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

Element Type Description
cpuSaturation integer

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

The ConnectionLostDetectionConfig object

Configuration of lost connection detection.

Element Type Description
enabled boolean

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

Alert (true) on graceful host shutdowns.

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.
clusterVersion string

DESK server version.

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.dexp.ae/api/config/v1/anomalyDetection/hosts \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/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