Settings API - Telemetry enrichment, cost control and security context schema table

Telemetry enrichment, cost control and security context (builtin:kubernetes.generic.metadata.enrichment)

Generic metadata enrichment for Kubernetes.

Schema IDSchema groupsScope
builtin:kubernetes.generic.metadata.enrichment
  • group:cloud-and-virtualization
KUBERNETES_CLUSTER - Kubernetes cluster
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:kubernetes.generic.metadata.enrichment
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:kubernetes.generic.metadata.enrichment
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:kubernetes.generic.metadata.enrichment

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
rulesRule[]

Dynatrace enables you to set the security context for metrics, events, logs, spans, and entities based on a Kubernetes label or annotation.

Dynatrace also enables you to set cost allocation attributes for metrics, events, logs, and spans based on Kubernetes labels and/or annotations.

You might already have existing annotations and labels that you want to use as the source for either security context or cost allocation. You can do so by telling Dynatrace and the Dynatrace Operator which labels/annotations to use as the source. This has the advantage of not having to change any of your existing deployments. Do this by adding rules on this page.

You can define a maximum of 20 rules.

It can take up to 45 minutes for the Dynatrace Operator to adopt changes to the rules. Afterwards, pod restarts are required.

To learn more about component requirements, types of enriched data and additional data enrichment options, please refer to the documentation.

required
The Rule object
PropertyTypeDescriptionRequired
Metadata type
type
enum
  • ANNOTATION
  • LABEL
required
Source
source
text

The source must follow the syntax of Kubernetes annotation/label keys as defined in the Kubernetes documentation.

source := (prefix/)?name

prefix := a-z0-9 (/[-a-z0-9][a-z0-9])?(\.a-z0-9 (/[-a-z0-9][a-z0-9])?)*

name := ([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]

Additionally, the name can have at most 63 characters, and the overall length of the source must not exceed 75 characters.

required
Target
target
enum
  • dt.security_context
  • dt.cost.product
  • dt.cost.costcenter
required