Get deep insights into your OpenShift control plane using metrics exposed by various control plane components.
This is an extension for monitoring the OpenShift control plane. It comes with an out-of-the-box dashboard and pre-configured alerts for easiness of use. It requires metrics already ingested into Dynatrace via Prometheus integration. Follow the steps in the setup section for proper setup of this extension.
Follow the steps to install the OpenShift control plane extension.
In your Dynatrace environment, go to Kubernetes, edit your Kubernetes cluster settings, and turn on Enable monitoring and Monitor annotated Prometheus exporters. For more information see our official documentation.
To ingest metrics exposed by the OpenShift control plane, the related services need to be annotated with specific Dynatrace annotations. Based on the used OpenShift version, the YAML files referenced in the commands below define a default set of annotations, enabling the ingestion of all metrics used by the OpenShift control plane extension. Before executing any of the instructions below, ensure your kubectl is configured to use the Kubernetes cluster you want to monitor. If the default set of annotations fits your needs, use the corresponding instructions below. Otherwise, download the files first and adapt them accordingly.
kubectl apply -f https://raw.githubusercontent.com/dynatrace-extensions/kubernetes-control-plane/main/scripts/control-plane-monitoring-annotations-ocp4.yaml
kubectl apply -f https://raw.githubusercontent.com/dynatrace-extensions/kubernetes-control-plane/main/scripts/control-plane-monitoring-annotations-ocp3.yaml
After some minutes, you can verify if everything works as expected by finding control plane related metrics using Dynatrace metrics browser.
kube_pod_status_ready is one of the metrics to search for.
For troubleshooting and further annotation methods, see Monitor Prometheus metrics in Dynatrace documentation.
To add this extension to your environment click Add to environment on the page of this extension in the Dynatrace Hub. After activating the extension, select Dashboards in Dynatrace. You should now find an out-of-the-box OpenShift control plane dashboard.
Additionally, the extension comes with multiple pre-configured metric events for alerting. To activate them:
From the Dynatrace navigation menu, select Settings > Anomaly detection > Metric events.
Find the following events
If necessary, select the Edit button to customize the event conditions.
Move the switch next an event to the On position to activate it.
As metric ingest is subject to DDU consumption, it is important to stop it by removing the annotations from the related services. If you followed the instructions described in the "Start ingesting control plane metrics" section, you can use kubectl to remove the annotations, by referencing the previously applied file in a
kubectl delete -f command, as shown below for the default YAML files. Before executing any of the instructions below, ensure your kubectl is configured to use the right Kubernetes cluster.
kubectl delete -f https://raw.githubusercontent.com/dynatrace-extensions/kubernetes-control-plane/main/scripts/control-plane-monitoring-annotations-ocp4.yaml
kubectl delete -f https://raw.githubusercontent.com/dynatrace-extensions/kubernetes-control-plane/main/scripts/control-plane-monitoring-annotations-ocp3.yaml
To remove the out-of-the-box dashboard and alerts, deactivate the extension via the Dynatrace Hub.
Extend the platform,
empower your team.