Settings API - Anomaly detection for infrastructure- Host schema table

  • Published Dec 05, 2023

Anomaly detection for infrastructure: Host (builtin:anomaly-detection.infrastructure-hosts)

Dynatrace automatically detects infrastructure-related performance anomalies such as high CPU saturation and memory outages. Use these settings to configure detection sensitivity, set alert thresholds, or disable alerting for hosts.

Schema IDSchema groupsScope
builtin:anomaly-detection.infrastructure-hosts
  • group:anomaly-detection.infrastructure
  • group:anomaly-detection
HOST - Host
HOST_GROUP - Host Group
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.infrastructure-hosts
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:anomaly-detection.infrastructure-hosts
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.infrastructure-hosts

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

PropertyTypeDescriptionRequired
Hosts
host		host-required
Network
network		network-required
The host object
PropertyTypeDescriptionRequired
connectionLostDetectionconnectionLostDetection-required
highCpuSaturationDetectionhighCpuSaturationDetection-required
highSystemLoadDetectionhighSystemLoadDetection-required
highMemoryDetectionhighMemoryDetection-required
highGcActivityDetectionhighGcActivityDetection-required
outOfMemoryDetectionoutOfMemoryDetection-required
outOfThreadsDetectionoutOfThreadsDetection-required
The network object
PropertyTypeDescriptionRequired
networkDroppedPacketsDetectionnetworkDroppedPacketsDetection-required
networkErrorsDetectionnetworkErrorsDetection-required
highNetworkDetectionhighNetworkDetection-required
networkTcpProblemsDetectionnetworkTcpProblemsDetection-required
networkHighRetransmissionDetectionnetworkHighRetransmissionDetection-required
The connectionLostDetection object
PropertyTypeDescriptionRequired
Detect host or monitoring connection lost problems
enabled		boolean-required
Graceful host shutdowns
onGracefulShutdowns		enum
  • DONT_ALERT_ON_GRACEFUL_SHUTDOWN
  • ALERT_ON_GRACEFUL_SHUTDOWN
required
The highCpuSaturationDetection object
PropertyTypeDescriptionRequired
Detect CPU saturation on host
enabled		boolean

Detection of high CPU saturation is not available on AIX hosts

required
Detection mode for CPU saturation
detectionMode		enum
  • auto
  • custom
required
customThresholdshighCpuSaturationDetectionThresholds-required
The highSystemLoadDetection object
PropertyTypeDescriptionRequired
Detect High System Load on host
enabled		boolean

Detection High System Load is available only on AIX hosts.

required
Detection mode for High System Load
detectionMode		enum
  • auto
  • custom
required
customThresholdshighSystemLoadDetectionThresholds-required
The highMemoryDetection object
PropertyTypeDescriptionRequired
Detect high memory usage on host
enabled		boolean-required
Detection mode for high memory usage
detectionMode		enum
  • auto
  • custom
required
customThresholdshighMemoryDetectionThresholds

Alert if both the memory usage and the memory page fault rate thresholds are exceeded on Windows or on Unix systems

required
The highGcActivityDetection object
PropertyTypeDescriptionRequired
Detect high GC activity
enabled		boolean

You may also configure high GC activity alerting for .NET processes on extensions events page (<your-dynatrace-url>//#settings/anomalydetection/extensionevents).

required
Detection mode for high GC activity
detectionMode		enum
  • auto
  • custom
required
customThresholdshighGcActivityDetectionThresholds

Alert if the GC time or the GC suspension is exceeded

required
The outOfMemoryDetection object
PropertyTypeDescriptionRequired
Detect Java out of memory problem
enabled		boolean-required
Detection mode for Java out of memory problem
detectionMode		enum
  • auto
  • custom
required
customThresholdsoutOfMemoryDetectionThresholds-required
The outOfThreadsDetection object
PropertyTypeDescriptionRequired
Detect Java out of threads problem
enabled		boolean-required
Detection mode for Java out of threads problem
detectionMode		enum
  • auto
  • custom
required
customThresholdsoutOfThreadsDetectionThresholds-required
The networkDroppedPacketsDetection object
PropertyTypeDescriptionRequired
Detect high number of dropped packets
enabled		boolean-required
Detection mode for high number of dropped packets
detectionMode		enum
  • auto
  • custom
required
customThresholdsnetworkDroppedPacketsDetectionThresholds

Alert if the dropped packet percentage is higher than the specified threshold and the total packets rate is higher than the defined threshold for the defined amount of samples

required
The networkErrorsDetection object
PropertyTypeDescriptionRequired
Detect high number of network errors
enabled		boolean-required
Detection mode for high number of network errors
detectionMode		enum
  • auto
  • custom
required
customThresholdsnetworkErrorsDetectionThresholds

Alert if the receive/transmit error packet percentage is higher than the specified threshold and the total packets rate is higher than the defined threshold for the defined amount of samples

required
The highNetworkDetection object
PropertyTypeDescriptionRequired
Detect high network utilization
enabled		boolean-required
Detection mode for high network utilization
detectionMode		enum
  • auto
  • custom
required
customThresholdshighNetworkDetectionThresholds-required
The networkTcpProblemsDetection object
PropertyTypeDescriptionRequired
Detect TCP connectivity problems for process
enabled		boolean-required
Detection mode for TCP connectivity problems
detectionMode		enum
  • auto
  • custom
required
customThresholdsnetworkTcpProblemsDetectionThresholds

Alert if the percentage of new connection failures is higher than the specified threshold and the number of failed connections is higher than the defined threshold for the defined amount of samples

required
The networkHighRetransmissionDetection object
PropertyTypeDescriptionRequired
Detect high retransmission rate
enabled		boolean-required
Detection mode for high retransmission rate
detectionMode		enum
  • auto
  • custom
required
customThresholdsnetworkHighRetransmissionDetectionThresholds

Alert if the retransmission rate is higher than the specified threshold and the number of retransmitted packets is higher than the defined threshold for the defined amount of samples

required
The highCpuSaturationDetectionThresholds object
PropertyTypeDescriptionRequired
Alert if the CPU usage is higher than this threshold for the defined amount of samples
cpuSaturation		integer-required
eventThresholdseventThresholds-required
The highSystemLoadDetectionThresholds object
PropertyTypeDescriptionRequired
Alert if the System Load divided by the number of logical CPU cores is higher than this threshold for the defined amount of samples.
systemLoad		float-required
eventThresholdseventThresholds-required
The highMemoryDetectionThresholds object
PropertyTypeDescriptionRequired
Alert if the memory usage on Windows is higher than this threshold
usedMemoryPercentageWindows		integer-required
Alert if the memory usage on Unix systems is higher than this threshold
usedMemoryPercentageNonWindows		integer-required
Alert if the memory page fault rate on Windows is higher than this threshold for the defined amount of samples
pageFaultsPerSecondWindows		integer-required
Alert if the memory page fault rate on Unix systems is higher than this threshold for the defined amount of samples
pageFaultsPerSecondNonWindows		integer-required
eventThresholdseventThresholds-required
The highGcActivityDetectionThresholds object
PropertyTypeDescriptionRequired
Alert if GC time is higher than this threshold
gcTimePercentage		integer-required
Alert if the GC suspension is higher than this threshold
gcSuspensionPercentage		integer-required
eventThresholdseventThresholds-required
The outOfMemoryDetectionThresholds object
PropertyTypeDescriptionRequired
Alert if the number of Java out-of-memory exceptions is at least this value
outOfMemoryExceptionsNumber		integer-required
eventThresholdsstrictEventThresholds-required
The outOfThreadsDetectionThresholds object
PropertyTypeDescriptionRequired
Alert if the number of Java out-of-threads exceptions is at least this value
outOfThreadsExceptionsNumber		integer-required
eventThresholdsstrictEventThresholds-required
The networkDroppedPacketsDetectionThresholds object
PropertyTypeDescriptionRequired
Receive/transmit dropped packet percentage threshold
droppedPacketsPercentage		integer-required
Total packets rate threshold
totalPacketsRate		integer-required
eventThresholdseventThresholds-required
The networkErrorsDetectionThresholds object
PropertyTypeDescriptionRequired
Receive/transmit error packet percentage threshold
errorsPercentage		integer-required
Total packets rate threshold
totalPacketsRate		integer-required
eventThresholdseventThresholds-required
The highNetworkDetectionThresholds object
PropertyTypeDescriptionRequired
Alert if sent/received traffic utilization is higher than this threshold for the defined amount of samples
errorsPercentage		integer-required
eventThresholdseventThresholds-required
The networkTcpProblemsDetectionThresholds object
PropertyTypeDescriptionRequired
New connection failure threshold
newConnectionFailuresPercentage		integer-required
Number of failed connections threshold
failedConnectionsNumberPerMinute		integer-required
eventThresholdseventThresholds-required
The networkHighRetransmissionDetectionThresholds object
PropertyTypeDescriptionRequired
Retransmission rate threshold
retransmissionRatePercentage		integer-required
Number of retransmitted packets threshold
retransmittedPacketsNumberPerMinute		integer-required
eventThresholdseventThresholds-required
The eventThresholds object
PropertyTypeDescriptionRequired
Violating samples
violatingSamples		integer

The number of 10-second samples within the evaluation window that must exceed the threshold to trigger an event

required
Evaluation window size for violating samples
violatingEvaluationWindow		integer

The number of 10-second samples that form the sliding evaluation window to detect violating samples.

required
Dealerting samples
dealertingSamples		integer

The number of 10-second samples within the evaluation window that must be lower than the threshold to close an event

required
Evaluation window size for dealerting samples
dealertingEvaluationWindow		integer

The number of 10-second samples that form the sliding evaluation window for dealerting.

required
The strictEventThresholds object
PropertyTypeDescriptionRequired
Violating samples
violatingSamples		integer

The number of 10-second samples within the evaluation window that must exceed the threshold to trigger an event

required
Evaluation window size for violating samples
violatingEvaluationWindow		integer

The number of 10-second samples that form the sliding evaluation window to detect violating samples.

required
Dealerting samples
dealertingSamples		integer

The number of 10-second samples within the evaluation window that must be lower than the threshold to close an event

required
Evaluation window size for dealerting samples
dealertingEvaluationWindow		integer

The number of 10-second samples that form the sliding evaluation window for dealerting.

required