Settings API - Kubernetes cluster anomaly detection schema table

  • Published Dec 05, 2023

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

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

Schema IDSchema groupsScope
builtin:anomaly-detection.kubernetes.cluster
  • group:anomaly-detection.kubernetes
  • group:anomaly-detection
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.cluster
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:anomaly-detection.kubernetes.cluster
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.kubernetes.cluster

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
readinessIssuesReadinessIssues

Alerts if cluster has not been ready for a given amount of time

Required
cpuRequestsSaturationCpuRequestsSaturation-Required
memoryRequestsSaturationMemoryRequestsSaturation-Required
podsSaturationPodsSaturation-Required
monitoringIssuesMonitoringIssues-Required
The ReadinessIssues object
PropertyTypeDescriptionRequired
Detect cluster readiness issues
enabled		boolean

Evaluates the Kubernetes readyz endpoint

Required
configurationReadinessIssuesConfig

Alert if

Required
The CpuRequestsSaturation object
PropertyTypeDescriptionRequired
Detect cluster CPU-request saturation
enabled		boolean-Required
configurationCpuRequestsSaturationConfig

Alert if

Required
The MemoryRequestsSaturation object
PropertyTypeDescriptionRequired
Detect cluster memory-request saturation
enabled		boolean-Required
configurationMemoryRequestsSaturationConfig

Alert if

Required
The PodsSaturation object
PropertyTypeDescriptionRequired
Detect cluster pod-saturation
enabled		boolean-Required
configurationPodsSaturationConfig

Alert if

Required
The MonitoringIssues object
PropertyTypeDescriptionRequired
Detect monitoring issues
enabled		boolean-Required
configurationMonitoringIssuesConfig

Alert if

Required
The ReadinessIssuesConfig object
PropertyTypeDescriptionRequired
cluster is not ready for at least
samplePeriodInMinutes		integer-Required
within the last
observationPeriodInMinutes		integer-Required
The CpuRequestsSaturationConfig object
PropertyTypeDescriptionRequired
amount of requested CPU is above
threshold		integer-Required
of cluster CPU capacity for at least
samplePeriodInMinutes		integer-Required
within the last
observationPeriodInMinutes		integer-Required
The MemoryRequestsSaturationConfig object
PropertyTypeDescriptionRequired
amount of requested memory is above
threshold		integer-Required
of cluster memory capacity for at least
samplePeriodInMinutes		integer-Required
within the last
observationPeriodInMinutes		integer-Required
The PodsSaturationConfig object
PropertyTypeDescriptionRequired
number of running pods is higher than
threshold		integer-Required
of schedulable pod capacity for at least
samplePeriodInMinutes		integer-Required
within the last
observationPeriodInMinutes		integer-Required
The MonitoringIssuesConfig object
PropertyTypeDescriptionRequired
monitoring is not available for at least
samplePeriodInMinutes		integer-Required
within the last
observationPeriodInMinutes		integer-Required