Configurare le etichette per le metriche basate su log

Questo documento illustra le etichette delle metriche basate su log e spiega come crearle e usarle.

Se conosci le etichette, puoi andare direttamente a Creare un'etichetta in questa pagina.

Panoramica delle etichette per le metriche basate su log

Le etichette consentono alle metriche basate su log di contenere più serie temporali, una per ogni combinazione di valori delle etichette. Tutte le metriche basate su log sono dotate di alcune etichette predefinite.

Puoi creare altre etichette definite dall'utente sia nelle metriche di tipo contatore sia in quelle di tipo distribuzione specificando le espressioni dell'estrattore. Un'espressione dell'estrattore indica a Cloud Logging come estrarre il valore dell'etichetta dalle voci dei log. Puoi specificare il valore dell'etichetta come uno dei seguenti:

• L'intero contenuto di un campo denominato nell'oggetto LogEntry.
• Una parte di un campo denominato che corrisponde a un'espressione regolare (regexp).

Puoi estrarre le etichette dai campi integrati di LogEntry, ad esempio httpRequest.status, o da uno dei campi del payload textPayload, jsonPayload o protoPayload.

Per informazioni sulle espressioni regolari, consulta la pagina sulla sintassi RE2.

Non inserire informazioni sensibili nell'espressione dell'estrattore e non estrarre dati sensibili nelle etichette. Questi dati vengono trattati come dati di servizio.

Nota: crea le etichette solo quando devi identificare i valori per classificare o riepilogare i dati delle metriche. Non utilizzare le etichette per assegnare nomi ai campi di dati.

Limitazioni delle etichette definite dall'utente

Alle etichette definite dall'utente si applicano le seguenti limitazioni:

• Puoi creare fino a 10 etichette definite dall'utente per metrica.

• Una volta creata un'etichetta, non puoi eliminarla.

  • Puoi modificare l'espressione dell'estrattore e la descrizione dell'etichetta che hai già creato.

  • Non puoi modificare il nome o il tipo di valore di un'etichetta che hai già creato.

• Vengono conservati solo i primi 1024 caratteri di un valore dell'etichetta.

• Ogni metrica basata su log è limitata a circa 30.000 serie temporali attive, il che dipende dal numero di valori possibili per ogni etichetta, incluse le etichette predefinite.

  Ad esempio, se le voci di log provengono da 100 risorse come le istanze VM e definisci un'etichetta con 20 valori possibili, puoi avere fino a 2000 serie temporali per la metrica.

Attenzione: non estrarre mai un valore dell'etichetta univoco per ogni voce di log, ad esempio i campi insertId o timestamp completi. Avrai tante serie temporali quante sono le voci di log, ognuna contenente un punto.

Se hai troppe serie temporali o troppi punti dati, i costi aumenteranno e la tua attività potrebbe essere limitata. Per ulteriori informazioni sul costo delle metriche basate su log, consulta Prezzi di Cloud Monitoring: metriche fatturabili. Per informazioni sui limiti che si applicano alle metriche basate su log, consulta Quote e limiti: metriche basate su log e Risolvere i problemi relativi alle metriche basate su log.

Etichette predefinite

Tutte le metriche basate su log sono dotate di alcune etichette predefinite:

• Etichette delle risorse: tutte le metriche utilizzano un oggetto risorsa monitorata per identificare la fonte dei dati delle serie temporali. Ogni tipo di risorsa include un nome di tipo e una o più etichette. Esempi di tipi di risorse includono istanze VM, database Cloud SQL e bilanciatori del carico.

  La risorsa e le relative etichette sono elencate separatamente dalle altre etichette delle metriche in Cloud Monitoring, ma hanno lo stesso effetto: creano serie temporali aggiuntive nella metrica. Per ulteriori informazioni, consulta Metriche, serie temporali e risorse.

• log: questa etichetta contiene il valore della parte LOG_ID del logName campo nelle voci di log.

• severity: questa etichetta contiene il valore del campo severity nelle voci del log. L'etichetta della gravità viene fornita per impostazione predefinita solo nelle metriche basate su log di sistema.

Esempio: utilizzare Metrics Explorer

Lo screenshot seguente di Metrics Explorer mostra le etichette di una delle metriche basate sui log di sistema. Per visualizzare l'elenco delle etichette, fai clic all'interno della casella Filtro:

Lo screenshot mostra le seguenti informazioni:

• Metrics Explorer utilizza le serie temporali della metrica logging/log_entry_count e del tipo di risorsa gce_instance: istanze VM Compute Engine.

  Questa metrica contiene anche serie temporali di altri tipi di risorse, ma Metrics Explorer ti consente di esaminare un solo tipo di risorsa alla volta.

• Il tipo di risorsa gce_instance ha tre etichette delle risorse: project_id, instance_id e zone.

• La metrica ha due etichette delle metriche: log e severity. Anche le etichette definite dall'utente vengono visualizzate in questa sezione.

Crea un'etichetta

Le etichette definite dall'utente vengono create quando crei la metrica. Sia le metriche dei contatori sia quelle di distribuzione possono avere etichette. Non puoi aggiungere etichette alle metriche basate su log di sistema.

Console

1. Quando crei una metrica basata su log, nel riquadro Crea metrica basata su log è inclusa un'opzione per aggiungere etichette.

2. Fai clic su Aggiungi etichetta.

   Suggerimento: per visualizzare i campi e i valori all'interno di una voce di log, segui questi passaggi:

   1. Nella sezione Selezione filtro, fai clic su Anteprima dei log.
   2. Nel riquadro Visualizza log, scegli una voce di log e fai clic sul pulsante di espansione accanto.
   3. Fai clic su Espandi campi nidificati.

3. Imposta i seguenti campi nella sezione Etichette:

   1. Nome etichetta: inserisci un nome per l'etichetta. Ad esempio, ID.
      

      Il nome deve soddisfare i seguenti criteri:

      • Non deve contenere più di 100 caratteri.
      • Corrisponde all'espressione regolare [a-zA-Z][a-zA-Z0-9_]*.
      • Non deve essere costituito solo dalla stringa "log".

   2. Descrizione: descrivi l'etichetta. Cerca di essere il più specifico possibile sul formato dei valori dei log previsti. Ad esempio, Instance number.

   3. Tipo di etichetta: scegli Stringa, Booleano o Intero.

   4. Nome campo: inserisci il nome del campo della voce di log contenente il valore dell'etichetta. Ti vengono offerte delle opzioni durante la digitazione. In questo esempio, il campo è:

      labels."compute.googleapis.com/resource_id"
      

   5. Espressione regolare: se il valore dell'etichetta è costituito da tutti i contenuti del campo, puoi lasciare vuoto questo campo. In caso contrario, specifica un gruppo di cattura regexp che estrae il valore dell'etichetta dal valore del campo.

      Ad esempio, supponiamo che il campo contenga in genere testo come il seguente:

      The instance number is 0123456789; the ID is my-test-instance22
      

      Se vuoi che il valore dell'etichetta sia il numero di istanze, esistono molte espressioni regolari che estraggono il numero corretto. Ad esempio, nella seguente espressione, le parentesi sono un gruppo di cattura che identifica la parte del testo che verrà estratta:

      The instance number is ([0-9]+); .*
      

      Per ulteriori informazioni sulle espressioni regolari, vedi Sintassi RE2.

4. Fai clic su Fine per creare l'etichetta. Puoi aggiungere altre etichette ripetendo questi passaggi.

5. Per completare la creazione della metrica, fai clic su Crea metrica.

gcloud

Per creare una metrica basata su log con etichette personalizzate, devi creare un file che contenga una rappresentazione della definizione di LogMetric in formato JSON o YAML, incluse le etichette personalizzate. Quindi, crea la metrica chiamando il comando create con il flag --config-from-file, sostituendo FILENAME con il nome del file JSON o YAML:

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

Per ulteriori informazioni, consulta gcloud logging metrics create.

API

Le etichette vengono specificate nell'ambito dell'oggetto LogMetric nel corpo della richiesta delle chiamate al metodo projects.metrics.create dell'API Logging. Per informazioni sulle chiamate complete dei metodi, consulta Creare metriche contatore o Creare metriche di distribuzione.

Per ogni etichetta, devi aggiungere un segmento sia ai campi metricDescriptor sia ai campi labelExtractors in LogMetric.

La sintassi è la seguente:

{
  ...
  metricDescriptor: {
      labels: [
        { key: LABEL_NAME, valueType: LABEL_TYPE,
          description: LABEL_DESCRIPTION },
        ...
      ]
  },
  labelExtractors: {
    LABEL_NAME: EXTRACTOR_EXPRESSION,
    ...
  },
}

Gli elementi di sintassi hanno il seguente significato:

• LABEL_NAME: il nome dell'etichetta come stringa.
• VALUE_TYPE: il tipo di etichetta: STRING, BOOL o INT64.
• LABEL_DESCRIPTION: una descrizione dell'etichetta.

• EXTRACTOR_EXPRESSION: una stringa che combina il nome del campo della voce di log con un'espressione regolare facoltativa. L'espressione dell'estrattore può essere una delle seguenti:

  EXTRACT(FIELD)
  

  REGEXP_EXTRACT(FIELD, REGEXP)
  

Per saperne di più sulle espressioni regolari, consulta la pagina sulla sintassi RE2.

Di seguito è riportato un esempio con due etichette:

{
  ...
  metricDescriptor: {
      labels: [
        { key: "label_name_a", valueType: STRING },
        { key: "label_name_b", valueType: INT64 },
      ]
  },
  labelExtractors: {
    "label_name_a":
      "REGEXP_EXTRACT(jsonPayload.field_a, \"before ([a-zA-Z ]+) after\")",
    "label_name_b": "EXTRACT(jsonPayload.field_b)",
  },
}

Per maggiori dettagli, consulta il tipo LogMetric.