• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Kubernetes workload anomaly detection

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.

Schema IDSchema groupsScope
builtin:anomaly-detection.kubernetes.workload
  • group:anomaly-detection.kubernetes
  • group:anomaly-detection
CLOUD_APPLICATION_NAMESPACE - Kubernetes namespace
KUBERNETES_CLUSTER - Kubernetes cluster
environment
Retrieve schema via Settings API
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

PropertyLabelTypeDescriptionRequired
containerRestarts-ContainerRestarts-required
pendingPods-PendingPods-required
deploymentStuck-DeploymentStuck-required
podStuckInTerminating-PodStuckInTerminating-required
workloadWithoutReadyPods-WorkloadWithoutReadyPods-required
notAllPodsReady-NotAllPodsReady-required

Request body objects

The ContainerRestartsConfig object
PropertyLabelTypeDescriptionRequired
thresholdthere is at leastinteger-required
samplePeriodInMinutesper minute, for anyinteger-required
observationPeriodInMinuteswithin the lastinteger-required
The ContainerRestarts object
PropertyLabelTypeDescriptionRequired
enabledDetect container restartsboolean-required
configuration-ContainerRestartsConfig

Alert if

required
The WorkloadWithoutReadyPodsConfig object
PropertyLabelTypeDescriptionRequired
samplePeriodInMinutesworkload has no ready pods for at leastinteger-required
observationPeriodInMinuteswithin the lastinteger-required
The WorkloadWithoutReadyPods object
PropertyLabelTypeDescriptionRequired
enabledDetect workloads without ready podsboolean

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

required
configuration-WorkloadWithoutReadyPodsConfig

Alert if

required
The NotAllPodsReadyConfig object
PropertyLabelTypeDescriptionRequired
samplePeriodInMinutessome workload pods are not ready for at leastinteger-required
observationPeriodInMinuteswithin the lastinteger-required
The NotAllPodsReady object
PropertyLabelTypeDescriptionRequired
enabledDetect workloads with non-ready podsboolean

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

required
configuration-NotAllPodsReadyConfig

Alert if

required
The PendingPodsConfig object
PropertyLabelTypeDescriptionRequired
thresholdthere is at leastinteger-required
samplePeriodInMinutesstuck in pending state for at leastinteger-required
observationPeriodInMinuteswithin the lastinteger-required
The PendingPods object
PropertyLabelTypeDescriptionRequired
enabledDetect pending podsboolean

Number of pods in pending phase

required
configuration-PendingPodsConfig

Alert if

required
The DeploymentStuckConfig object
PropertyLabelTypeDescriptionRequired
samplePeriodInMinutesworkload stops progressing for at leastinteger-required
observationPeriodInMinuteswithin the lastinteger-required
The DeploymentStuck object
PropertyLabelTypeDescriptionRequired
enabledDetect stuck workloadsboolean-required
configuration-DeploymentStuckConfig

Alert if

required
The PodStuckInTerminatingConfig object
PropertyLabelTypeDescriptionRequired
samplePeriodInMinutespod termination stops progressing for at leastinteger-required
observationPeriodInMinuteswithin the lastinteger-required
The PodStuckInTerminating object
PropertyLabelTypeDescriptionRequired
enabledDetect pods stuck in terminatingboolean-required
configuration-PodStuckInTerminatingConfig

Alert if

required