Settings API - Monitoring settings schema table

Monitoring settings (`builtin:cloud.kubernetes.monitoring`)

Configure the monitoring features for Kubernetes or OpenShift. Learn more about those features in our documentation.

Schema ID	Schema groups	Scope
`builtin:cloud.kubernetes.monitoring`	`group:cloud-and-virtualization`	`KUBERNETES_CLUSTER` - Kubernetes cluster `environment`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:cloud.kubernetes.monitoring`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:cloud.kubernetes.monitoring`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:cloud.kubernetes.monitoring`

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
cloudApplicationPipelineEnabled	Monitor Kubernetes namespaces, services, workloads, and pods	boolean	-	required
pvcMonitoringEnabled	Monitor persistent volume claims	boolean	To enable dashboards and alerts, add the Kubernetes persistent volume claims (`<your-dynatrace-url>/ui/hub/ext/com.dynatrace.extension.kubernetes-pvc`) extension to your environment. The persistent volume claims feature is based on custom metrics and is, therefore, subject to licensing. If you have DPS licensing see licensing documentation for details. If you have non-DPS licensing see DDUs for custom metrics for details.	required
openMetricsPipelineEnabled	Monitor annotated Prometheus exporters	boolean	For annotation guidance, see the documentation. Prometheus metrics in kubernetes environments are subject to licensing. If you have DPS licensing see licensing documentation for details. If you have non-DPS licensing see Monitoring consumption for details.	required
openMetricsBuiltinEnabled	Monitor workload and node resource metrics	boolean	Workload and node 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. Node resource metrics require ActiveGate 1.271+	required
eventProcessingActive	Monitor events	boolean	All events are monitored unless event filters are specified. All ingested events are subject to licensing by default. If you have a DPS license see licensing documentation for details. If you have a non-DPS license see DDUs for events for details.	required
filterEvents	Filter events	boolean	Include only events specified by Events Field Selectors	required
includeAllFdiEvents	Include important events	boolean	For a list of included events, see the documentation. Automatically include all events that are relevant for Davis	required
eventPatterns	Events field selectors	list	Define Kubernetes event filters to ingest events into your environment. For more details, see the documentation.	required

Request body objects

The `EventComplexType` object

Property	Label	Type	Description	Required
label	Field selector name	text	-	required
pattern	Field selector expression	text	The set of allowed characters for this field has been extended with ActiveGate version 1.259. For more details, see the documentation.	required
active	Activate	boolean	-	required