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 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 nell'API Monitoring richiedono che il progetto sia un progetto di ambito delle metriche, al contrario di altri. Un numero ridotto di metodi può restituire risultati diversi, a seconda del tipo di progetto.

Per descrivere queste classi di metodi, in questa discussione viene utilizzato il termine API metrics per fare riferimento alle seguenti risorse nell'API Monitoring:

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

Tutti i metodi dell'API Monitoring che non fanno parte dell'API delle metriche 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 obbligatorio

Nessuno dei metodi nell'API delle metriche richiede il parametro name per fare riferimento a un progetto di definizione dell'ambito di un ambito delle metriche, ma alcuni metodi si comportano in modo diverso quando:

  • I seguenti metodi nell'API Metrics funzionano sul progetto Google Cloud denominato. Questi metodi interessano solo i dati del progetto denominato, indipendentemente dal fatto che il progetto sia anche un progetto di 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 dai progetti monitorati.

    I metodi di questo gruppo sono i seguenti:

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

Per informazioni sulla configurazione di un progetto Google Cloud come progetto di ambito delle metriche, consulta la panoramica degli ambiti delle metriche.

Risorse API

Metriche

L'API Monitoring ti dà accesso 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 delle metriche e alle strutture di dati che li rappresentano, consulta Metriche, serie temporali e risorse.

Per informazioni su come gestire le metriche personalizzate e le metriche integrate, consulta la Panoramica delle metriche definite dall'utente.

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

Risorse monitorate

Una risorsa monitorata riguarda le metriche che vengono raccolte. Ad esempio, potresti essere interessato all'attività di un'istanza VM o di un 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. Puoi sempre creare i gruppi manualmente nella console Google Cloud e puoi anche utilizzare l'API Cloud Monitoring per scrivere il codice che crea e utilizza i 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 come ricevere una notifica quando vengono creati. La sezione Concetti sugli avvisi spiega i concetti di base dei criteri di avviso. Per maggiori informazioni, consulta il riferimento API per AlertPolicy.

L'API consente inoltre di creare criteri di avviso basati su un rapporto di due metriche. Al momento non è possibile creare i rapporti utilizzando Monitoring nella console Google Cloud. Per maggiori informazioni, consulta MetricThreshold nel riferimento AlertPolicy.

Canali di notifica

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

Per maggiori informazioni, consulta il riferimento NotificationChannel e il riferimento NotificationChannelDescriptor.

Monitoraggio dei servizi

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

Service Monitoring aggiunge le seguenti risorse all'API Monitoring:

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

Dashboard

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

Monitoring Query Language

Monitoring Query Language (MQL) fornisce un'interfaccia basata su testo per l'esecuzione di query sui dati delle serie temporali di Cloud Monitoring. MQL utilizza un modello di query piped 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 i dati delle serie temporali mediante l'API Monitoring, consulta il riferimento dell'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 ulteriori informazioni, consulta la sezione Filtri di monitoraggio.

L'API Monitoring utilizza anche i filtri per limitare il set di risultati di determinate operazioni list. Per maggiori dettagli sulla gestione dei risultati dei metodi alertPolicies.list e notificationChannels.list, consulta Ordinamento e filtro.

Passaggi successivi