Configura le metriche di distribuzione

Questa pagina spiega come creare metriche di distribuzione basate su log con la console Google Cloud, l'API Logging e Google Cloud CLI. Per una visione d'insieme delle metriche basate su log, vai a Panoramica delle metriche basate su log.

Panoramica

Le metriche di distribuzione richiedono sia un filtro per selezionare le voci di log pertinenti sia un'estrazione di valore per acquisire il valore numerico della distribuzione. L'estrazione del valore è dello stesso tipo utilizzato per le etichette definite dall'utente.

Una metrica di distribuzione registra la distribuzione statistica dei valori estratti nei bucket dell'istogramma. I valori estratti non vengono registrati individualmente, ma viene registrata la loro distribuzione nei bucket configurati, insieme al conteggio, alla media e alla somma della deviazione al quadrato dei valori. Puoi utilizzare il layout predefinito dei bucket dell'istogramma nella distribuzione o perfezionare i limiti dei bucket per acquisire approssimativamente i valori.

Per ulteriori informazioni su come visualizzare e interpretare le metriche di distribuzione, consulta Metriche di distribuzione.

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.

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

Creare una metrica di distribuzione

La metrica conteggia le voci di log identificate da un filtro specificato. 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 di servizio.

Console

Per creare una metrica del contatore basata su log nella console Google Cloud del 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 di log.

  3. Imposta il Tipo di metrica: seleziona Distribuzione.

  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 i nomi. Per maggiori dettagli, consulta la sezione Risoluzione dei problemi.
    • Descrizione: inserisci una descrizione per la metrica.
    • Unità: (facoltativo) per le metriche di distribuzione, puoi facoltativamente inserire unità, ad esempio s e ms. Per ulteriori informazioni, consulta il campo unit di MetricDescriptor.

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

    1. Utilizza il menu Seleziona progetto o bucket di log per scegliere se la metrica conteggia le voci di log nel 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. Nome campo: inserisci il campo della voce di log contenente il valore della distribuzione. Ti vengono offerte delle opzioni durante la digitazione. Ad esempio:

      protoPayload.latency

    4. Espressione regolare: (facoltativo) se Nome campo contiene sempre un valore numerico convertibile in tipo double, puoi lasciare questo campo vuoto. In caso contrario, specifica un'espressione regolare che estrae il valore della distribuzione numerica dal valore del campo.

      Esempio. Supponiamo che il campo della voce di log latency contenga un numero seguito da ms per i millisecondi. La seguente regexp sceglie il numero senza il suffisso dell'unità:

      ([0-9.]+)

      Le parentesi, note come gruppo di cattura regexp, identificano la parte della corrispondenza del testo che verrà estratta. Per maggiori dettagli, consulta la sezione sull'utilizzo delle espressioni regolari.

    • Avanzate (bucket dell'istogramma): (Facoltativo) se fai clic su Avanzate, si apre una sezione del modulo che puoi utilizzare per specificare i layout dei bucket personalizzati. Se non specifichi i layout dei bucket, viene fornito un layout predefinito per i bucket. Per ulteriori informazioni, consulta Bucket dell'istogramma in questa pagina.
    1. 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 le etichette, consulta Creare un'etichetta.

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

gcloud

Per creare una metrica basata su log di tipo distribuzione, crea un file che contenga una rappresentazione della definizione di LogMetric in formato JSON o YAML. Quindi, utilizza il seguente comando per leggere la configurazione dal file:

gcloud logging metrics create METRIC_NAME --config-from-file FILENAME

Per informazioni sulla descrizione dei bucket di istogrammi per una distribuzione, consulta Bucket di istogrammi.

API

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

  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 basata su 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 oggetto di esempio per una metrica di distribuzione.

    {
  name:        "my-metric"
  description: "Description of my-metric."
  filter:      "resource.type=gce_instance AND log_id(\"syslog\")",
  valueExtractor: "REGEXP_EXTRACT(jsonPayload.latencyField, \"([0-9.]+)ms\")",

  labelExtractors: {
    "my-label-1":
      "REGEXP_EXTRACT(jsonPayload.someField, \"before ([[:word:]]+) after\")",
    "my-label-2":
      "EXTRACT(jsonPayload.anotherField, \"before ([0-9]+) after\")",
  },
  bucketOptions: { [SEE_BELOW] },

  metricDescriptor: {
      metricKind: DELTA,
      valueType: DISTRIBUTION,
      unit: "ms",

      labels: [
        {
          key: "my-label-1",
          valueType: STRING,
          description: "Description of string my-label-1.",
        },
        {
          key: "my-label-2",
          valueType: INT64,
          description: "Description of integer my-label-2.",
        }
      ]
  },
}

Note:

  • Sono previste alcune limitazioni per i nomi. Per informazioni dettagliate, consulta la sezione Risoluzione dei problemi.

  • metricDescriptor: un oggetto MetricDescriptor. metricKind deve essere DELTA. valueType deve essere DISTRIBUTION.

Bucket a istogrammi

Le metriche di distribuzione includono un istogramma che conteggia il numero di valori che rientrano in intervalli (bucket) specificati. Puoi avere fino a 200 bucket in una metrica di distribuzione.

Ogni bucket ha due valori di confine, L e H, che definiscono i valori minimo e massimo coperti dal bucket. La larghezza del bucket è H - L. Poiché non possono esserci spazi tra i bucket, il limite inferiore di un bucket è uguale al limite superiore del bucket precedente e così via. Affinché i limiti non rientrino in più di un bucket, un bucket include il suo limite inferiore; il limite superiore appartiene al bucket successivo.

Tutti i layout dei bucket possono essere specificati elencando, in ordine crescente, i valori di confine tra i singoli bucket. Il primo bucket è il bucket di underflow, che conteggia i valori inferiori al primo confine. L'ultimo bucket è il bucket di overflow, che conteggia i valori maggiori o uguali all'ultimo confine. Gli altri bucket conteggiano i valori maggiori o uguali al confine inferiore e minori del confine superiore. Se sono presenti n valori di confine, esistono n+1 bucket. Se si escludono i bucket di sottoflusso e di overflow, esistono n-1 bucket finiti.

Esistono tre modi diversi per specificare i limiti tra i bucket dell'istogramma per le metriche di distribuzione. Specifica una formula per i valori limite o elencali:

  • Lineare(offset, width, i): ogni bucket ha la stessa larghezza. I limiti sono offset + width * i, per i=0,1,2,...,N. Per maggiori informazioni sui bucket lineari, consulta il riferimento all'API.

  • Esponenziale(scala, fattore_di_crescita, i): le larghezze dei bucket aumentano per valori più elevati. I limiti sono scala * fattore_di_crescitai, per i=0,1,2,...,N. Per ulteriori informazioni sui bucket esponenziali, consulta il riferimento all'API.

  • Esplicito: elenchi tutti i limiti per i bucket nell'array bounds. Il bucket i ha i seguenti limiti:

    Upper bound: bounds[*i*] for (0 <= *i* < *N*-1)
Lower bound: bounds[*i* - 1] for (1 <= *i* < *N*)

    Per ulteriori informazioni sui bucket espliciti, consulta il riferimento all'API.

La sezione seguente spiega come specificare i bucket dell'istogramma:

Console

Il sottomenu Bucket dell'istogramma si apre quando crei una metrica di distribuzione e fai clic su Altro nel modulo Editor delle metriche. Il seguente sottomodulo è per il layout del bucket Lineare:

Bucket a istogrammi

Bucket lineari: compila il modulo del bucket dell'istogramma come segue.

  • Tipo: Lineare
  • Valore iniziale (a): il limite inferiore del primo bucket finito. Questo valore è chiamato offset nell'API.
  • Numero di bucket (N): il numero di bucket finiti. Il valore deve essere maggiore o uguale a 0.
  • Larghezza del bucket (b): la differenza tra il limite superiore e il limite inferiore in ogni bucket finito. Il valore deve essere maggiore di 0.

Ad esempio, se il valore iniziale è 5, il numero di bucket è 4 e la larghezza del bucket è 15, gli intervalli dei bucket sono i seguenti:

(-INF, 5), [5, 20), [20, 35), [35, 50), [50, 65), [65, +INF)

Bucket espliciti: compila il modulo del bucket dell'istogramma come segue:

  • Tipo: Esplicito
  • Limiti (b): un elenco separato da virgole dei valori limite dei bucket finiti. Questo determina anche il numero di bucket e le relative larghezze.

Ad esempio, se l'elenco di confini è:

0, 1, 2, 5, 10, 20

Esistono cinque bucket con i seguenti intervalli:

(-INF, 0), [0, 1), [1, 2), [2,5), [5, 10), [10, 20), [20, +INF)

Bucket esponenziali: compila il modulo del bucket dell'istogramma come segue:

  • Tipo: Esponenziale

  • Numero di bucket (N): il numero totale di bucket finiti. Il valore deve essere maggiore di 0.

  • Scala lineare (a): la scala lineare per i bucket. Il valore deve essere maggiore di 0.

  • Fattore di crescita esponenziale (b): il fattore di crescita esponenziale per i bucket. Il valore deve essere maggiore di 1.

Ad esempio, se N=4, a=3 e b=2, gli intervalli dei bucket sono i seguenti:

(-INF, 3), [3, 6), [6, 12), [12, 24), [24, 48), [48, +INF)

Per ulteriori informazioni sui bucket, consulta BucketOptions nell' API Cloud Monitoring.

API

Il layout facoltativo del bucket è specificato dal campo bucketOptions nell'oggetto LogMetric fornito a projects.metrics.create. Per l'oggetto LogMetric completo, consulta Creare una metrica di distribuzione in questa pagina. Le aggiunte per i layout dei bucket sono come mostrato di seguito:

Bucket lineari:

{ # LogMetric object
  ...
  bucketOptions: {
    linearBuckets: {
      numFiniteBuckets: 4,
      width: 15,
      offset: 5
    }
  },
  ...
}

L'esempio precedente crea i seguenti bucket:

(-INF, 5), [5, 20), [20, 35), [35, 50), [50, 65), [65, +INF)

Bucket espliciti: i limiti sono elencati singolarmente.

{ # LogMetric object
  ...
  bucketOptions: {
    explicitBuckets: {
      bounds: [0, 1, 2, 5, 10, 20 ]
    }
  },
  ...
}

L'esempio precedente crea i seguenti bucket:

(-INF, 0), [0, 1), [1, 2), [2, 5), [5, 10), [10, 20), [20, +INF)

Bucket esponenziali: i limiti sono scala * fattoreDiCrescita ^ i, per i=0,1,2, ..., numFiniteBuckets

{ # LogMetric object
  ...
  bucketOptions: {
    exponentialBuckets: {
      numFiniteBuckets: 4,
      growthFactor: 2,
      scale: 3
    }
  },
  ...
}

L'esempio precedente crea i seguenti bucket:

(-INF, 3), [3, 6), [6, 12), [12, 24), [24, 48), [48, +INF)

Nuova latenza della metrica

La nuova metrica viene visualizzata immediatamente nell'elenco delle metriche e nei menu di monitoraggio pertinenti. Tuttavia, potrebbe essere necessario fino a un minuto prima che la metrica inizi a raccogliere i dati per le voci di log corrispondenti.

Controllare le metriche di distribuzione

Per elencare le metriche basate su log definite dall'utente nel tuo progetto Google Cloud o per esaminare una determinata metrica 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 su log, fai clic sul pulsante Menu nella riga della metrica e seleziona Visualizza in Esplora metriche.

gcloud

Per elencare le metriche basate su log definite dall'utente nel 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 il seguente comando:

gcloud logging metrics describe METRIC_NAME

Per ricevere assistenza, utilizza il seguente comando:

gcloud logging metrics --help

Non puoi leggere i dati delle serie temporali di una metrica da Google Cloud CLI.

API

Elenca metriche

Per elencare le metriche basate su log definite dall'utente in un progetto Google Cloud, utilizza il metodo dell'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 di risultati successiva. Per informazioni sull'utilizzo dei token di pagina, consulta 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, consulta Lettura delle serie temporali.

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

logging.googleapis.com/user/METRIC_ID

Aggiorna le metriche di distribuzione

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. 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 basata su bucket, puoi anche aggiornare il bucket della metrica.

Non puoi modificare i nomi o i tipi di 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 su 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 basata su bucket, tutti i dati delle metriche raccolti prima della modifica non riflettono più la configurazione corrente. 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 contenente la specifica rivista del tuo LogMetric in formato JSON o YAML. Aggiorna quindi la metrica chiamando il comando update con il campo --config-from-file, sostituendo update con il nome del file JSON o YAML:FILENAME

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

Per maggiori dettagli, utilizza il seguente comando:

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.

Eliminare le metriche di distribuzione

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 da eliminare e fai clic su Elimina.

    In alternativa, fai clic su Elimina metrica nel menu della metrica basata su 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 maggiori dettagli, utilizza il seguente comando:

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 altre funzionalità per aiutarti a gestire le metriche definite dall'utente nel tuo progetto Google Cloud. Per maggiori dettagli, consulta Metriche definite dall'utente.