Settings API - Kubernetes cluster anomaly detection schema table
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.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:anomaly-detection.kubernetes.cluster |
| KUBERNETES_CLUSTER - Kubernetes clusterenvironment |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:anomaly-detection.kubernetes.cluster |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:anomaly-detection.kubernetes.cluster | |
| Environment ActiveGate | https://{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
| Property | Type | Description | Required |
|---|---|---|---|
readinessIssues | ReadinessIssues | Alerts if cluster has not been ready for a given amount of time | required |
cpuRequestsSaturation | CpuRequestsSaturation | - | required |
memoryRequestsSaturation | MemoryRequestsSaturation | - | required |
podsSaturation | PodsSaturation | - | required |
monitoringIssues | MonitoringIssues | - | required |
The ReadinessIssues object
| Property | Type | Description | Required |
|---|---|---|---|
Detect cluster readiness issuesenabled | boolean | Evaluates the Kubernetes readyz endpoint | required |
configuration | ReadinessIssuesConfig | Alert if | required |
The CpuRequestsSaturation object
| Property | Type | Description | Required |
|---|---|---|---|
Detect cluster CPU-request saturationenabled | boolean | - | required |
configuration | CpuRequestsSaturationConfig | Alert if | required |
The MemoryRequestsSaturation object
| Property | Type | Description | Required |
|---|---|---|---|
Detect cluster memory-request saturationenabled | boolean | - | required |
configuration | MemoryRequestsSaturationConfig | Alert if | required |
The PodsSaturation object
| Property | Type | Description | Required |
|---|---|---|---|
Detect cluster pod-saturationenabled | boolean | - | required |
configuration | PodsSaturationConfig | Alert if | required |
The MonitoringIssues object
| Property | Type | Description | Required |
|---|---|---|---|
Detect monitoring issuesenabled | boolean | - | required |
configuration | MonitoringIssuesConfig | Alert if | required |
The ReadinessIssuesConfig object
| Property | Type | Description | Required |
|---|---|---|---|
cluster is not ready for at leastsamplePeriodInMinutes | integer | - | required |
within the lastobservationPeriodInMinutes | integer | - | required |
The CpuRequestsSaturationConfig object
| Property | Type | Description | Required |
|---|---|---|---|
amount of requested CPU is abovethreshold | integer | - | required |
of cluster CPU capacity for at leastsamplePeriodInMinutes | integer | - | required |
within the lastobservationPeriodInMinutes | integer | - | required |
The MemoryRequestsSaturationConfig object
| Property | Type | Description | Required |
|---|---|---|---|
amount of requested memory is abovethreshold | integer | - | required |
of cluster memory capacity for at leastsamplePeriodInMinutes | integer | - | required |
within the lastobservationPeriodInMinutes | integer | - | required |
The PodsSaturationConfig object
| Property | Type | Description | Required |
|---|---|---|---|
number of running pods is higher thanthreshold | integer | - | required |
of schedulable pod capacity for at leastsamplePeriodInMinutes | integer | - | required |
within the lastobservationPeriodInMinutes | integer | - | required |
The MonitoringIssuesConfig object
| Property | Type | Description | Required |
|---|---|---|---|
monitoring is not available for at leastsamplePeriodInMinutes | integer | - | required |
within the lastobservationPeriodInMinutes | integer | - | required |