Settings API - Kubernetes workload anomaly detection schema table

Kubernetes workload anomaly detection (builtin:anomaly-detection.kubernetes.workload)

Dynatrace automatically detects a wide range of common Kubernetes-related issues. Use these settings to configure alerts relevant to your Kubernetes workload. Changing thresholds resets the observation period. Additional information can be found on our documentation page.

Schema ID
Schema groups
Scope
builtin:anomaly-detection.kubernetes.workload
  • group:anomaly-detection.kubernetes
  • group:anomaly-detection
CLOUD_APPLICATION_NAMESPACE - Kubernetes namespace
KUBERNETES_CLUSTER - Kubernetes cluster
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.kubernetes.workload
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:anomaly-detection.kubernetes.workload
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.kubernetes.workload

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

Property
Type
Description
Required
containerRestarts
-
required
deploymentStuck
-
required
pendingPods
-
required
podStuckInTerminating
-
required
workloadWithoutReadyPods
-
required
notAllPodsReady
-
required
highMemoryUsage
-
required
highCpuUsage
-
required
highCpuThrottling
-
required
oomKills
-
required
jobFailureEvents
-
required
podBackoffEvents
-
required
podEvictionEvents
-
required
podPreemptionEvents
-
required
The ContainerRestarts object
Property
Type
Description
Required
Detect container restarts
enabled
boolean
-
required
configuration

Alert if

required
The DeploymentStuck object
Property
Type
Description
Required
Detect stuck deployments
enabled
boolean

Evaluates workload condition 'Progressing'

required
configuration

Alert if

required
The PendingPods object
Property
Type
Description
Required
Detect pods stuck in pending
enabled
boolean

Number of pods in Pending phase

required
configuration

Alert if

required
The PodStuckInTerminating object
Property
Type
Description
Required
Detect pods stuck in terminating
enabled
boolean

Deleted pods in 'Running' phase

required
configuration

Alert if

required
The WorkloadWithoutReadyPods object
Property
Type
Description
Required
Detect workloads without ready pods
enabled
boolean

As of specific pod life cycles of different workload types, cronjobs and jobs are excluded.

required
configuration

Alert if

required
The NotAllPodsReady object
Property
Type
Description
Required
Detect workloads with non-ready pods
enabled
boolean

As of specific pod life cycles of different workload types, cronjobs and jobs are excluded.

required
configuration

Alert if

required
The HighMemoryUsage object
Property
Type
Description
Required
Detect memory usage saturation
enabled
boolean

Memory usage (working set memory) is close to limits.

required
configuration

Alert if

required
The HighCpuUsage object
Property
Type
Description
Required
Detect CPU usage saturation
enabled
boolean

CPU usage is close to limits.

required
configuration

Alert if

required
The HighCpuThrottling object
Property
Type
Description
Required
Detect high CPU throttling
enabled
boolean

The CPU throttling to usage ratio exceeds the specified threshold. Important: This alert uses throttled seconds / used seconds (in millicores) in contrast to Prometheus and Grafana, which use throttled periods / total periods for the throttling ratio.

required
configuration

Alert if

required
The OOMKills object
Property
Type
Description
Required
Detect out-of-memory kills
enabled
boolean
-
required
The JobFailureEvents object
Property
Type
Description
Required
Detect job failure events
enabled
boolean

Alerts on any occurrence of Kubernetes events with reason 'BackoffLimitExceeded', 'DeadlineExceeded', or 'PodFailurePolicy'.

If 'Filter events' is enabled, make certain that you ingest events with the aforementioned reasons in order to receive alerts.

required
The PodBackoffEvents object
Property
Type
Description
Required
Detect pod backoff events
enabled
boolean

Alerts on any occurrence of Kubernetes events with reason 'BackOff', as observed on pod statuses 'ImagePullBackOff', and 'CrashLoopBackOff'.

If 'Filter events' is enabled, make certain that you ingest events with the aforementioned reasons in order to receive alerts.

required
The PodEvictionEvents object
Property
Type
Description
Required
Detect pod eviction events
enabled
boolean

Eviction is the process of terminating one or more pods on a node to free up resources.

Alerts on any occurrence of Kubernetes events with reason 'Evicted'.

If 'Filter events' is enabled, make certain that you ingest events with the aforementioned reasons in order to receive alerts.

required
The PodPreemptionEvents object
Property
Type
Description
Required
Detect pod preemption events
enabled
boolean

Preemption is the process of terminating pods with lower priority so that pods with higher priority can be scheduled on a node.

Alerts on any occurrence of Kubernetes events with reason 'Preempted', or 'Preempting'.

If 'Filter events' is enabled, make certain that you ingest events with the aforementioned reasons in order to receive alerts.

required
The ContainerRestartsConfig object
Property
Type
Description
Required
there is at least
threshold
integer
-
required
per minute, for any
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required
The DeploymentStuckConfig object
Property
Type
Description
Required
workload stops progressing for at least
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required
The PendingPodsConfig object
Property
Type
Description
Required
there is at least
threshold
integer
-
required
stuck in pending state for at least
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required
The PodStuckInTerminatingConfig object
Property
Type
Description
Required
pod termination stops progressing for at least
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required
The WorkloadWithoutReadyPodsConfig object
Property
Type
Description
Required
workload has no ready pods for at least
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required
The NotAllPodsReadyConfig object
Property
Type
Description
Required
some workload pods are not ready for at least
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required
The HighMemoryUsageConfig object
Property
Type
Description
Required
amount of utilized workload memory is above
threshold
integer
-
required
of defined memory limits for at least
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required
The HighCpuUsageConfig object
Property
Type
Description
Required
amount of utilized workload CPU is above
threshold
integer
-
required
of defined CPU limits for at least
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required
The HighCpuThrottlingConfig object
Property
Type
Description
Required
amount of CPU throttling is above
threshold
integer
-
required
of CPU usage for at least
samplePeriodInMinutes
integer
-
required
within the last
observationPeriodInMinutes
integer
-
required