Configure build label propagation

As part of getting started with Kubernetes monitoring, you might want to configure build label propagation.

Build label propagation enables you to provide build and version metadata information to the injected OneAgent about the newly deployed pods. This information is then visible on the Properties and tags section of your entities pages.

How it works

You can reference the value of a metadata field in an environment variable.

env:
   - name: MY_POD_NAMESPACE
     valueFrom:
       fieldRef:
         fieldPath: metadata.namespace

Then OneAgent injects into the newly deployed pods and collects the metadata provided via environment variables.

Enable build label propagation

To enable build label propagation, you need to set feature.dynatrace.com/label-version-detection to true in DynaKube. Note that since enabling build label propagation requires webhook injection, it only works with applicationMonitoring and cloudNativeFullStack deployments.

apiVersion: dynatrace.com/v1beta1
kind: DynaKube
metadata:
  name: dynakube
  namespace: dynatrace
  annotations:
    feature.dynatrace.com/label-version-detection: "true"
...
  oneAgent:
    cloudNativeFullStack: {}

Default behavior

For example, if your application has the following pod:

apiVersion: v1
kind: Pod
metadata:
  ...
  labels:
    app.kubernetes.io/version: "1.0.0"
    app.kubernetes.io/part-of: "store"
spec:
...

the value of the labels is added to the environment variables of the injected containers:

apiVersion: v1
kind: Pod
metadata:
  ...
  labels:
    app.kubernetes.io/version: "1.0.0"
    app.kubernetes.io/part-of: "Store"
spec:
...
  containers:
  - name: app
      ...
      env:
      - name: "DT_RELEASE_VERSION"
        valueFrom:
          fieldRef:
            fieldPath: metadata.labels['app.kubernetes.io/version']
      - name: "DT_RELEASE_PRODUCT"
        valueFrom:
          fieldRef:
            fieldPath: metadata.labels['app.kubernetes.io/part-of']

If the DT_RELEASE_VERSION or DT_RELEASE_PRODUCT environment variables are already set on the container before the OneAgent injection, they will not be overwritten.

Configuration options

You can annotate your namespace to provide further mappings or overrule the defaults for pods within that namespace.

Example to overwrite the default values for version and product, and enable stage and build-version:

annotations:
  mapping.release.dynatrace.com/version: "metadata.annotations['my-version']"
  mapping.release.dynatrace.com/product: "metadata.labels['app.kubernetes.io/name']"
  mapping.release.dynatrace.com/stage: "metadata.namespace"
  mapping.release.dynatrace.com/build-version: "metadata.labels['release.dynatrace.com/stage']"

Each of these annotations configures a different environment variable:

The values aren't validated by Dynatrace Operator or the webhook, so make sure they are valid.