About gke-observability
gke-observability is a reference for configuring monitoring, logging, and metrics on GKE clusters. It is for teams diagnosing cluster and workload health, and covers golden-path defaults, Managed Prometheus, and control-plane monitoring.
Key features
- 01Explain golden-path monitoring and logging settings
- 02Collect and query metrics with Managed Prometheus
- 03Describe control-plane metrics and enablement requirements
- 04Query GKE cluster logs
- 05Guide diagnosis of API server and scheduling issues
Use cases
- 01Inspect cluster and workload metrics
- 02Investigate control-plane latency or scheduling failures
- 03Query metrics with PromQL or Metrics Explorer
- 04Analyze cluster logs and API server requests
MCP support
The skill lists MCP tools for retrieving cluster information, Kubernetes events, logs, and resource details. Updating monitoring settings and reading Cloud Logging logs are CLI-only.
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ google/ skills --skill gke-observabilityAfter installing, type/gke-observabilityin Claude Code to confirm it loaded.
Bundled filesreferences/attribution.md
Details
From the project READMEGKE Observability
This reference covers monitoring, logging, and metrics configuration for GKE. The golden path enables comprehensive observability including control-plane metrics.
MCP Tools:
get_cluster,list_k8s_events,get_k8s_logs,get_k8s_cluster_info,describe_k8s_resource. CLI-only:gcloud container clusters update --monitoring=...,gcloud logging read
Attribution
MUST READ: Before executing any gcloud, REST API, or MCP command, you
MUST read Usage Attribution. For commands executed
directly in the terminal (never in generated scripts, Terraform, or user code),
prefix gcloud with
CLOUDSDK_METRICS_REQUEST_ATTRIBUTION="agent-skills/1.0 (skill:gke-observability)"
and append agent-skills/1.0 (skill:gke-observability) to User-Agent headers.
Golden Path Observability Defaults
| Setting | Golden Path Value | Notes |
|---|---|---|
loggingConfig components | SYSTEM_COMPONENTS, WORKLOADS | Full workload logging |
monitoringConfig components | SYSTEM_COMPONENTS, STORAGE, POD, DEPLOYMENT, STATEFULSET, DAEMONSET, HPA, JOBSET, CADVISOR, KUBELET, DCGM, APISERVER, SCHEDULER, CONTROLLER_MANAGER | Full suite including control-plane |
managedPrometheusConfig.enabled | true | Google-managed Prometheus |
advancedDatapathObservabilityConfig.enableMetrics | true | Dataplane V2 flow metrics |
loggingService | logging.googleapis.com/kubernetes | Cloud Logging |
monitoringService | monitoring.googleapis.com/kubernetes | Cloud Monitoring |
Control-Plane Metrics (Golden Path Addition)
The golden path adds three control-plane monitoring components not present in default clusters:
| Component | What It Monitors |
|---|---|
APISERVER | API server request latency, error rates, admission webhook performance |
SCHEDULER | Scheduling latency, pending pods, scheduling failures |
CONTROLLER_MANAGER | Controller work queue depth, reconciliation latency |
These are critical for diagnosing cluster-level issues (slow API responses, scheduling delays, stuck controllers).
When recommending any control-plane metric below, always state that it is a
Managed Service for Prometheus (GMP) metric that requires explicit enabling
(--monitoring=SYSTEM,API_SERVER,... and --enable-managed-prometheus) and
link to
https://docs.cloud.google.com/kubernetes-engine/docs/how-to/control-plane-metrics:
- API storage utilization by resource
(
apiserver_resource_size_estimate_bytes): Useapiserver_resource_size_estimate_bytes(grouped bygroupandresource) to identify which Kubernetes resource types consume the most API server storage bytes in etcd, complementing object counts (apiserver_storage_objects) and total database size (apiserver_storage_size_bytes). - Admission webhook latency and timeouts
(
apiserver_admission_webhook_admission_duration_seconds): When API calls time out or fail and mutating or validating admission webhooks are suspected, query the opt-in GMP metricapiserver_admission_webhook_admission_duration_seconds(grouped byname,type,operation, andrejected) to pinpoint slow or failing webhooks; also inspectValidatingWebhookConfiguration/MutatingWebhookConfigurationtimeoutSeconds,failurePolicy,namespaceSelectorexclusions (such askube-system), and backing webhook Service/Pod health.
Enabling Full Monitoring
Say this whenever you hand over a --monitoring command:
- Control-plane metrics are NOT enabled by default. State this outright in
your answer — do not leave it implied by the fact that you are supplying an
enable command.
API_SERVER,SCHEDULER, andCONTROLLER_MANAGERare off on every new cluster and collect nothing until explicitly turned on, and the same is true ofDCGM,CADVISOR,KUBELET, and kube-state (POD,DEPLOYMENT,STATEFULSET,DAEMONSET,HPA,STORAGE,JOBSET).SYSTEMis the only package on by default. A user asking "why are there no API server metrics" has almost always simply never enabled them. - The flag replaces, it does not append. The set supplied to
--monitoringoverrides the previous setting entirely, so omitting a component silently turns it off. Always pass the full desired list, and always includeSYSTEM— it cannot be disabled while monitoring is on, and never on Autopilot. - These metrics bill per sample ingested via Managed Service for Prometheus. Enabling the full suite on a large cluster is a real cost increase; mention it rather than presenting the list as free.
The gcloud flag and the API field use different spellings for the same components. Do not copy names between them:
Component gcloud --monitoring=monitoringConfigAPI enumSystem SYSTEMSYSTEM_COMPONENTSAPI server API_SERVERAPISERVERController mgr CONTROLLER_MANAGERCONTROLLER_MANAGERThe remaining components share a spelling. Using an API enum in the CLI flag (or the reverse) fails the command — this is a common and confusing error.
# Enable golden path monitoring suite
gcloud container clusters update <CLUSTER_NAME> --region <REGION> \
--monitoring=SYSTEM,API_SERVER,SCHEDULER,CONTROLLER_MANAGER,STORAGE,POD,DEPLOYMENT,STATEFULSET,DAEMONSET,HPA,JOBSET,CADVISOR,KUBELET,DCGM \
--quiet
# Enable Managed Prometheus
gcloud container clusters update <CLUSTER_NAME> --region <REGION> \
--enable-managed-prometheus \
--quiet
# Enable Dataplane V2 observability metrics
gcloud container clusters update <CLUSTER_NAME> --region <REGION> \
--enable-dataplane-v2-flow-observability \
--quiet
Managed Prometheus
Golden path enables Google Managed Prometheus for metrics collection and querying.
Querying metrics:
- Use Cloud Monitoring Metrics Explorer in the console
- Use PromQL via the Prometheus UI or API
- Grafana dashboards via Managed Grafana
Key GKE metrics:
| Metric | Source | Use |
|---|---|---|
container_cpu_usage_seconds_total | cAdvisor | Pod CPU usage |
container_memory_working_set_bytes | cAdvisor | Pod memory usage |
kube_pod_status_phase | kube-state-metrics | Pod lifecycle |
apiserver_request_duration_seconds | API Server | Control plane latency |
scheduler_scheduling_attempt_duration_seconds | Scheduler | Scheduling performance |
kubernetes.io/node/cpu/core_usage_time | Cloud Monitoring | Node CPU |
DCGM_FI_DEV_GPU_UTIL | DCGM | GPU utilization |
Live Resource Usage (kubectl-only)
No MCP or gcloud equivalent exists for live resource usage. Use kubectl top:
kubectl top pods --all-namespaces --sort-by=cpu
kubectl top nodes
kubectl top pods --containers -n <NAMESPACE> # per-container breakdown
Cloud Logging (gcloud-only)
Querying cluster logs (no MCP equivalent — use gcloud logging read):
# System component logs
gcloud logging read \
'resource.type="k8s_cluster" AND resource.labels.cluster_name="<CLUSTER_NAME>"' \
--project <PROJECT_ID> --limit 50 \
--quiet
# Workload logs for a specific namespace
gcloud logging read \
'resource.type="k8s_container" AND resource.labels.cluster_name="<CLUSTER_NAME>" AND resource.labels.namespace_name="<NAMESPACE>"' \
--project <PROJECT_ID> --limit 50 \
--quiet
# Audit logs (who did what)
gcloud logging read \
'resource.type="k8s_cluster" AND logName:"cloudaudit.googleapis.com"' \
--project <PROJECT_ID> --limit 50 \
--quiet
Diagnostic Settings
For security monitoring and troubleshooting, enable control-plane audit logs:
# View current logging config
gcloud container clusters describe <CLUSTER_NAME> --region <REGION> \
--format="yaml(loggingConfig)" \
--quiet
Control-Plane Component Logs & Slow Request Traces
kube-apiserver component logs (API_SERVER) are an optional feature that is
not enabled by default and must be explicitly turned on
(--logging=SYSTEM,WORKLOADS,API_SERVER); always mention this and link to
https://docs.cloud.google.com/kubernetes-engine/docs/how-to/view-logs#control_plane_logs
when recommending apiserver log analysis.
To diagnose which specific kube-apiserver requests were slow and why:
- Search for
traceorTraceentries: Queryapiservercomponent logs (resource.type="k8s_control_plane_component" AND resource.labels.component_name="apiserver") fortraceorTrace(for example,textPayload:"Trace["). - How to interpret trace logs:
kube-apiserveruses the upstreamk8s.io/utils/tracepackage (trace.go) to log requests that exceed a latency threshold (typically 500ms). Each trace header records the operation ("List","Get","Create","Patch"),url,user-agent,audit-id,clientIP, start timestamp, andtotal time. Below the header, nested sub-traces appear in brackets[...]and sequential steps exceeding the step threshold appear as---"<StepName>" <duration>ms. - Example trace logs for typical problems:
- Slow etcd / storage read or write (
List(recursive=true) etcd3orGuaranteedUpdate etcd3dominatestotal time):I1015 11:36:56.835120 10 trace.go:236] Trace[123456789]: "List" url:/api/v1/pods,user-agent:my-controller/v1.0.0,audit-id:11111111-2222-3333-4444-555555555555,client:10.0.0.1 (15-Oct-2026 11:36:49.460) (total time: 7374ms): Trace[123456789]: ["List(recursive=true) etcd3" 6890ms (11:36:49.461)] Trace[123456789]: ---"Objects listed" 6891ms (11:36:56.352) Trace[123456789]: ---"SerializeObject" 480ms (11:36:56.832) - Slow client / response streaming bottleneck (
"Objects listed"is fast, but"SerializeObject"and---"Write call succeeded"or---"Write call failed"dominatetotal timebecause a slow or bandwidth-constrained client takes seconds to read a large response payload):I1015 11:40:12.104512 10 trace.go:236] Trace[987654321]: "List" url:/api/v1/pods,user-agent:slow-watcher/v0.1,audit-id:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee,client:10.0.0.2 (15-Oct-2026 11:40:01.002) (total time: 11102ms): Trace[987654321]: ---"Objects listed" 45ms (11:40:01.047) Trace[987654321]: ["SerializeObject" 11055ms (11:40:01.047)] Trace[987654321]: ---"Write call succeeded" 11054ms (11:40:12.101)
- Slow etcd / storage read or write (
- Upstream documentation & future evolution (always cite both): Always
link to https://github.com/kubernetes/utils/blob/master/trace/README.md as
the upstream OSS documentation for
trace.go, and mention https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/647-apiserver-tracing (KEP-647: APIServer Tracing) as a possible future change to howkube-apiservertraces are generated (via OpenTelemetry).
Identifying Heavy API Server Clients from HTTP Access Logs
To identify which clients are generating the most load on kube-apiserver,
analyze the httplog.go HTTP access entries in apiserver component logs (an
optional feature that must be explicitly enabled via
--logging=SYSTEM,WORKLOADS,API_SERVER; always state this and link to
https://docs.cloud.google.com/kubernetes-engine/docs/how-to/view-logs#control_plane_logs):
- Very stable
httplog.golog structure (always mention this stability and show an example log line): Explicitly advise the user that the structure ofkube-apiserverhttplog.gologs is very stable across Kubernetes releases (making regex extraction and Log Analytics queries reliable), and include this example log line:I1015 11:36:56.835535 10 httplog.go:137] "HTTP" verb="GET" URI="/api/v1/namespaces/default/pods" latency="7.374935s" userAgent="my-controller/v1.0.0 (linux/amd64)" audit-ID="11111111-2222-3333-4444-555555555555" srcIP="10.0.0.1:12345" apf_pl="workload-low" apf_fs="everybody" apf_iseats=1 apf_fseats=0 apf_additionalLatency="0s" apf_execution_time="7.374765s" resp=200 - Key fields for client load analysis:
user_agent(userAgentin raw log text): Identifies the client binary, controller, or operator issuing the requests.verb: Distinguishes expensive request types (such as cluster-wideLISTor mutatingPATCH/UPDATEcalls) from lightweightGETcalls.apf_iseats(along withapf_fseatsandapf_execution_time): Reports the API Priority and Fairness (APF) initial concurrency seats occupied by the request; weighting or summingapf_iseats * apf_execution_timebyuser_agentandverbreveals which clients consume the most API server concurrency capacity.
Alerting
Set up alerts for critical conditions:
| Condition | Metric | Threshold |
|---|---|---|
| High API server latency | apiserver_request_duration_seconds | P99 > 5s |
| Pod crash loops | kube_pod_container_status_restarts_total | > 5 in 10min |
| Node not ready | kube_node_status_condition | condition=Ready, status!=True |
| High GPU utilization | DCGM_FI_DEV_GPU_UTIL | > 95% sustained |
| PVC near capacity | kubelet_volume_stats_used_bytes / capacity | > 85% |
| Scheduling failures | scheduler_schedule_attempts_total{result="error"} | > 0 |
Prerequisite: The
kube_*series above (e.g.,kube_pod_status_phase,kube_pod_container_status_restarts_total,kube_node_status_condition) come from kube-state-metrics, which GKE does not collect by default. Deploy the Managed Prometheus kube-state-metrics package first.
Proposing Dashboards & Alerts (Production Rules)
When designing or proposing alerting and dashboard strategies for GKE:
- Always explicitly name Google Cloud Monitoring as the platform to implement these alerts and dashboards.
- Always include API server latency (via
apiserver_request_duration_secondsmetric) on the dashboard as a critical indicator of control plane health, alongside node CPU/Memory and pod crash loops.
Node Health (Production Rules)
A comprehensive assessment of node health relies on analyzing these two metrics together:
kubernetes.io/node/status_condition(filtered bystatus_condition="Ready"): Use this to track healthy nodes. Note that it will only report values for nodes that have successfully bootstrapped.compute.googleapis.com/instance_group/size(filtered byinstance_group_name="gke-<cluster_name>-.*"): Use this to track the total number of nodes in a specific cluster. Note that it does not differentiate between healthy and unhealthy nodes.
Control Plane Health (Production Rules)
To check whether Google considers a GKE cluster's control plane healthy, use the
kubernetes.io/cluster/kcp_healthchecks system metric (on the k8s_cluster
monitored resource, included in the default SYSTEM metrics package):
- Metric semantics:
kubernetes.io/cluster/kcp_healthchecksis an incremental (DELTA/CUMULATIVEcounter) metric sampled every 60 seconds that counts Google-internal control plane probes, labeled by booleansuccess("true"or"false"). - Charting health ratio: Because the metric is an incremental counter
rather than a boolean gauge, chart control plane availability by dividing
the rate of successful checks (
success="true") by the overall rate of checks across allsuccessvalues:
sum by (project_id, location, cluster_name) (
rate(
kubernetes_io:cluster_kcp_healthchecks{
monitored_resource="k8s_cluster", success="true"
}[5m]
)
)
/
sum by (project_id, location, cluster_name) (
rate(
kubernetes_io:cluster_kcp_healthchecks{
monitored_resource="k8s_cluster"
}[5m]
)
)
Cost Considerations
Monitoring and logging have associated costs:
- Cloud Logging: Charged per GiB ingested beyond free tier (50 GiB/project/month)
- Cloud Monitoring: Free for GKE system metrics; custom metrics charged per time series
- Managed Prometheus: Charged per samples ingested
To reduce costs in non-production:
# Reduce to system-only monitoring
gcloud container clusters update <CLUSTER_NAME> --region <REGION> \
--monitoring=SYSTEM \
--quiet
Distributed Tracing & Continuous Profiling (Recommended)
Not golden path defaults — recommended for production microservice architectures and performance-sensitive workloads.
- Cloud Trace: Add OpenTelemetry SDK to your app with the
opentelemetry-operations-go(or equivalent) exporter. Traces appear in Cloud Trace console. Identifies cross-service latency bottlenecks. - Cloud Profiler: Add the Cloud Profiler agent to your app. Profiles CPU and memory usage in production with low overhead. Identifies hotspots and compares across versions.
Recent additions:
- Managed OpenTelemetry for GKE (Preview): Managed in-cluster OTLP
endpoint plus auto-instrumentation for traces, metrics, and logs. Requires
GKE 1.34.1-gke.2178000+; enable with
gcloud beta container clusters update ... --managed-otel-scope=COLLECTION_AND_INSTRUMENTATION_COMPONENTS. - PSI (Pressure Stall Information) metrics: cAdvisor
container_pressure_{cpu,memory,io}_{waiting,stalled}_seconds_totalseries (beta in Kubernetes 1.34) can be collected via a Managed PrometheusClusterNodeMonitoringresource; GKE's documented collection path requires GKE 1.35+.
LQL Query Examples
Common Logging Query Language patterns for GKE troubleshooting:
# Error logs for a specific container
resource.type="k8s_container" AND resource.labels.container_name="my-app" AND severity>=ERROR
# OOMKilled events
resource.type="k8s_event" AND jsonPayload.reason="OOMKilling"
# Pod scheduling failures
resource.type="k8s_event" AND jsonPayload.reason="FailedScheduling"
# Audit logs (who did what)
resource.type="k8s_cluster" AND logName:"cloudaudit.googleapis.com"
Troubleshooting Managed Prometheus (GMP)
Diagnose GMP ingestion, rule, and query problems. Stay read-only (kubectl get
/ describe / logs) and propose config changes; do not mutate live resources
directly.
First: split ingestion-side vs query-side
Before anything else, query the up metric in the Metrics Explorer PromQL
tab in Cloud Monitoring. If up returns data, ingestion works and the problem
is query-side (Grafana / PromQL / permissions). If up is empty, the problem is
ingestion-side (collectors, scrape config, or write permission).
Ingestion-side
-
Check GMP system pods. They run in
gmp-systemon Standard clusters andgke-gmp-systemon Autopilot. Look forgmp-operator,collector(DaemonSet), andrule-evaluatornotRunningor with high restarts:kubectl get pods -n gmp-system # gke-gmp-system on Autopilot kubectl logs -n gmp-system -l app.kubernetes.io/name=collector -c prometheusA collector in
CrashLoopBackOffwithOOMKilledusually means high metric cardinality - drop unneeded series/labels (see cost section below) or apply a VPA to the collector. -
Check PodMonitoring / ClusterPodMonitoring. The three classic mistakes:
spec.selector.matchLabelsdoes not match the target Pod labels.- A
PodMonitoringonly discovers targets in its own namespace - useClusterPodMonitoringfor cluster-wide scope. spec.endpoints.portmust reference the named container port (e.g.port: web), not the port number.
-
Enable target status for scrape errors. Propose patching
OperatorConfigingmp-publicwithfeatures.targetStatus.enabled: true; once applied,kubectl describe podmonitoring <name>and readActive Targets,Unhealthy Targets, andLast Error(for exampleconnection refused, HTTP 404,context deadline exceeded). Disable it again when done - it can OOM the operator on large clusters.
Permissions (403 / no data written)
GMP components inherit the node service account. Ingestion needs
roles/monitoring.metricWriter (error Permission monitoring.timeSeries.create denied in collector logs); the rule-evaluator and query paths need
roles/monitoring.viewer (403 / PermissionDenied). If a query app (like
Grafana) uses Workload Identity, the bound Google service account also needs
roles/monitoring.viewer.
Rule and alert evaluation
Rule scope is decided by the resource kind: Rules (single namespace),
ClusterRules (whole cluster), and GlobalRules (all data in the metrics
scope). You must use GlobalRules to write rules against Cloud Monitoring
metrics - a Rules/ClusterRules resource silently returns no data for them.
Check rule-evaluator logs (-c evaluator) for parse/permission errors.
Query-side (Grafana / PromQL)
- Data source must point at the GMP frontend query proxy, not
localhost:9090, and the HTTP Method must be GET -POSTfails withno match[] parameter provided. - Grafana template variables: use the two-argument form
label_values(<metric>, <label>); the single-argumentlabel_values(<label>)is not supported by the GMP API. - Cloud Monitoring metrics that exist for multiple resource types need a
monitored_resourcelabel matcher, otherwise the query fails withseries selector must specify a label matcher on monitored resource name.
Cost, cardinality, and quota
Use the Cloud Monitoring Metrics Management page to find the metrics driving
billable samples and high cardinality. Reduce them with metricRelabeling in
the PodMonitoring (action: drop for whole metrics, action: labeldrop for
unbounded labels like user_id/request_id) or by raising the scrape
interval. 429 / RESOURCE_EXHAUSTED errors mean you have hit the Cloud
Monitoring API ingestion or query quota - optimize first, then request a quota
increase.