Questo documento spiega come utilizzare l'API Cloud Monitoring per ottenere elenchi o descrizioni di quanto segue:
- Tipi di metriche definite dall'utente definiti nel progetto.
- Tipi di metriche di terze parti con dati delle serie temporali nel tuo progetto.
Le metriche generate da BindPlane sono esempi di metriche di terze parti. Le metriche BindPlane
hanno il prefisso
workload.googleapis.com/3rd-party-app-name/
. Per un elenco completo delle metriche delle applicazioni di terze parti supportate, consulta la documentazione sulle origini di BindPlane. - Tipi di metriche integrate fornite da Google Cloud. Questi tipi di metriche sono utili per progettare le metriche definite dall'utente. Puoi trovare informazioni su queste metriche anche nella documentazione, consulta la sezione Elenco delle metriche.
- Tipi di risorse monitorate disponibili per il tuo progetto. Puoi anche trovare informazioni su queste risorse nella documentazione; vedi Elenco delle risorse monitorate.
Per eseguire i metodi senza scrivere alcun codice, gli esempi nelle schede Protocollo di questa pagina utilizzano Explorer API basato su moduli. Per ulteriori informazioni su questo strumento, consulta Explorer API.
Per scoprire come usare i metodi dei linguaggi di programmazione selezionati, consulta gli esempi di codice eseguibili in questa pagina.
Prima di iniziare
- Per un'introduzione alle metriche e alle risorse monitorate, consulta Metriche, serie temporali e risorse.
Elenco dei descrittori delle metriche
I descrittori delle metriche sono gli schemi che definiscono le metriche. Per trovare i dettagli sulle metriche di tuo interesse, sfoglia i descrittori delle metriche disponibili:
- Metriche integrate: puoi inviare richieste API a qualsiasi progetto esistente oppure puoi utilizzare la documentazione relativa agli elenchi delle metriche.
- Metriche definite dall'utente ed esterne: devi inviare la richiesta API a un progetto in cui è definita la metrica definita dall'utente o in cui esistono dati delle serie temporali per la metrica.
Per ulteriori informazioni su come vengono denominati i tipi di metriche, consulta Convenzioni di denominazione.
Elenca tipi di metriche
Per ottenere un elenco aggiornato dei descrittori delle metriche, utilizza il metodo metricDescriptors.list
.
Per restringere l'insieme dei tipi di metriche restituiti, utilizza un filtro.
Per decidere quali tipi di metriche cercare, consulta Tipi di valore e tipi di metriche.
Protocollo
Apri la pagina di riferimento di
metricDescriptors.list
.Nel riquadro denominato Prova questo metodo, inserisci quanto segue:
- nome:
projects/PROJECT_ID
. SostituisciPROJECT_ID
con l'ID del tuo progetto Google Cloud. - filtro:
metric.type = starts_with("compute.googleapis.com")
- nome:
Fai clic su Execute (Esegui).
La seguente risposta di esempio mostra alcuni descrittori della metrica recuperati:
"metricDescriptors": [ { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_bytes_count", "labels": [{...}], ... "description": "Count of incoming bytes dropped by the firewall.", "displayName": "Dropped bytes", "type": "compute.googleapis.com/firewall/dropped_bytes_count", ... }, { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [{...}], ... "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }, ... ]
Il valore type
in ogni descrittore identifica il descrittore della metrica, ad esempio compute.googleapis.com/firewall/dropped_packets_count
. Questo valore
a volte è chiamato anche "tipo di metrica" o
"nome del tipo di metrica".
Per visualizzare la richiesta come comando curl
, come richiesta HTTP o in JavaScript, fai clic su fullscreen Schermo intero in Explorer API.
C#
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta la sezione Risoluzione dei problemi relativi alle chiamate API.
Ottieni descrittori della metrica
Per ottenere informazioni su un singolo tipo di metrica, utilizza il metodo metricDescriptors.get
.
Questo metodo restituisce un descrittore della metrica.
Per recuperare un descrittore della metrica specifico, devi fornire il nome completo della metrica all'API. Il nome completo viene creato a partire da due componenti:
- Un prefisso composto da
projects/PROJECT_ID/metricDescriptors
. - Il valore
type
che identifica il descrittore della metrica, ad esempiocompute.googleapis.com/firewall/dropped_packets_count
. Per saperne di più sul valoretype
, consulta la scheda Protocollo in Elenca tipi di metriche.
Di seguito è riportato un esempio del nome completo di una metrica:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Protocollo
Per ottenere il descrittore per la metrica /firewall/dropped_packets_count
di Compute Engine:
Apri la pagina di riferimento di
metricDescriptors.list
.Nel riquadro denominato Prova questo metodo, inserisci quanto segue:
nome:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Sostituisci
PROJECT_ID
con l'ID del tuo progetto Google Cloud.
Fai clic su Execute (Esegui).
La seguente risposta di esempio mostra il descrittore della metrica:
{ "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [ { "key": "instance_name", "description": "The name of the VM instance." } ], "metricKind": "DELTA", "valueType": "INT64", "unit": "1", "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }
Per visualizzare la richiesta come comando curl
, come richiesta HTTP o in JavaScript, fai clic su fullscreen Schermo intero in Explorer API.
C#
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta la sezione Risoluzione dei problemi relativi alle chiamate API.
Elenco delle risorse monitorate
Le risorse monitorate sono entità cloud che possono essere monitorate. Per trovare i tipi di entità che dispongono di metriche, sfoglia l'elenco dei tipi di risorsa monitorata.
Per ottenere informazioni sulle risorse monitorate, puoi inviare richieste API a qualsiasi progetto esistente oppure puoi utilizzare la documentazione relativa all'elenco delle risorse monitorate.
Elenco tipi di risorse
Per ottenere un elenco aggiornato dei tipi di risorsa monitorata dall'API Monitoring, utilizza il metodo monitoredResourceDescriptors.list
e fornisci il tuo ID progetto.
Protocollo
Apri la pagina di riferimento
monitoredResourceDescriptors.list
.Nel riquadro denominato Prova questo metodo, inserisci quanto segue:
- nome:
projects/PROJECT_ID
. SostituisciPROJECT_ID
con l'ID del tuo progetto Google Cloud.
- nome:
Fai clic su Execute (Esegui).
La seguente risposta di esempio mostra alcuni dei tipi di risorsa monitorata restituiti:
{ "resourceDescriptors": [ { "type": "aiplatform.googleapis.com/Endpoint", "displayName": "AI Platform Endpoint", "description": "A Cloud AI Platform API Endpoint where Models are deployed into it.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Endpoint", }, { "type": "aiplatform.googleapis.com/Featurestore", "displayName": "AI Platform Feature Store", "description": "A Cloud AI Platform Feature Store.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Featurestore", },
Per visualizzare la richiesta come comando curl
, come richiesta HTTP o in JavaScript, fai clic su fullscreen Schermo intero in Explorer API.
C#
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta la sezione Risoluzione dei problemi relativi alle chiamate API.
Recupero dei descrittori delle risorse
Per ottenere un descrittore specifico delle risorse monitorate, utilizza il metodo monitoredResourceDescriptors.get
.
Per recuperare uno specifico descrittore di risorsa monitorata, devi fornire il nome completo del descrittore all'API. Il nome completo viene creato a partire da due componenti:
- Un prefisso composto da
projects/PROJECT_ID/monitoredResourceDescriptors
. - Il valore
type
che identifica il descrittore della risorsa monitorata, ad esempiogce_instance
. Per saperne di più sul valoretype
, consulta la scheda Protocollo in Elenca tipi di risorse.
Di seguito è riportato un esempio del nome completo di una risorsa monitorata:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Protocollo
Per ottenere il descrittore per il tipo di risorsa gce_instance
:
Apri la pagina di riferimento
monitoredResourceDescriptors.get
.Nel riquadro denominato Prova questo metodo, inserisci quanto segue:
nome:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Sostituisci
PROJECT_ID
con l'ID del tuo progetto Google Cloud.
Fai clic su Execute (Esegui).
La seguente risposta di esempio mostra il descrittore per questa risorsa monitorata:
{ "type": "gce_instance", "displayName": "VM Instance", "description": "A virtual machine instance hosted in Compute Engine.", "labels": [ { "key": "project_id", "description": "The identifier of the Google Cloud project associated with this resource, such as \"my-project\"." }, { "key": "instance_id", "description": "The numeric VM instance identifier assigned by Compute Engine." }, { "key": "zone", "description": "The Compute Engine zone in which the VM is running." } ], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance" }
Per visualizzare la richiesta come comando curl
, come richiesta HTTP o in JavaScript, fai clic su fullscreen Schermo intero in Explorer API.
C#
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione a Monitoring, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta la sezione Risoluzione dei problemi relativi alle chiamate API.
Passaggi successivi
- Per informazioni su come utilizzare l'API Cloud Monitoring per leggere i dati delle serie temporali, consulta Recuperare i dati delle serie temporali.
- Per un elenco dei tipi di risorse monitorate disponibili per l'utilizzo con le metriche definite dall'utente, vedi Scegliere un tipo di risorsa monitorata.