Questo documento spiega come utilizzare l'API Cloud Monitoring per ottenere elenchi o descrizioni di quanto segue:
- Tipi di metriche definite dall'utente e definiti nel progetto.
- Tipi di metriche di terze parti con dati di serie temporali nel progetto.
Metriche generate da BindPlane
sono esempi di metriche di terze parti. Metriche BindPlane
hanno un prefisso di
workload.googleapis.com/3rd-party-app-name/
. Per un elenco completo delle metriche delle applicazioni di terze parti supportate, consulta Documentazione di Sources di BindPlane. - Tipi di metriche integrati forniti da Google Cloud. Questi tipi di metriche possono aiutarti sei tu a progettare le metriche definite dall'utente. Puoi anche trovare informazioni su queste metriche nella documentazione; consulta Elenco delle metriche.
- Tipi di risorse monitorati disponibili per il tuo progetto. Puoi anche trovare informazioni su queste risorse nella documentazione: consulta Elenco delle risorse monitorate.
Per eseguire i metodi senza scrivere alcun codice, nelle schede Protocollo di questa pagina, utilizzano i modelli Explorer API. (vedi Explorer API per ulteriori informazioni su questo strumento).
Per imparare a usare i metodi di determinati linguaggi di programmazione, puoi vedere 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.
Elenca descrittori della metrica
I descrittori delle metriche sono gli schemi che definiscono le metriche. Per trovare dettagli sulle metriche che ti interessano, sfoglia la descrittori delle metriche disponibili:- Metriche integrate: puoi inviare richieste API a qualsiasi esistente o puoi utilizzare la documentazione relativa agli elenchi di metriche.
- Metriche definite dall'utente ed esterne: devi inviare la richiesta API a un progetto in cui è definita la metrica definita dall'utente o dove in base ai dati delle serie temporali per la metrica.
Per ulteriori informazioni su come vengono denominati i tipi di metriche, consulta Convenzioni di denominazione.
Elenca i tipi di metriche
Per ottenere un elenco aggiornato dei descrittori delle metriche, utilizza la
metricDescriptors.list
.
Per restringere l'insieme di tipi di metriche restituiti, utilizza un filtro.
Per informazioni su come decidere quali tipi di metriche cercare, consulta:
Tipi di valori e metriche.
Protocollo
Apri la pagina di riferimento di
metricDescriptors.list
.Nel riquadro con l'etichetta Prova questo metodo, inserisci quanto segue:
- nome:
projects/PROJECT_ID
. SostituisciPROJECT_ID
con 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 dei descrittori della metrica recuperata:
"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, per
ad esempio compute.googleapis.com/firewall/dropped_packets_count
. Questo valore è
a volte chiamato anche "tipo di metrica"
"nome del tipo di metrica".
Per visualizzare la richiesta come comando curl
, sotto forma di
Richiesta HTTP o in JavaScript fai clic su fullscreen Schermo intero
in Explorer API.
C#
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta la sezione Risoluzione dei problemi delle chiamate API.
Ottieni descrittori delle metriche
Per ottenere informazioni su un singolo tipo di metrica, utilizza il metodo
Metodo metricDescriptors.get
.
Questo metodo restituisce un descrittore della metrica.
Per recuperare un descrittore della metrica specifico, devi fornire il nome completo della una metrica all'API. Il nome completo è composto da due componenti:
- Prefisso composto da
projects/PROJECT_ID/metricDescriptors
. - Il valore
type
che identifica il descrittore della metrica, ad esempiocompute.googleapis.com/firewall/dropped_packets_count
. Consulta le Scheda Protocollo in Elenca i tipi di metriche per ulteriori informazioni sul valoretype
.
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 Compute Engine /firewall/dropped_packets_count
procedi nel seguente modo:
Apri la pagina di riferimento di
metricDescriptors.list
.Nel riquadro con l'etichetta 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
, sotto forma di
Richiesta HTTP o in JavaScript fai clic su fullscreen Schermo intero
in Explorer API.
C#
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta la sezione Risoluzione dei problemi delle chiamate API.
Elenco delle risorse monitorate
Le risorse monitorate sono entità cloud che possono essere monitorate. Per trovare i tipi di entità con metriche, sfoglia l'elenco delle risorsa monitorata di testo.
Per ottenere informazioni sulle risorse monitorate, puoi inviare richieste API a qualsiasi progetto esistente o puoi utilizzare la documentazione relativa all'elenco delle risorse monitorate.
Elenca i tipi di risorsa
Per ottenere un elenco aggiornato dei tipi di risorsa monitorata
l'API Monitoring,
utilizza la monitoredResourceDescriptors.list
e fornisci il tuo ID progetto.
Protocollo
Apri
monitoredResourceDescriptors.list
pagina di riferimento.Nel riquadro con l'etichetta 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 alcune delle risorsa monitorata restituite tipi:
{ "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
, sotto forma di
Richiesta HTTP o in JavaScript fai clic su fullscreen Schermo intero
in Explorer API.
C#
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta la sezione Risoluzione dei problemi delle chiamate API.
Recupero dei descrittori delle risorse
Per ottenere un descrittore specifico di una risorsa monitorata, utilizza
monitoredResourceDescriptors.get
.
Per recuperare un descrittore specifico di una risorsa monitorata, devi fornire il metodo nome completo del descrittore nell'API. Il nome completo è costituito da due componenti:
- Prefisso composto da
projects/PROJECT_ID/monitoredResourceDescriptors
. - Il valore
type
che identifica il descrittore della risorsa monitorata, ad esempiogce_instance
. Visualizza la scheda Protocollo in Elenco dei tipi di risorse per ulteriori informazioni sul valoretype
.
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
monitoredResourceDescriptors.get
pagina di riferimento.Nel riquadro con l'etichetta 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
, sotto forma di
Richiesta HTTP o in JavaScript fai clic su fullscreen Schermo intero
in Explorer API.
C#
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per autenticarti a Monitoring, configura Credenziali predefinite dell'applicazione. Per ulteriori informazioni, vedi Configura l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta la sezione Risoluzione dei problemi delle chiamate API.
Passaggi successivi
- Per informazioni su come utilizzare l'API Cloud Monitoring per leggere le serie temporali consulta Recuperare i dati delle serie temporali.
- Per un elenco dei tipi di risorse monitorate disponibili con metriche definite dall'utente, consulta Scegliere un tipo di risorsa monitorata.