Configura le metriche di distribuzione

Questa pagina spiega come creare metriche basate su log di tipo distribuzione utilizzando la console Google Cloud, l'API Logging e Google Cloud CLI. Per una visualizzazione complessiva delle metriche basate su log, consulta Panoramica delle metriche basate su log.

Panoramica

Le metriche di distribuzione richiedono sia un filtro per selezionare le voci di log pertinenti, sia un estrattore di valori per recuperare il valore numerico per la distribuzione. L'estrattore 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 di istogrammi. I valori estratti non vengono registrati singolarmente, ma viene registrata la loro distribuzione nei bucket configurati, insieme al conteggio, alla media e alla somma delle deviazioni al quadrato dei valori. Puoi utilizzare il layout predefinito dei bucket a istogrammi nella tua distribuzione oppure puoi perfezionare i limiti dei bucket per acquisire approssimativamente i valori.

Per ulteriori informazioni sulla visualizzazione e sull'interpretazione delle metriche di distribuzione, consulta Metriche di distribuzione.

Prima di iniziare

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

    1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

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

      Go to project selector

    3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

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

      Go to project selector

    5. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

  2. Assicurati che il 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 conta le voci di log identificate da un filtro che fornisci. Puoi utilizzare 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 dei servizi.

Console

Segui questi passaggi per creare una metrica del contatore basata su log nella console Google 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 usi 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 Details (Dettagli):

    • Nome metrica di log: scegli un nome univoco tra le metriche basate su log nel progetto Google Cloud. Si applicano alcune restrizioni di denominazione. Per i dettagli, consulta Risoluzione dei problemi.
    • Descrizione: inserisci una descrizione per la metrica.
    • Unità: (facoltativo) per le metriche di distribuzione, puoi facoltativamente inserire unità, ad esempio s, ms e così via. Per ulteriori informazioni, consulta il campo unit di MetricDescriptor.

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

    1. Usa Seleziona ambito di log per scegliere se il filtro deve avere come target tutti i log del progetto Google Cloud o solo i log di un bucket 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. Durante la digitazione ti vengono offerte delle opzioni. Ad esempio:

       protoPayload.latency

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

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

      ([0-9.]+)

      Le parentesi, note come gruppo di acquisizione regexp, identificano la parte della corrispondenza di testo che verrà estratta. Per maggiori dettagli, consulta Utilizzo delle espressioni regolari.

    • Avanzate (bucket di istogrammi): (facoltativo) fai clic su Avanzate per aprire una sezione del modulo che puoi utilizzare per specificare layout di bucket personalizzati. Se non specifichi i layout dei bucket, viene fornito un layout predefinito. Per maggiori informazioni, consulta la sezione Bucket degli istogrammi in questa pagina.
    1. Per vedere quali voci di log corrispondono al filtro, fai clic su Anteprima log.

  6. (Facoltativo) Aggiungi un'etichetta nella sezione Etichette. Per istruzioni sulla creazione di etichette, consulta Creare un'etichetta.

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

gcloud

Per creare una metrica di distribuzione basata su log, crea un file contenente una rappresentazione della tua definizione di LogMetric in formato JSON o YAML. Quindi utilizza questo comando per leggere la configurazione dal tuo file:

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

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

API

Per creare una metrica di distribuzione, utilizza il metodo projects.metrics.create dell'API Logging. Puoi provare il metodo in Explorer API. Prepara gli argomenti per il metodo 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 a livello di progetto, specifica il progetto:
    projects/PROJECT_ID
    • Per una metrica basata su log con ambito a livello di 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

  • Si applicano alcune restrizioni di denominazione. Per i dettagli, 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 specifici (bucket). Una metrica di distribuzione può contenere fino a 200 bucket.

Ogni bucket ha due valori di confine, L e H, che definiscono i valori più bassi e più alti coperti dal bucket. La larghezza del bucket è H - L. Poiché non possono esserci spazi vuoti tra i bucket, il limite inferiore di un bucket è uguale al limite superiore del bucket precedente e così via. Per fare in modo che i confini non rientrino in più di un bucket, un bucket include il limite inferiore, mentre il limite superiore appartiene al bucket successivo.

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

Esistono tre modi diversi per specificare i limiti tra i bucket degli istogrammi per le metriche di distribuzione. Puoi specificare una formula per i valori dei confini o elencare i valori limite:

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

  • Exponential(scale, growth_factor, i): le larghezze dei bucket aumentano per valori più alti. I limiti sono scale * growth_factori, per i=0,1,2,...,N. Per ulteriori informazioni sui bucket esponenziali, consulta il riferimento API.

  • Esplicito: elenca tutti i limiti per i bucket nell'array bounds. Il bucket i ha questi limiti:

    Limite superiore: limiti[i] per (0 <= i < N-1)
    Limite inferiore: limiti[i - 1] per (1 <= i < N)

    Per maggiori informazioni sui bucket espliciti, consulta il Riferimento API.

La modalità di specifica dei bucket di istogrammi è spiegata nella sezione seguente:

Console

Il sottomenu Bucket istogrammi si apre quando crei una metrica di distribuzione e fai clic su Altro nel modulo Editor metriche. Di seguito è mostrato il 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 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 di 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 la loro larghezza.

Ad esempio, se l'elenco dei confini è:

0, 1, 2, 5, 10, 20

ci sono cinque bucket finiti 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 di 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 viene 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 mostrate 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 confini vengono 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 confini sono scale * growthFactor ^ 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)

Latenza nuova metrica

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

Ispezionare le metriche di distribuzione

Per elencare le metriche basate su log definite dall'utente nel progetto Google Cloud o per ispezionare una determinata metrica nel progetto Google Cloud, segui questi passaggi:

Console

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

    Vai a Metriche basate su log

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

  2. Nel riquadro Metriche definite dall'utente, puoi vedere le metriche basate su log definite dall'utente nel progetto Google Cloud attuale:

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

gcloud

Per elencare le metriche basate su log definite dall'utente nel tuo progetto Google Cloud, utilizza questo 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 questo 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 API projects.metrics.list. Inserisci 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: ottiene la pagina successiva di risultati. Per informazioni sull'uso 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. Inserisci i parametri nel metodo come segue:

  • metricName: il nome 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 maggiori dettagli sui dati delle serie temporali, consulta Lettura di 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 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 viene fatto riferimento nella 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 a livello di 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 usi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

  2. Fai clic su Modifica metrica nel Menu della metrica basata su log da modificare.

  3. Modifica gli elementi consentiti nella metrica.

  4. Fai clic su Aggiorna metrica.

gcloud

Utilizza Google Cloud CLI per modificare la descrizione di una metrica contatore, filtrare query e bucket. 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, tutti i dati delle metriche raccolti prima della modifica non rifletteranno 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 contatore, escluso METRIC_NAME, crea un file contenente la specifica aggiornata di LogMetric in formato JSON o YAML. Quindi, aggiorna la metrica chiamando il comando update con il campo --config-from-file, sostituendo FILENAME con il nome del tuo file JSON o YAML:

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

Per maggiori 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, tranne che per le modifiche e le aggiunte che vuoi apportare.

Elimina 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 usi 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 da eliminare.

gcloud

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

gcloud logging metrics delete METRIC_NAME

For more details, use the following command:


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 offre ulteriori funzionalità che consentono di gestire le metriche definite dall'utente nel progetto Google Cloud. Per maggiori dettagli, consulta il riquadro Metriche definite dall'utente.