Introduzione all'API Cloud Monitoring

Questa pagina descrive alcune delle funzionalità dell'API Cloud Monitoring v3.

Per la documentazione di riferimento dell'API, consulta una delle seguenti pagine:

Nomi dei progetti nell'API Monitoring

Tutti i metodi dell'API Monitoring hanno un parametro name obbligatorio. Questo parametro in genere ha una descrizione come la 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; altri metodi no. Un numero ridotto 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:

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

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 definizione dell'ambito di un ambito delle metriche, ma alcuni metodi si comportano in modo diverso quando lo è:

  • I seguenti metodi dell'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 metodi rimanenti nell'API Metrics si comportano nel seguente modo:

    • 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 la panoramica degli ambiti delle metriche.

Risorse API

Metriche

L'API Monitoring ti consente di accedere a circa 6500 metriche di Cloud Monitoring da Google 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 su cui vengono raccolte le metriche. Ad esempio, potresti essere interessato all'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.

Criteri di avviso

Un criterio di avviso è una risorsa di configurazione che descrive i criteri per la generazione di incidenti e le modalità di notifica quando vengono creati questi incidenti. Concetti di avviso spiega i concetti di base dei criteri di avviso. Per saperne di più, consulta il riferimento API per AlertPolicy.

L'API consente anche di creare criteri di avviso basati su un rapporto tra due metriche. Al momento non è possibile creare rapporti utilizzando Monitoring nella console Google Cloud . Per ulteriori informazioni, consulta la sezione MetricThreshold nella guida di riferimento di AlertPolicy.

Canali di notifica

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

Per saperne di più, consulta il riferimento NotificationChannel e il riferimento 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 tuoi servizi.

Service Monitoring aggiunge le seguenti risorse all'API Monitoring:

Per saperne di più su questi concetti di monitoraggio dei servizi e sull'utilizzo dell'API, consulta Monitoraggio SLO.

Dashboard

Puoi creare e manipolare in modo programmatico sia dashboard che grafici utilizzando l'endpoint Dashboards. Per informazioni sull'utilizzo di questo endpoint per gestire dashboard e grafici, consulta Gestione delle 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 Utilizzo di Monitoring Query Language.

Per informazioni sull'utilizzo di MQL per recuperare 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 raccogliere le risorse monitorate in gruppi. Per saperne di più, consulta Filtri di monitoraggio.

L'API Monitoring utilizza anche 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, vedi Ordinamento e filtro.

Passaggi successivi