Kubernetes API Monitoring

Dynatrace obtains information about Kubernetes entities and metadata by querying the Kubernetes API. This information is used for out-of-the-box alerting for Kubernetes and to provide all observability signals in a proper Kubernetes context within the Dynatrace platform, for example, by creating relationships among applications, (micro-)services, databases, and Kubernetes entities such as pods, namespaces, and nodes.

Dynatrace Operator manages the lifecycle of all Dynatrace components within a Kubernetes cluster and can be configured by deploying a DynaKube Custom Resource. Dynatrace ActiveGate—the Dynatrace component required to monitor the Kubernetes API—offers a capability for Kubernetes API Monitoring.

Follow the steps below to enable Kubernetes API monitoring.

Install Dynatrace Operator

Configure DynaKube

Connect ActiveGate with Kubernetes API

Install Dynatrace Operator

Install Dynatrace Operator in any deployment mode

Configure DynaKube

Configure the ActiveGate values of the DynaKube according to the list of parameters and add kubernetes-monitoring to the ActiveGate capabilities.

yaml
...
activeGate:
  capabilities:
    - routing
    - kubernetes-monitoring
  ...

Connect ActiveGate with Kubernetes API

You have two options:

Connect the containerized ActiveGate to a local Kubernetes API endpoint
Connect the containerized ActiveGate to the public Kubernetes API URL

See below for instructions for both options.

Connect to a local Kubernetes API endpoint

You can enable monitoring by connecting a containerized ActiveGate to a local Kubernetes API endpoint.

There are two ways to connect to the local Kubernetes API endpoint:

See below for details on both methods.

Connect automaticallyConnect manually

To connect automatically to the local Kubernetes API endpoint

Make sure to enable the Read entities, Read settings, and Write settings permissions (API v2) for your API token (see Access tokens and permissions).
Make sure that you have the kubernetes-monitoring capability enabled in your DynaKube custom resource.

Add the following annotation (see example below).

yaml
apiVersion: dynatrace.com/v1beta1
kind: DynaKube
metadata:
  name: dynakube
  namespace: dynatrace
  annotations:
    feature.dynatrace.com/automatic-kubernetes-api-monitoring: "true"
spec:
  ...
  activeGate:
    capabilities:
      - kubernetes-monitoring

After adding this annotation, the name of the cluster displayed in Dynatrace will be the same as the DynaKube custom resource where the annotation is configured. You can change the cluster name displayed in Dynatrace by adding the feature.dynatrace.com/automatic-kubernetes-api-monitoring-cluster-name: "custom-cluster-name" annotation as well.

Example with custom cluster name:

yaml
apiVersion: dynatrace.com/v1beta1
kind: DynaKube
metadata:
  name: dynakube
  namespace: dynatrace
  annotations:
    feature.dynatrace.com/automatic-kubernetes-api-monitoring: "true"
    feature.dynatrace.com/automatic-kubernetes-api-monitoring-cluster-name: "custom-cluster-name"
spec:
  ...
  activeGate:
    capabilities:
      - kubernetes-monitoring

Apply your configuration.

To disable the configuration, remove the annotation.

To connect to a local Kubernetes API endpoint manually, you only need to provide the unique Kubernetes cluster ID (the uuid of the kube-system namespace) in Dynatrace web UI. The containerized ActiveGate then identifies the unique cluster ID and sends it over to Dynatrace.

Get the Kubernetes cluster ID

Run the command below and grab the UID from the output.

KubernetesOpenShift

shell
kubectl get namespace kube-system -o jsonpath='{.metadata.uid}'

shell
oc get namespace kube-system -o jsonpath='{.metadata.uid}'

Provide the Kubernetes cluster ID in the Dynatrace web UI

In the Dynatrace menu, go to Kubernetes.
Select Connect manually.
On the Kubernetes cluster connection settings page, provide a Name, and then turn on Connect containerized ActiveGate to local Kubernetes API endpoint.
For Kubernetes cluster ID, enter the UID obtained earlier.
Select Save changes to save your configuration.

You can save your configuration even if the ActiveGate isn't ready to connect, and finish the configuration later. To verify if it's ready, select Test configuration.

Connect to the public Kubernetes API

To connect to the public Kubernetes API, follow the instructions that apply to your Kubernetes version:

Kubernetes version 1.24+

Get the Kubernetes API URL.

KubernetesOpenShift

bash
kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}'

bash
oc config view --minify -o jsonpath='{.clusters[0].cluster.server}'

If you set enableIstio to true in the DynaKube custom resource, use the command below to get the Kubernetes API URL:

KubernetesOpenShift

bash
kubectl -n default get svc/kubernetes -o jsonpath='https://{.spec.clusterIP}'

bash
oc -n default get svc/kubernetes -o jsonpath='https://{.spec.clusterIP}'

Create a file named token-secret.yaml with the following content:

yaml
apiVersion: v1
kind: Secret
metadata:
  name: dynatrace-kubernetes-monitoring
  annotations:
    kubernetes.io/service-account.name: "dynatrace-kubernetes-monitoring"
type: kubernetes.io/service-account-token

Apply the file to create the dynatrace-kubernetes-monitoring secret.

KubernetesOpenShift

bash
kubectl apply -n dynatrace -f token-secret.yaml

bash
oc apply -n dynatrace -f token-secret.yaml

Get the bearer token.

KubernetesOpenShift

bash
kubectl get secret dynatrace-kubernetes-monitoring -o jsonpath='{.data.token}' -n dynatrace | base64 --decode

bash
oc get secret dynatrace-kubernetes-monitoring -o jsonpath='{.data.token}' -n dynatrace | base64 --decode

In the Dynatrace menu, go to Kubernetes and select Connect manually.
On the Kubernetes cluster connection settings page, provide a Name, the Kubernetes API URL, and the Bearer token for the Kubernetes cluster.
Select Save changes.

Kubernetes version earlier than 1.24

Get the Kubernetes API URL.

KubernetesOpenShift

bash
kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}'

bash
oc config view --minify -o jsonpath='{.clusters[0].cluster.server}'

If you set enableIstio to true in the DynaKube custom resource, use the command below to get the Kubernetes API URL:

KubernetesOpenShift

bash
kubectl -n default get svc/kubernetes -o jsonpath='https://{.spec.clusterIP}'

bash
oc -n default get svc/kubernetes -o jsonpath='https://{.spec.clusterIP}'

Get the bearer token.
KubernetesOpenShift v3.xOpenShift v4.x
```
bash
kubectl get secret $(kubectl get sa dynatrace-kubernetes-monitoring -o jsonpath='{.secrets[0].name}' -n dynatrace) -o jsonpath='{.data.token}' -n dynatrace | base64 --decode
```
```
bash
oc get secret $(oc get sa dynatrace-kubernetes-monitoring -o jsonpath='{.secrets[0].name}' -n dynatrace) -o jsonpath='{.data.token}' -n dynatrace | base64 --decode
```
```
bash
oc get secret $(oc get sa dynatrace-kubernetes-monitoring -o jsonpath='{.secrets[1].name}' -n dynatrace) -o jsonpath='{.data.token}' -n dynatrace | base64 --decode
```
Special instructions for Rancher distributions to get the API URL and the bearer token
For Rancher distributions of Kubernetes, you need to use the bearer token and API URL of the Rancher server, because this server manages and secures traffic to the Kubernetes API server. Follow the steps below.
1. Get the Kubernetes API URL.
```
bash
kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}'
```
2. Configure a user.
  
  In the Rancher web UI, either create a new user or use an existing user to associate with the token. We recommend creating a new user.
3. Set permissions.
  
  Make sure the user has either Owner or Custom permissions to the cluster you want to monitor.
  
  Recommended: select Custom permissions, and be sure to select these two roles: View all Projects and View Nodes.
4. Create an API key.
  
  Go to API & Keys and create a key either for your specific account (enter your cluster name) or for all clusters (enter No scope). For security reasons, we recommend selecting the first option.
  
  Newly created keys display four fields. Make sure to use the content of the field called Bearer token to set up the connection to the Kubernetes API described in the next section.
In the Dynatrace menu, go to Kubernetes and select Connect manually.
On the Kubernetes cluster connection settings page, provide a Name, the Kubernetes API URL, and the Bearer token for the Kubernetes cluster.

For Rancher distributions, you need the bearer token that was created in the Rancher web UI, as described in Special instructions for Rancher distributions to get the API URL and the bearer token above.
Select Save changes.

Other Options

If you can't use Dynatrace Operator, you can deploy ActiveGate directly as a StatefulSet (not recommended).
If you want to monitor several Kubernetes clusters with one ActiveGate and don't need to separate networks for administrative or operational traffic, you can install an ActiveGate on a virtual machine using a conventional installer.

Dynatrace recommends to use the containerized ActiveGate for Kubernetes API monitoring

Frequently asked questions

Can I change settings for Kubernetes API monitoring?

You can change Kubernetes cluster connection and monitoring settings at any time from your Kubernetes cluster details page.

In the Dynatrace menu, go to Kubernetes.
Find your Kubernetes cluster, and then select Actions > Settings.
Adjust your settings, and then select Save changes.

How can I delete the Kubernetes monitoring configuration for a Kubernetes cluster?

To delete the connection to a local Kubernetes API endpoint

In the Dynatrace menu, go to Kubernetes.
Find your Kubernetes cluster, and then select Actions > Settings.
Select Use defaults, and then select Save changes.

When does the ActiveGate get updated?

ActiveGate is updated automatically on pod restart whenever there is a new version available, unless the image version is specified in cr.yaml.