• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Monitoring settings

Settings API - Monitoring settings schema table

Monitoring settings (builtin:cloud.kubernetes)

Connect to Kubernetes or OpenShift for enhanced observability. Learn more about Kubernetes or OpenShift in our documentation.

Schema IDSchema groupsScope
builtin:cloud.kubernetes-
KUBERNETES_CLUSTER - Kubernetes cluster
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:cloud.kubernetes
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:cloud.kubernetes
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:cloud.kubernetes

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
enabledEnabledboolean-required
labelNametext

Renaming the cluster breaks configurations that are based on its name (e.g., management zones, and alerting).

required
clusterIdEnabledConnect containerized ActiveGate to local Kubernetes API endpointboolean

This is required for monitoring persistent volume claims. For more information on local Kubernetes API monitoring, see the documentation.

Enable this toggle when the ActiveGate is deployed to the same Kubernetes clusters you want to monitor. Disable it if you want to monitor a different Kubernetes cluster.

required
clusterIdKubernetes cluster IDtext

Unique ID of the cluster, the containerized ActiveGate is deployed to. Defaults to the UUID of the kube-system namespace. The cluster ID of containerized ActiveGates is shown on the Deployment status screen.

required
endpointUrlKubernetes API URL Targettext

Get the API URL for Kubernetes or OpenShift.

required
authTokenKubernetes Bearer Tokensecret

Create a bearer token for Kubernetes or OpenShift.

required
activeGateGroupActiveGate Grouptext-optional
certificateCheckEnabledRequire valid certificates for communication with API server (recommended)boolean-required
hostnameVerificationEnabledVerify hostname in certificate against Kubernetes API URLboolean-required
cloudApplicationPipelineEnabledMonitor Kubernetes namespaces, services, workloads, and podsboolean-required
pvcMonitoringEnabledMonitor persistent volume claimsboolean

To enable dashboards and alerts, add the Kubernetes persistent volume claims extension to your environment.

The persistent volume claims feature is based on custom metrics and is therefore subject to Davis data units (DDU) licensing. See DDUs for custom metrics for details.

required
openMetricsPipelineEnabledMonitor annotated Prometheus exportersboolean

For annotation guidance, see the documentation.

Prometheus metrics in Kubernetes environments are subject to Davis data units (DDU) licensing. See Monitoring consumption for details.

required
openMetricsBuiltinEnabledMonitor workload resource metricsboolean

The workload resource metrics are based on a subset of cAdvisor metrics. Depending on your Kubernetes cluster size, this may increase the CPU/memory resource consumption of your ActiveGate.

required
eventProcessingActiveMonitor eventsboolean

All events are monitored by default unless event filters are specified.

Kubernetes events are subject to Davis data units (DDU) licensing. See DDUs for events for details.

required
filterEventsFilter eventsboolean

Include only events specified by Events Field Selectors

required
includeAllFdiEventsInclude important eventsboolean

For a list of included events, see the documentation.

Automatically include all events that are relevant for Davis

required
eventPatternsEvents field selectorslist

Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.

required

Request body objects

The FlagDefaultTrue object
PropertyLabelTypeDescriptionRequired
enabledMonitoring Enabledboolean-required
The EventComplexType object
PropertyLabelTypeDescriptionRequired
labelField selector nametext-required
patternField selector expressiontext

The set of allowed characters for this field has been extended with ActiveGate version 1.259. For more details, see the documentation.

required
activeActivateboolean-required