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 IDSchema groupsScope
    builtin:cloud.kubernetes.monitoring
    • group:cloud-and-virtualization
    KUBERNETES_CLUSTER - Kubernetes cluster
    environment
    GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:cloud.kubernetes.monitoring
    SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:cloud.kubernetes.monitoring
    Environment ActiveGatehttps://{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

    PropertyTypeDescriptionRequired
    Monitor Kubernetes namespaces, services, workloads, and pods
    cloudApplicationPipelineEnabled    		boolean-required
    Monitor annotated Prometheus exporters
    openMetricsPipelineEnabled    		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
    Monitor workload and node resource metrics
    openMetricsBuiltinEnabled    		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
    Monitor events
    eventProcessingActive    		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
    Filter events
    filterEvents    		boolean

    Include only events specified by Events Field Selectors

    		required
    Include important events
    includeAllFdiEvents    		boolean

    For a list of included events, see the documentation.

    Automatically include all events that are relevant for Davis

    		required
    Events field selectors
    eventPatterns    		EventComplexType[]

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

    		required
    The EventComplexType object
    PropertyTypeDescriptionRequired
    Field selector name
    label    		text-required
    Field selector expression
    pattern    		text

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

    		required
    Activate
    active    		boolean-required