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 ID | Schema groups | Scope |
---|---|---|
builtin:cloud.kubernetes | - | KUBERNETES_CLUSTER - Kubernetes cluster |
Parameters
Property | Label | Type | Description | Required |
---|---|---|---|---|
enabled | Enabled | boolean | - | required |
label | Name | text | Renaming the cluster breaks configurations that are based on its name (e.g., management zones, and alerting). | required |
clusterIdEnabled | Connect containerized ActiveGate to local Kubernetes API endpoint | boolean | 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 |
clusterId | Kubernetes cluster ID | text | 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 |
endpointUrl | Kubernetes API URL Target | text | Get the API URL for Kubernetes or OpenShift. | required |
authToken | Kubernetes Bearer Token | secret | Create a bearer token for Kubernetes or OpenShift. | required |
activeGateGroup | ActiveGate Group | text | - | optional |
certificateCheckEnabled | Require valid certificates for communication with API server (recommended) | boolean | - | required |
hostnameVerificationEnabled | Verify hostname in certificate against Kubernetes API URL | boolean | - | 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 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 |
openMetricsPipelineEnabled | Monitor annotated Prometheus exporters | boolean | 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 |
openMetricsBuiltinEnabled | Monitor workload resource metrics | boolean | 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 |
eventProcessingActive | Monitor events | boolean | 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 |
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 FlagDefaultTrue
object
Property | Label | Type | Description | Required |
---|---|---|---|---|
enabled | Monitoring Enabled | boolean | - | required |
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 |