Configura le metriche dei contatori

Questo documento spiega come creare una metrica basata su log di tipo contatore utilizzando la console Google Cloud , l'API Logging e Google Cloud CLI.

Le metriche contatore contano il numero di voci di log corrispondenti a un determinato filtro. Ad esempio, puoi creare una metrica basata sui log che conteggia il numero di voci di log che contengono un messaggio di errore specifico. Le metriche basate su log possono essere applicate all'interno di un singolo Google Cloud progetto o all'interno di un bucket di log.

Per una panoramica delle metriche basate su log, consulta la panoramica delle metriche basate su log.

Prima di iniziare

  1. Per utilizzare le metriche basate su log, devi disporre di un progetto Google Cloud con la fatturazione abilitata:

    1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

    2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    3. Make sure that billing is enabled for your Google Cloud project.

    4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    5. Make sure that billing is enabled for your Google Cloud project.

    6. Assicurati che il tuo ruolo Identity and Access Management includa le autorizzazioni necessarie per creare e visualizzare metriche basate su log e per creare policy di avviso. Per maggiori dettagli, vedi Autorizzazioni per le metriche basate su log.

      7. Crea una metrica basata su log di tipo contatore

      La metrica conta le voci di log identificate da un filtro che fornisci. Puoi utilizzare le espressioni regolari nel filtro e ti consigliamo di includere un tipo di risorsa. La lunghezza di un filtro non può superare i 20.000 caratteri.

      Non inserire informazioni sensibili nel filtro. I filtri vengono trattati come dati del servizio.

      Console

      Per creare una metrica contatore nella consoleGoogle Cloud nel tuo progetto Google Cloud :

      1. Nella console Google Cloud , vai alla pagina Metriche basate su log:

        Vai a Metriche basate su log

        Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

      2. Fai clic su Crea metrica. Viene visualizzato il riquadro Crea metrica log.

      3. Imposta il Tipo di metrica: seleziona Contatore.

      4. Imposta i seguenti campi nella sezione Dettagli:

        • Nome metrica basata su log: scegli un nome univoco tra le metriche basate su log nel tuo progetto Google Cloud . Sono previste alcune limitazioni per la denominazione; per maggiori dettagli, consulta la sezione Risoluzione dei problemi.
        • Descrizione: inserisci una descrizione per la metrica.
        • Unità: lascia vuoto questo campo o inserisci la cifra 1.

      5. Definisci il filtro delle metriche nella sezione Selezione filtri.

        1. Utilizza il menu Seleziona il progetto o il bucket di log per scegliere se la metrica conta le voci di log nel tuo progetto Google Cloud o solo quelle voci di log in un bucket di log specifico.

        2. Crea un filtro che raccolga solo le voci di log che vuoi conteggiare nella metrica utilizzando il linguaggio di query di Logging. Puoi anche utilizzare le espressioni regolari per creare i filtri della metrica.

        3. Per vedere quali voci di log corrispondono al filtro, fai clic su Visualizza l'anteprima dei log.

      6. (Facoltativo) Aggiungi un'etichetta nella sezione Etichette. Per istruzioni su come creare etichette, vedi Creare un'etichetta.

      7. Fai clic su Crea metrica per creare la metrica.

      gcloud

      Puoi creare una metrica basata su log senza etichette personalizzate utilizzando il seguente comando:

      gcloud logging metrics create METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  [--bucket-name="BUCKET_NAME"]

      Ad esempio, il seguente comando crea una metrica basata su log con ambito di progetto denominata error_count.

      gcloud logging metrics create error_count \
     --description "Errors in syslog." \
     --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR"

      Per creare una metrica basata su log con ambito bucket, fornisci il flag --bucket_name:

      gcloud logging metrics create error_count \
    --description "Errors in syslog." \
    --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR" \
    --bucket-name projects/my-project/locations/global/buckets/my-test-bucket

      Per istruzioni sulla creazione di etichette, consulta Configurare le etichette sulle metriche basate su log.

      API

      Per creare una metrica contatore, utilizza il metodo projects.metrics.create dell'API Logging. Se utilizzi il riquadro Explorer API nella pagina di riferimento, prepara gli argomenti nel seguente modo:

      1. Imposta il campo parent sul progetto o sul bucket in cui deve essere creata la metrica:

        • Per una metrica basata su log con ambito di progetto, specifica il progetto:
        projects/PROJECT_ID
        • Per una metrica basata su log con ambito bucket, specifica il bucket:
        projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID

      2. Imposta il corpo della richiesta su un oggetto LogMetric. Di seguito è riportato un esempio di oggetto per una metrica del contatore:

        {
  name:        "my-metric"
  description: "This is my metric."
  filter:      "resource.type=gce_instance AND log_id(\"syslog\")",
  metricDescriptor: {
      labels: [
        {
          key: "my-label",
          valueType: STRING,
          description: "This is my label.",
        }
      ]
  },
  labelExtractors: {
    "my-label":
      "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")",
    ...
  },
}

      Note:

      • Scegli un nome di metrica univoco tra le metriche basate su log nel tuo progetto. Si applicano alcune limitazioni alla denominazione. Per ulteriori dettagli, consulta la sezione Risoluzione dei problemi.

      • Per le metriche del contatore, i campi LogMetric valueExtractor e bucketOptions non hanno alcuno scopo e vengono omessi.

      • Se la metrica non ha etichette, puoi omettere i campi metricDescriptor e labelExtractors. Se la metrica ha etichette, consulta Etichette delle metriche basate su log per un'introduzione alle etichette e dettagli sulla loro creazione nell'API.

      Per ulteriori dettagli, consulta il tipo LogMetric.

      Latenza delle nuove metriche

      La nuova metrica viene visualizzata immediatamente nell'elenco delle metriche di Esplora log e nei menu di monitoraggio pertinenti. I dati sono in genere disponibili in meno di un minuto.

      Esamina le metriche basate su log

      Per elencare le metriche basate su log definite dall'utente nel tuo progetto Google Cloud o per esaminare una metrica specifica nel tuo progetto Google Cloud :

      Console

      1. Nella console Google Cloud , vai alla pagina Metriche basate su log:

        Vai a Metriche basate su log

        Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

      2. Nel riquadro Metriche definite dall'utente, vengono visualizzate le metriche basate su log definite dall'utente nel progetto Google Cloud corrente:

      3. Per visualizzare i dati in una metrica basata sui log, fai clic sul menu nella riga della metrica e seleziona Visualizza in Esplora metriche.

      gcloud

      Per elencare le metriche basate sui log definite dall'utente nel tuo progetto Google Cloud , utilizza il seguente comando:

      gcloud logging metrics list

      Per visualizzare una metrica basata su log definita dall'utente nel tuo progetto Google Cloud , utilizza questo comando:

      gcloud logging metrics describe METRIC_NAME

      Per ricevere assistenza, utilizza il comando seguente:

      gcloud logging metrics --help

      Non puoi leggere i dati della serie temporale di una metrica da Google Cloud CLI.

      API

      Elenca metriche

      Per elencare le metriche basate sui log definite dall'utente in un progetto Google Cloud , utilizza il metodo API projects.metrics.list. Compila i parametri del metodo come segue:

      • parent: il nome della risorsa del progetto Google Cloud : projects/PROJECT_ID.
      • pageSize: il numero massimo di risultati.
      • pageToken: recupera la pagina successiva dei risultati. Per informazioni sull'utilizzo dei token di pagina, vedi projects.metrics.list.

      Recuperare le definizioni delle metriche

      Per recuperare una singola metrica basata su log definita dall'utente, utilizza il metodo API projects.metrics.get. Compila i parametri del metodo come segue:

      • metricName: il nome della risorsa della metrica:

        projects/PROJECT_ID/metrics/METRIC_ID

      Lettura dei dati delle metriche

      Per leggere i dati delle serie temporali in una metrica basata su log, utilizza projects.timeseries.list nell'API Cloud Monitoring. Per informazioni dettagliate sui dati delle serie temporali, vedi Lettura delle serie temporali.

      Per leggere una singola metrica basata su log definita dall'utente, compila i parametri del metodo con questo tipo e identificatore di metrica:

      logging.googleapis.com/user/METRIC_ID

      Aggiorna le metriche basate su log

      Puoi modificare una metrica basata su log definita dall'utente per cambiarne la descrizione, il filtro e i nomi dei campi a cui fa riferimento la metrica. Puoi aggiungere nuove etichette alla metrica e modificare le espressioni regolari utilizzate per estrarre i valori per la metrica e le relative etichette. Se utilizzi una metrica con ambito bucket, puoi anche aggiornare il bucket della metrica.

      Non puoi modificare i nomi o i tipi delle metriche basate su log definite dall'utente o le relative etichette e non puoi eliminare le etichette esistenti in una metrica basata su log.

      Per modificare una metrica basata su log:

      Console

      1. Nella console Google Cloud , vai alla pagina Metriche basate su log:

        Vai a Metriche basate su log

        Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

      2. Fai clic su Modifica metrica nel menu per la metrica basata sui log che vuoi modificare.

      3. Modifica gli elementi consentiti nella metrica.

      4. Fai clic su Aggiorna metrica.

      gcloud

      Utilizza Google Cloud CLI per modificare la descrizione, la query di filtro e il bucket di una metrica del contatore. Puoi aggiornare uno o tutti i campi contemporaneamente.

      gcloud logging update METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  --bucket-name=BUCKET_NAME

      Se modifichi il bucket associato a una metrica con ambito bucket, i dati delle metriche raccolti prima della modifica non riflettono più la configurazione attuale. I dati delle metriche raccolti per il bucket precedente non vengono rimossi.

      Per aggiornare le metriche di distribuzione o altri campi delle metriche dei contatori, escluso METRIC_NAME, crea un file che contenga la specifica rivista del tuo LogMetric in formato JSON o YAML. Poi, aggiorna la metrica chiamando il comando update con il campo --config-from-file, sostituendo FILENAME con il nome del file JSON o YAML:

      gcloud logging update METRIC_NAME --config-from-file FILENAME

      Per ulteriori dettagli, utilizza il comando seguente:

      gcloud logging metrics update --help

      API

      Per modificare una metrica basata su log, utilizza il metodo projects.metrics.update nell'API. Imposta i campi come segue:

      • metricName: il nome completo della risorsa della metrica:

        projects/PROJECT_ID/metrics/METRIC_ID

        Ad esempio:

        projects/my-gcp-project/metrics/my-error-metric

      • Nel corpo della richiesta, includi un oggetto LogMetric che sia esattamente uguale alla metrica esistente, ad eccezione delle modifiche e delle aggiunte che vuoi apportare.

      Elimina le metriche basate su log

      Per eliminare una metrica basata su log definita dall'utente:

      Console

      1. Nella console Google Cloud , vai alla pagina Metriche basate su log:

        Vai a Metriche basate su log

        Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

      2. Seleziona la metrica che vuoi eliminare e fai clic su Elimina.

        In alternativa, fai clic su Elimina metrica nel menu della metrica basata sui log che vuoi eliminare.

      gcloud

      Utilizza il seguente comando per eliminare una metrica basata su log definita dall'utente nel progetto Google Cloud corrente:

      gcloud logging metrics delete METRIC_NAME

      Per ulteriori dettagli, utilizza il comando seguente:

      gcloud logging metrics delete --help

      API

      Per eliminare una metrica basata su log definita dall'utente, utilizza il metodo projects.metrics.delete nell'API.

      Inoltre, nella pagina Metrica basata su log della console Google Cloud , il riquadro Metriche definite dall'utente dell'interfaccia delle metriche basate su log fornisce più funzionalità per aiutarti a gestire le metriche definite dall'utente nel tuo progettoGoogle Cloud . Per maggiori dettagli, consulta la sezione Metriche definite dall'utente.