Introduzione all'API Cloud Monitoring

L'API Cloud Monitoring v3 ti consente di eseguire query e scrivere dati delle metriche in modo programmatico, organizzare le risorse monitorate in gruppi e gestire dashboard, policy di avviso, obiettivi del livello di servizio (SLO) e canali di notifica. Per le specifiche di metodi e risorse, consulta l'API Cloud Monitoring (REST) e l'API Cloud Monitoring (gRPC).

Nomi dei progetti nell'API Monitoring

Tutti i metodi nell'API Monitoring hanno un parametro name obbligatorio. Questo parametro in genere ha una descrizione simile alla seguente:

Obbligatorio. Il progetto su cui eseguire la richiesta. Il formato è:
projects/[PROJECT_ID_OR_NUMBER]

Nell'API Monitoring, il valore di PROJECT_ID_OR_NUMBER identifica uno dei seguenti elementi:

Alcuni metodi dell'API Monitoring richiedono che il progetto sia un progetto di definizione dell'ambito di un ambito delle metriche, mentre altri no. Un numero limitato di metodi può restituire risultati diversi, a seconda del tipo di progetto.

Per descrivere queste classi di metodi, questa discussione utilizza il termine API Metrics per fare riferimento alle seguenti risorse nell'API Monitoring:

È richiesto il progetto di definizione dell'ambito di un ambito delle metriche

Tutti i metodi dell'API Monitoring che non fanno parte dell'API Metrics richiedono che il parametro name faccia riferimento a un progetto di definizione dell'ambito di un ambito delle metriche.

Progetto di definizione dell'ambito di un ambito delle metriche non richiesto

Nessuno dei metodi nell'API Metrics richiede che il parametro name faccia riferimento a un progetto di scoping di un ambito delle metriche, ma alcuni metodi si comportano in modo diverso quando lo fa:

  • I seguenti metodi nell'API Metrics operano sul progettoGoogle Cloud denominato. Questi metodi influiscono sui dati solo nel progetto denominato, indipendentemente dal fatto che il progetto sia anche un progetto di definizione dell'ambito di un ambito delle metriche.

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • I restanti metodi nell'API Metrics si comportano come segue:

    • Se il progetto denominato non è un progetto di definizione dell'ambito di un ambito delle metriche, i metodi recuperano i dati solo dal progetto denominato.
    • Se il progetto denominato è anche un progetto di definizione dell'ambito di un ambito delle metriche, i metodi recuperano i dati sia dal progetto denominato sia da tutti i progetti che monitora.

    I metodi di questo gruppo sono i seguenti:

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

Per informazioni su come configurare un progetto Google Cloud come progetto di definizione dell'ambito di un ambito delle metriche, consulta Panoramica degli ambiti delle metriche.

Risorse API

Metriche

L'API Monitoring ti consente di accedere a circa 6500 metriche di Cloud Monitoring diGoogle Cloud e Amazon Web Services. Puoi creare metriche personalizzate e organizzare le risorse cloud utilizzando i gruppi.

Per un'introduzione ai concetti relativi alle metriche e alle strutture di dati che le rappresentano, consulta Metriche, serie temporali e risorse.

Per scoprire come gestire le metriche personalizzate e quelle integrate, consulta Panoramica delle metriche definite dall'utente.

Per un elenco completo delle metriche disponibili, consulta Elenco delle metriche.

Risorse monitorate

Una risorsa monitorata è un elemento per cui vengono raccolte metriche. Ad esempio, potresti avere interesse per l'attività di un'istanza VM o di un componente hardware.

Per un elenco delle risorse monitorate disponibili, consulta l'elenco delle risorse monitorate.

Gruppi di risorse monitorate

Un gruppo è una raccolta dinamica di risorse monitorate. Hai sempre potuto creare gruppi manualmente nella console Google Cloud e puoi anche utilizzare l'API Cloud Monitoring per scrivere codice che crea e utilizza gruppi.

Per saperne di più, consulta il riferimento API per Group.

crea una policy di avviso

Una policy di avviso è una risorsa di configurazione che descrive i criteri per la generazione di avvisi e come inviarti una notifica quando vengono creati. La panoramica degli avvisi spiega i concetti di base delle policy di avviso. Per saperne di più, consulta il riferimento API per AlertPolicy.

L'API consente inoltre di creare policy di avviso basate su un rapporto di due metriche. Al momento non è possibile creare rapporti utilizzando Monitoring nella console Google Cloud . Per saperne di più, consulta MetricThreshold nel riferimento AlertPolicy.

Canali di notifica

Un canale di notifica è una risorsa di configurazione che descrive come inviarti una notifica quando si verificano avvisi. I canali di notifica possono fare riferimento a una varietà di tipi diversi di servizi di comunicazione ed endpoint, specificati nei descrittori. I descrittori determinano l'insieme di parametri di configurazione inclusi in un oggetto canale.

Per saperne di più, consulta la documentazione di riferimento di NotificationChannel e la documentazione di riferimento di NotificationChannelDescriptor.

Monitoraggio dei servizi

Le risorse di monitoraggio dei servizi vengono utilizzate per configurare gli obiettivi del livello di servizio che possono essere utilizzati per monitorare l'integrità dei servizi.

Il monitoraggio dei servizi aggiunge le seguenti risorse all'API Monitoring:

Per ulteriori informazioni su questi concetti di monitoraggio dei servizi e sull'utilizzo dell'API, consulta Monitoraggio degli SLO.

Dashboard

Puoi creare e manipolare in modo programmatico sia le dashboard che i grafici utilizzando l'endpoint Dashboards. Per informazioni sull'utilizzo di questo endpoint per gestire dashboard e grafici, consulta Crea e gestisci le dashboard tramite API.

Monitoring Query Language

Monitoring Query Language (MQL) fornisce un'interfaccia basata su testo per eseguire query sui dati delle serie temporali di Cloud Monitoring. MQL utilizza un modello di query con pipe ed è più espressivo dei filtri di Monitoring. Puoi utilizzare le query MQL dall'API Monitoring o dall'editor di codice.

Per informazioni generali su MQL, consulta Panoramica di Monitoring Query Language.

Per informazioni sull'utilizzo di MQL per recuperare i dati delle serie temporali utilizzando l'API Monitoring, consulta il riferimento API per il metodo timeSeries.query.

Filtri

L'API Monitoring utilizza i filtri per selezionare le metriche, recuperare i dati delle serie temporali e raggruppare le risorse monitorate. Per saperne di più, consulta Filtri di monitoraggio.

L'API Monitoring utilizza anche i filtri per limitare il set di risultati di determinate operazioni list. Per informazioni dettagliate sulla gestione dei risultati dei metodi alertPolicies.list e notificationChannels.list, consulta Riferimento: ordinamento e filtro.

Passaggi successivi