Leverage tags defined in Kubernetes deployments

Dynatrace automatically derives tags from your Kubernetes/OpenShift labels. This enables you to automatically organize and filter all your monitored Kubernetes/OpenShift application components.

Recommendation

It's recommended that you define additional metadata at the deployed system. For Kubernetes-based applications, you can simply use Kubernetes annotations. Dynatrace automatically detects and retrieves all Kubernetes and OpenShift annotations. This enables you to use automated tagging rules, based on existing or custom metadata, to define your filter sets for charts, alerting, and more. These tags and rules can be changed and adapted any time and will apply almost immediately without any change to the monitored environment or applications.

Automatic detection of Kubernetes properties and annotations

Dynatrace detects Kubernetes properties and annotations. Such properties and annotations can be used when specifying automated rule-based tags.

Additionally Dynatrace detects the following properties which can be used for automated rule-based tags and property-based process group detection rules

  • Kubernetes base pod name: User-provided name of the pod the container belongs to.
  • Kubernetes container: Name of the container that runs the process.
  • Kubernetes full pod name: Full name of the pod the container belongs to.
  • Kubernetes namespace: Namespace to which the containerized process is assigned.
  • Kubernetes pod UID: Unique ID of the related pod.

Leverage Kubernetes labels in Dynatrace

Kubernetes-based tags are searchable via Dynatrace search. This allows you to easily find and inspect the monitoring results of related processes running in your Kubernetes or OpenShift environment. You can also leverage Kubernetes tags to set up fine-grained alerting profiles. Kubernetes tags also integrate perfectly with Dynatrace filters.

Import your labels and annotations

You can specify Kubernetes labels in the deployment definition of your application or you can update the labels of your Kubernetes resources using the command kubectl label.

Dynatrace automatically detects all labels attached to pods at application deployment time. All you have to do is grant sufficient privileges to the pods that allow for reading the metadata from the Kubernetes REST API endpoint. This way the OneAgent code-modules can read these labels directly from the pod.

Grant viewer role to service accounts

In Kubernetes every pod is associated with a service account which is used to authenticate the pod's requests to the Kubernetes API. If not otherwise specified the pod uses the default service account of its namespace. Please note every namespace has its own set of service accounts and thus also it's own namespace-scoped default service account. The labels of every pod, whose service account has view permissions, will be imported to Dynatrace automatically.

The following steps show you how you can add view privileges to the default service account in the namespace1 namespace. You'll need to repeat these steps for all service accounts and namespaces you would like to enable for Dynatrace.

Allow the default service account to view metadata about your namespace namespace1 via the Kubernetes REST API:

$ kubectl -n namespace1 create rolebinding default-view --clusterrole=view --serviceaccount=namespace1:default

Your Kubernetes labels will be automatically attached as Kubernetes tags to all monitored Kubernetes processes in your Dynatrace environment.