L'elenco dei descrittori delle metriche e dei tipi di risorsa monitorata con l'API Cloud Monitoring consente di esaminare gli schemi e le etichette delle metriche per eseguire query sui dati delle serie temporali o progettare metriche. Puoi sfogliare i tipi di metriche integrate Google Cloud, definite dall'utente e di terze parti, nonché i tipi di risorsa monitorata nel tuo progetto. Le metriche di terze parti, come quelle di Bindplane, utilizzano il prefisso workload.googleapis.com/3rd-party-app-name/; consulta la documentazione sulle origini di Bindplane. Per gli elenchi di riferimento dei tipi integrati, consulta l'elenco delle metriche e l'elenco delle risorse monitorate.
Puoi eseguire questi metodi API senza scrivere codice nelle schede Protocollo utilizzando Explorer API o gli esempi di codice nel tuo linguaggio preferito.
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 i dettagli sulle metriche che ti interessano, sfoglia i descrittori delle metriche disponibili:- Metriche integrate: puoi inviare richieste API a qualsiasi progetto esistente o utilizzare la documentazione degli 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 in cui esistono dati delle serie temporali per la metrica.
Per saperne di più 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 il metodo metricDescriptors.list.
Per restringere l'insieme di tipi di metriche restituite, utilizza un filtro.
Per decidere quali tipi di metriche cercare, consulta Tipi di valori e tipi di metriche.
Protocollo
- Apri la pagina di riferimento di
metricDescriptors.list. - Nel riquadro Prova questo metodo, inserisci quanto segue:
- name: inserisci il percorso e l'ID del progetto:
projects/PROJECT_ID
- filter: inserisci quanto segue:
metric.type = starts_with("compute.googleapis.com")
- name: inserisci il percorso e l'ID del progetto:
- Fai clic su Esegui.
La seguente risposta di esempio mostra alcuni dei descrittori delle metriche 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 viene anche chiamato "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 in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Se hai difficoltà, consulta Risoluzione dei problemi relativi alle chiamate API.
Recupera i descrittori delle metriche
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 all'API il nome completo della metrica. Il nome completo è composto da due componenti:
- Un prefisso composto da
projects/PROJECT_ID/metricDescriptors. - Il valore
typeche 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 i 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 della metrica /firewall/dropped_packets_count di Compute Engine, segui questi passaggi:
- Apri la pagina di riferimento di
metricDescriptors.get. - Nel riquadro Prova questo metodo, inserisci quanto segue:
- name: inserisci l'ID del progetto e il nome della metrica:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Sostituisci PROJECT_ID con l'ID del tuo progetto Google Cloud .
- name: inserisci l'ID del progetto e il nome della metrica:
- Fai clic su 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 in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta 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 hanno metriche, sfoglia l'elenco dei tipi di risorsa monitorata.
Per ottenere informazioni sulle risorse monitorate, puoi inviare richieste API a qualsiasi progetto esistente o utilizzare la documentazione Elenco delle risorse monitorate.
Elenco dei tipi di risorse
Per ottenere un elenco aggiornato dei tipi di risorsa monitorata dall'API Monitoring, utilizza il metodo monitoredResourceDescriptors.list e fornisci l'ID progetto.
Protocollo
- Apri la pagina di riferimento di
monitoredResourceDescriptors.list. - Nel riquadro Prova questo metodo, inserisci quanto segue:
- name: inserisci il percorso e l'ID del progetto:
projects/PROJECT_ID
- name: inserisci il percorso e l'ID del progetto:
- Fai clic su 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 in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta Risoluzione dei problemi relativi alle chiamate API.
Recupera i descrittori delle risorse
Per ottenere un descrittore di risorsa monitorata specifico, utilizza il metodo monitoredResourceDescriptors.get.
Per recuperare un descrittore di risorse monitorate specifico, devi fornire il nome completo del descrittore all'API. Il nome completo è composto da due componenti:
- Un prefisso composto da
projects/PROJECT_ID/monitoredResourceDescriptors. - Il valore
typeche identifica il descrittore della risorsa monitorata, ad esempiogce_instance. Per saperne di più sul valoretype, consulta la scheda Protocollo in Tipi di risorse di elenco.
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,
procedi nel seguente modo:
- Apri la pagina di riferimento di
monitoredResourceDescriptors.get. - Nel riquadro Prova questo metodo, inserisci quanto segue:
- name: inserisci il percorso e l'ID del progetto e il nome della risorsa:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
- name: inserisci il percorso e l'ID del progetto e il nome della risorsa:
- Fai clic su 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 in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione in Monitoring, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
In caso di difficoltà, consulta 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 Recupera i dati delle serie temporali.
- Per un elenco dei tipi di risorse monitorate disponibili per l'utilizzo con le metriche definite dall'utente, consulta Scegli un tipo di risorsa monitorata.