From 677f401cacf1351ace07423c2cd1f3fd23a19ed7 Mon Sep 17 00:00:00 2001 From: jimmychiuuuu Date: Mon, 20 Jul 2026 21:22:44 +0000 Subject: [PATCH] docs: document supportability metrics and GKE monitoring in README --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 5e11cbc..c1d517c 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,19 @@ spec: ``` Inside this container, `/dev/tpmrm0` will be available. +## Monitoring + +Applying the Prometheus monitoring manifest allows you to observe the device plugin status: + +```bash +kubectl apply -f manifests/cc-device-plugin-pod-monitoring.yaml +``` + +You can view the metrics in the [Cloud Monitoring Metrics Explorer](https://console.cloud.google.com/monitoring/metrics-explorer) using PromQL, for example to see CPU usage: +```promql +rate(process_cpu_seconds_total[5m]) +``` + [dp]: https://kubernetes.io/docs/concepts/cluster-administration/device-plugins/ [k8s]: https://kubernetes.io [tpm]: https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#vtpm