Settings API - Anomaly detection for infrastructure- Host schema table
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 ID | Schema groups | Scope |
---|---|---|
builtin:anomaly-detection.infrastructure-hosts |
| HOST - HostHOST_GROUP - Host Groupenvironment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.infrastructure-hosts |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:anomaly-detection.infrastructure-hosts | |
Environment ActiveGate | https://{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
The host
object
Property | Type | Description | Required |
---|---|---|---|
connectionLostDetection | connectionLostDetection | - | required |
highCpuSaturationDetection | highCpuSaturationDetection | - | required |
highSystemLoadDetection | highSystemLoadDetection | - | required |
highMemoryDetection | highMemoryDetection | - | required |
highGcActivityDetection | highGcActivityDetection | - | required |
outOfMemoryDetection | outOfMemoryDetection | - | required |
outOfThreadsDetection | outOfThreadsDetection | - | required |
The network
object
Property | Type | Description | Required |
---|---|---|---|
networkDroppedPacketsDetection | networkDroppedPacketsDetection | - | required |
networkErrorsDetection | networkErrorsDetection | - | required |
highNetworkDetection | highNetworkDetection | - | required |
networkTcpProblemsDetection | networkTcpProblemsDetection | - | required |
networkHighRetransmissionDetection | networkHighRetransmissionDetection | - | required |
The connectionLostDetection
object
Property | Type | Description | Required |
---|---|---|---|
Detect host or monitoring connection lost problemsenabled | boolean | - | required |
Graceful host shutdownsonGracefulShutdowns | enum |
| required |
The highCpuSaturationDetection
object
Property | Type | Description | Required |
---|---|---|---|
Detect CPU saturation on hostenabled | boolean | Detection of high CPU saturation is not available on AIX hosts | required |
Detection mode for CPU saturationdetectionMode | enum |
| required |
customThresholds | highCpuSaturationDetectionThresholds | - | required |
The highSystemLoadDetection
object
Property | Type | Description | Required |
---|---|---|---|
Detect High System Load on hostenabled | boolean | Detection High System Load is available only on AIX hosts. | required |
Detection mode for High System LoaddetectionMode | enum |
| required |
customThresholds | highSystemLoadDetectionThresholds | - | required |
The highMemoryDetection
object
Property | Type | Description | Required |
---|---|---|---|
Detect high memory usage on hostenabled | boolean | - | required |
Detection mode for high memory usagedetectionMode | enum |
| required |
customThresholds | highMemoryDetectionThresholds | 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
Property | Type | Description | Required |
---|---|---|---|
Detect high GC activityenabled | boolean | You may also configure high GC activity alerting for .NET processes on extensions events page ( | required |
Detection mode for high GC activitydetectionMode | enum |
| required |
customThresholds | highGcActivityDetectionThresholds | Alert if the GC time or the GC suspension is exceeded | required |
The outOfMemoryDetection
object
Property | Type | Description | Required |
---|---|---|---|
Detect Java out of memory problemenabled | boolean | - | required |
Detection mode for Java out of memory problemdetectionMode | enum |
| required |
customThresholds | outOfMemoryDetectionThresholds | - | required |
The outOfThreadsDetection
object
Property | Type | Description | Required |
---|---|---|---|
Detect Java out of threads problemenabled | boolean | - | required |
Detection mode for Java out of threads problemdetectionMode | enum |
| required |
customThresholds | outOfThreadsDetectionThresholds | - | required |
The networkDroppedPacketsDetection
object
Property | Type | Description | Required |
---|---|---|---|
Detect high number of dropped packetsenabled | boolean | - | required |
Detection mode for high number of dropped packetsdetectionMode | enum |
| required |
customThresholds | networkDroppedPacketsDetectionThresholds | 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
Property | Type | Description | Required |
---|---|---|---|
Detect high number of network errorsenabled | boolean | - | required |
Detection mode for high number of network errorsdetectionMode | enum |
| required |
customThresholds | networkErrorsDetectionThresholds | 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
Property | Type | Description | Required |
---|---|---|---|
Detect high network utilizationenabled | boolean | - | required |
Detection mode for high network utilizationdetectionMode | enum |
| required |
customThresholds | highNetworkDetectionThresholds | - | required |
The networkTcpProblemsDetection
object
Property | Type | Description | Required |
---|---|---|---|
Detect TCP connectivity problems for processenabled | boolean | - | required |
Detection mode for TCP connectivity problemsdetectionMode | enum |
| required |
customThresholds | networkTcpProblemsDetectionThresholds | 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
Property | Type | Description | Required |
---|---|---|---|
Detect high retransmission rateenabled | boolean | - | required |
Detection mode for high retransmission ratedetectionMode | enum |
| required |
customThresholds | networkHighRetransmissionDetectionThresholds | 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
Property | Type | Description | Required |
---|---|---|---|
Alert if the CPU usage is higher than this threshold for the defined amount of samplescpuSaturation | integer | - | required |
eventThresholds | eventThresholds | - | required |
The highSystemLoadDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
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 |
eventThresholds | eventThresholds | - | required |
The highMemoryDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Alert if the memory usage on Windows is higher than this thresholdusedMemoryPercentageWindows | integer | - | required |
Alert if the memory usage on Unix systems is higher than this thresholdusedMemoryPercentageNonWindows | integer | - | required |
Alert if the memory page fault rate on Windows is higher than this threshold for the defined amount of samplespageFaultsPerSecondWindows | integer | - | required |
Alert if the memory page fault rate on Unix systems is higher than this threshold for the defined amount of samplespageFaultsPerSecondNonWindows | integer | - | required |
eventThresholds | eventThresholds | - | required |
The highGcActivityDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Alert if GC time is higher than this thresholdgcTimePercentage | integer | - | required |
Alert if the GC suspension is higher than this thresholdgcSuspensionPercentage | integer | - | required |
eventThresholds | eventThresholds | - | required |
The outOfMemoryDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Alert if the number of Java out-of-memory exceptions is at least this valueoutOfMemoryExceptionsNumber | integer | - | required |
eventThresholds | strictEventThresholds | - | required |
The outOfThreadsDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Alert if the number of Java out-of-threads exceptions is at least this valueoutOfThreadsExceptionsNumber | integer | - | required |
eventThresholds | strictEventThresholds | - | required |
The networkDroppedPacketsDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Receive/transmit dropped packet percentage thresholddroppedPacketsPercentage | integer | - | required |
Total packets rate thresholdtotalPacketsRate | integer | - | required |
eventThresholds | eventThresholds | - | required |
The networkErrorsDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Receive/transmit error packet percentage thresholderrorsPercentage | integer | - | required |
Total packets rate thresholdtotalPacketsRate | integer | - | required |
eventThresholds | eventThresholds | - | required |
The highNetworkDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Alert if sent/received traffic utilization is higher than this threshold for the defined amount of sampleserrorsPercentage | integer | - | required |
eventThresholds | eventThresholds | - | required |
The networkTcpProblemsDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
New connection failure thresholdnewConnectionFailuresPercentage | integer | - | required |
Number of failed connections thresholdfailedConnectionsNumberPerMinute | integer | - | required |
eventThresholds | eventThresholds | - | required |
The networkHighRetransmissionDetectionThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Retransmission rate thresholdretransmissionRatePercentage | integer | - | required |
Number of retransmitted packets thresholdretransmittedPacketsNumberPerMinute | integer | - | required |
eventThresholds | eventThresholds | - | required |
The eventThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Violating samplesviolatingSamples | 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 samplesviolatingEvaluationWindow | integer | The number of 10-second samples that form the sliding evaluation window to detect violating samples. | required |
Dealerting samplesdealertingSamples | integer | The number of 10-second samples within the evaluation window that must be lower the threshold to close an event | required |
Evaluation window size for dealerting samplesdealertingEvaluationWindow | integer | The number of 10-second samples that form the sliding evaluation window for dealerting. | required |
The strictEventThresholds
object
Property | Type | Description | Required |
---|---|---|---|
Violating samplesviolatingSamples | 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 samplesviolatingEvaluationWindow | integer | The number of 10-second samples that form the sliding evaluation window to detect violating samples. | required |
Dealerting samplesdealertingSamples | integer | The number of 10-second samples within the evaluation window that must be lower the threshold to close an event | required |
Evaluation window size for dealerting samplesdealertingEvaluationWindow | integer | The number of 10-second samples that form the sliding evaluation window for dealerting. | required |