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 | Label | 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 |
Request body objects
The CpuRequestsSaturationConfig object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| threshold | amount of requested CPU is above | integer | - | required |
| samplePeriodInMinutes | of cluster CPU capacity for at least | integer | - | required |
| observationPeriodInMinutes | within the last | integer | - | required |
The CpuRequestsSaturation object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Detect cluster CPU-request saturation | boolean | - | required |
| configuration | - | CpuRequestsSaturationConfig | Alert if | required |
The MemoryRequestsSaturationConfig object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| threshold | amount of requested memory is above | integer | - | required |
| samplePeriodInMinutes | of cluster memory capacity for at least | integer | - | required |
| observationPeriodInMinutes | within the last | integer | - | required |
The MemoryRequestsSaturation object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Detect cluster memory-request saturation | boolean | - | required |
| configuration | - | MemoryRequestsSaturationConfig | Alert if | required |
The ReadinessIssuesConfig object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| samplePeriodInMinutes | cluster is not ready for at least | integer | - | required |
| observationPeriodInMinutes | within the last | integer | - | required |
The ReadinessIssues object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Detect cluster readiness issues | boolean | Evaluates the Kubernetes readyz endpoint | required |
| configuration | - | ReadinessIssuesConfig | Alert if | required |
The PodsSaturationConfig object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| threshold | number of running pods is higher than | integer | - | required |
| samplePeriodInMinutes | of schedulable pod capacity for at least | integer | - | required |
| observationPeriodInMinutes | within the last | integer | - | required |
The PodsSaturation object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Detect cluster pod-saturation | boolean | - | required |
| configuration | - | PodsSaturationConfig | Alert if | required |
The MonitoringIssuesConfig object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| samplePeriodInMinutes | monitoring is not available for at least | integer | - | required |
| observationPeriodInMinutes | within the last | integer | - | required |
The MonitoringIssues object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Detect monitoring issues | boolean | - | required |
| configuration | - | MonitoringIssuesConfig | Alert if | required |