Mappatura delle metriche di Cloud Monitoring a PromQL

Puoi utilizzare Prometheus Query Language (PromQL) per eseguire query su tutte le metriche archiviate da Cloud Monitoring, incluse le metriche di sistema di Google Cloud, le metriche Kubernetes, metriche personalizzate e metriche basate su log.

Mappatura dei nomi delle metriche di Cloud Monitoring a PromQL

I nomi delle metriche di Cloud Monitoring includono due componenti, un dominio (ad esempio compute.googleapis.com/) e un percorso (ad esempio instance/disk/max_read_ops_count). Poiché PromQL supporta solo i caratteri speciali : e _, devi prima rendere i nomi delle metriche di Monitoring compatibili con PromQL. Per mappare i nomi delle metriche di Monitoring a PromQL, applica le seguenti regole:

  • Sostituisci la prima / con :.
  • Sostituisci tutti gli altri caratteri speciali (inclusi . e altri caratteri /) con _.

La seguente tabella elenca alcuni nomi di metriche e i relativi equivalenti PromQL:

Nome metrica di Cloud Monitoring Nome metrica PromQL
kubernetes.io/container/cpu/limit_cores kubernetes_io:container_cpu_limit_cores
compute.googleapis.com/instance/cpu/utilization compute_googleapis_com:instance_cpu_utilization
logging.googleapis.com/log_entry_count logging_googleapis_com:log_entry_count
custom.googleapis.com/opencensus/opencensus.io/
http/server/request_count_by_method
custom_googleapis_com:opencensus_opencensus_io_
http_server_request_count_by_method
agent.googleapis.com/disk/io_time agent_googleapis_com:disk_io_time

Puoi eseguire query sulle metriche con valori di distribuzione di Cloud Monitoring come gli istogrammi di Prometheus, con il suffisso _count, _sum o _bucket aggiunto al nome della metrica:

Nome metrica di Cloud Monitoring Nomi delle metriche PromQL
networking.googleapis.com/vm_flow/rtt networking_googleapis_com:vm_flow_rtt_sum
networking_googleapis_com:vm_flow_rtt_count
networking_googleapis_com:vm_flow_rtt_bucket

Specifica di un tipo di risorsa monitorata

Quando una metrica è associata a un solo tipo di risorsa monitorata di Cloud Monitoring, le query PromQL funzioneranno senza specificare manualmente un tipo di risorsa. Tuttavia, alcune metriche all'interno di Cloud Monitoring, incluse alcune metriche di sistema e molte di quelle generate dalle metriche basate su log, sono mappate a più di un tipo di risorsa.

Per vedere quali tipi di risorsa monitorata corrispondono a una metrica, procedi in uno dei seguenti modi:

  • Per le metriche selezionate da Google, puoi consultare gli elenchi delle metriche disponibili, tra cui le metriche di Google Cloud e le metriche Kubernetes. Ogni voce della documentazione elenca i tipi di risorsa monitorata associati nella prima colonna di ogni voce al di sotto del tipo. Se non viene indicato alcun tipo di risorsa monitorata, la metrica può essere associata a qualsiasi tipo.
  • In Metrics Explorer, puoi:

    1. Inserisci il nome della metrica nel campo Seleziona una metrica e poi naviga tra i menu per selezionarla. Il menu delle risorse elenca i tipi di risorse validi per la metrica, ad esempio "Istanza VM".
    2. Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è  MQL o  PromQL.
    3. Verifica che sia selezionato MQL nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.

      La query visualizzata mostra il tipo di risorsa. In particolare, MQL è utile per le metriche che possono essere associate a molti tipi di risorsa monitorata, ad esempio metriche basate su log, metriche personalizzate o qualsiasi metrica definita dall'utente.

Se una metrica è associata a più di un tipo di risorsa, devi specificare il tipo di risorsa nella query PromQL. Esiste un'etichetta speciale, monitored_resource, che puoi utilizzare per selezionare il tipo di risorsa.

I tipi di risorse monitorate sono nella maggior parte dei casi una stringa breve, come gce_instance, ma a volte vengono visualizzati come URI completi, ad esempio monitoring.googleapis.com/MetricIngestionAttribution. Le query PromQL con formato corretto potrebbero avere il seguente aspetto:

  • logging_googleapis_com:byte_count{monitored_resource="k8s_container"}
  • custom_googleapis_com:opencensus_opencensus_io_http_server_request_count_by_method{monitored_resource="global"}
  • loadbalancing_googleapis_com:l3_external_egress_bytes_count{monitored_resource="loadbalancing.googleapis.com/ExternalNetworkLoadBalancerRule"}

Il valore "" per l'etichetta monitored_resource è speciale e si riferisce al tipo di risorsa prometheus_target predefinito utilizzato per le metriche di Managed Service per Prometheus.

Se non utilizzi l'etichetta monitored_resource quando è necessaria, viene visualizzato il seguente errore:

metric is configured to be used with more than one monitored resource type; series selector must specify a label matcher on monitored resource name

Utilizzo delle etichette dei metadati

Puoi utilizzare le etichette di metadati in PromQL come qualsiasi altra etichetta, ma, come i nomi delle metriche, anche le etichette dei metadati devono essere rese compatibili con PromQL. La sintassi per fare riferimento a un'etichetta di sistema di metadati version è metadata_system_version, mentre la sintassi per l'etichetta utente di metadati version è metadata_user_version. Le query PromQL strutturate in modo corretto utilizzando etichette di metadati potrebbero avere il seguente aspetto:

  • compute_googleapis_com:instance_cpu_utilization{monitored_resource="gce_instance",metadata_user_env="prod"}
  • sum(compute_googleapis_com:instance_cpu_utilization) by (metadata_system_region)

L'unico carattere speciale che puoi utilizzare nelle chiavi delle etichette dei metadati è il carattere _. L'aggregazione mediante etichette di metadati con il tipo MULTI_STRING o KEY_VALUE non è supportata.

Risolvere i conflitti tra le etichette

In Cloud Monitoring, le etichette possono appartenere alla metrica o alla risorsa. Se l'etichetta di una metrica ha lo stesso nome di chiave di un'etichetta di risorsa, puoi fare riferimento all'etichetta della metrica in modo specifico aggiungendo il prefisso metric_ al nome della chiave dell'etichetta nella query.

Ad esempio, supponi di avere un'etichetta di risorsa e un'etichetta di metrica denominate pod_name nella metrica example.googleapis.com/user/widget_count.

  • Per filtrare in base al valore dell'etichetta della risorsa, utilizza
    example_googleapis_com:user_widget_count{pod_name="RESOURCE_LABEL_VALUE"}

  • Per filtrare in base al valore dell'etichetta della metrica, utilizza
    example_googleapis_com:user_widget_count{metric_pod_name="METRIC_LABEL_VALUE"}