Utilizzo delle metriche basate su log

Questa pagina illustra le nozioni di base sull'invio dei log per creare SLI di disponibilità e latenza. Fornisce inoltre esempi di implementazione di come definire gli SLO utilizzando le metriche basate su log.

L'uso di elementi di dati nelle voci di log per creare indicatori del livello del servizio è un modo per sfruttare i payload di log esistenti. In caso contrario, potrebbe essere possibile aggiungere il logging a un servizio esistente, il che potrebbe essere più semplice rispetto alla creazione della strumentazione delle metriche.

Log e metriche

I log raccolgono record chiamati voci di log che descrivono eventi specifici che si verificano nei sistemi informatici. I log vengono scritti dal codice, dai servizi della piattaforma su cui viene eseguito il codice (ad esempio Dataflow) e dall'infrastruttura da cui dipende la piattaforma (ad esempio, le istanze di Compute Engine).

Poiché i log nei sistemi moderni discendono, e talvolta lo sono, da file di testo scritti su disco, una voce di log è analoga a una riga in un file di log e può essere considerata l'unità quantica del logging.

Una voce di log è composta minimo da due cose:

  • Un timestamp che indica quando si è verificato l'evento o quando è stato importato nel sistema di logging.
  • Payload testo, come dati di testo non strutturati o dati strutturati, più comunemente in JSON.

I log possono anche includere metadati associati, soprattutto quando vengono importati in Cloud Logging. Questi metadati potrebbero includere la risorsa che sta scrivendo il log, il nome del log e il livello di gravità per ogni voce.

Log

I log vengono utilizzati per due scopi principali:

  • I log degli eventi descrivono eventi specifici che si verificano all'interno del sistema. Puoi utilizzare i log eventi per inviare messaggi che provvedono agli utenti che le cose funzionano correttamente ("attività completata") o per fornire informazioni quando si verificano errori ("ricevuta eccezione dal server").
  • I log delle transazioni descrivono i dettagli di ogni transazione elaborata da un sistema o un componente. Ad esempio, un bilanciatore del carico registra ogni richiesta ricevuta, indipendentemente dal fatto che sia stata completata correttamente o meno, e registra informazioni aggiuntive come l'URL richiesto, il codice di risposta HTTP ed eventualmente informazioni come il backend utilizzato per gestire la richiesta.

Metriche

A differenza dei log, le metriche di solito non descrivono eventi specifici. Più comunemente, le metriche vengono utilizzate per rappresentare lo stato o l'integrità di un sistema nel tempo. Una metrica è composta da una serie di punti dati che misurano qualcosa sul sistema; ogni punto dati include un timestamp e un valore numerico.

Alle metriche possono essere associati anche metadati. La serie di punti dati, indicata come serie temporale, potrebbe includere informazioni quali il nome della metrica, una descrizione e spesso etichette che specificano quale risorsa scrive i dati. Per informazioni sul modello di metrica di Monitoring, consulta Metriche, serie temporali e risorse.

Metriche basate su log

Le metriche basate su log sono metriche create dalle voci di log estraendo le informazioni dalle voci di log e trasformandole in dati di serie temporali. Cloud Logging fornisce meccanismi per creare due tipi di metriche dalle voci di log:

  • Metriche contatore, che contano il numero di voci di log corrispondenti a un determinato filtro. Puoi utilizzare una metrica dei contatori per determinare, ad esempio, il numero di richieste o errori registrati nel log.

  • Metriche di distribuzione, che utilizzano espressioni regolari per analizzare il payload in ciascuna voce di log al fine di estrarre i valori numerici come distribuzione.

Per saperne di più sulle metriche basate su log in Cloud Logging, consulta Utilizzo delle metriche basate su log.

uso di metriche basate su log come SLI

Le metriche basate su log consentono di estrarre i dati dai log in un formato che puoi utilizzare per creare SLI in Monitoring:

  • Puoi utilizzare le metriche dei contatori basate su log per esprimere uno SLI di disponibilità basato sulle richieste.

  • Puoi utilizzare una metrica di distribuzione basata su log per esprimere uno SLI di latenza basato su richiesta.

Voci di log di esempio

L'applicazione Stack Doctor è un esempio di servizio in grado di emettere messaggi di log contenenti informazioni su tutte le richieste, gli errori e la latenza relativi al servizio. Il codice per il servizio è disponibile nel repository GitHub di stack-doctor.

Il servizio genera voci di log di Cloud Logging nel log projects/stack-doctor/logs/bunyan_log. La voce di log per ogni tipo di evento include un valore message diverso. Le voci di log per diversi tipi di eventi hanno il seguente aspetto:

  • A ogni richiesta:

    {
  "insertId": "..........iTRVT5MOK2VOsVe31bzrTD",
  "jsonPayload": {
    "pid": 81846,
    "time": "Mon Aug 31 2020 20:30:49 GMT-0700 (Pacific Daylight Time)",
    "hostname": "<hostname>",
    "level": 30,
    "message": "request made",
    "v": 0,
    "name": "sli-log"
  },
    "resource": {
    "type": "global",
    "labels": {
      "project_id": "stack-doctor"
    }
  },
  "timestamp": "2020-09-01T03:30:49.263999938Z",
  "severity": "INFO",
  "logName": "projects/stack-doctor/logs/bunyan_log",
  "receiveTimestamp": "2020-09-01T03:30:50.003471183Z"
}

  • Per le richieste andate a buon fine:

    {
  "insertId": "..........qTRVT5MOK2VOsVe31bzrTD",
  "jsonPayload": {
    "name": "sli-log",
    "v": 0,
    "pid": 81846,
    "level": 30,
    "hostname": "<hostname>",
    "time": "Mon Aug 31 2020 20:30:49 GMT-0700 (Pacific Daylight Time)",
    "message": "success!"
  },
  "resource": {
    "type": "global",
    "labels": {
      "project_id": "stack-doctor"
    }
  },
  "timestamp": "2020-09-01T03:30:49.874000072Z",
  "severity": "INFO",
  "logName": "projects/stack-doctor/logs/bunyan_log",
  "receiveTimestamp": "2020-09-01T03:30:50.201547371Z"
}

  • Per le richieste completate:

    {
  "insertId": "..........mTRVT5MOK2VOsVe31bzrTD",
  "jsonPayload": {
    "time": "Mon Aug 31 2020 20:30:49 GMT-0700 (Pacific Daylight Time)",
    "level": 30,
    "name": "sli-log",
    "message": "slept for 606 ms",
    "hostname": "<hostname>",
    "pid": 81846,
    "v": 0
  },
  "resource": {
    "type": "global",
    "labels": {
      "project_id": "stack-doctor"
    }
  },
  "timestamp": "2020-09-01T03:30:49.874000072Z",
  "severity": "INFO",
  "logName": "projects/stack-doctor/logs/bunyan_log",
  "receiveTimestamp": "2020-09-01T03:30:50.201547371Z"
}

  • In caso di errore:

    {
  "insertId": "..........DTRVT5MOK2VOsVe31bzrTD",
  "jsonPayload": {
    "hostname": "<hostname>",
    "level": 50,
    "pid": 81846,
    "message": "failure!",
    "name": "sli-log",
    "time": "Mon Aug 31 2020 20:30:44 GMT-0700 (Pacific Daylight Time)",
    "v": 0
  },
  "resource": {
    "type": "global",
    "labels": {
      "project_id": "stack-doctor"
    }
  },
  "timestamp": "2020-09-01T03:30:44.414999961Z",
  "severity": "ERROR",
  "logName": "projects/stack-doctor/logs/bunyan_log",
  "receiveTimestamp": "2020-09-01T03:30:46.182157077Z"
}

In base a queste voci, puoi creare metriche basate su log che contano tutte le richieste, conteggiano gli errori e monitorano la latenza delle richieste. Puoi quindi utilizzare le metriche basate su log per creare SLI di disponibilità e latenza.

Creazione di metriche basate su log per gli SLI.

Prima di poter creare SLI sulle metriche basate su log, è necessario creare le metriche basate su log.

  • Per gli SLI di disponibilità relativi al conteggio delle richieste e degli errori, utilizza le metriche dei contatori basate su log.
  • Per gli SLI di latenza, utilizza le metriche di distribuzione basate su log.

Dopo aver creato le metriche basate su log, puoi trovarle in Monitoring cercandole in Metrics Explorer. In Monitoring, le metriche basate su log hanno il prefisso logging.googleapis.com/user.

Metriche per gli SLI di disponibilità

Puoi esprimere uno SLI di disponibilità basata sulle richieste nell'API Cloud Monitoring utilizzando la struttura TimeSeriesRatio per configurare un rapporto tra richieste "valide" o "non valide" e richieste totali. Questo rapporto viene utilizzato nel campo goodTotalRatio di una struttura RequestBasedSli.

Devi creare metriche dei contatori basate su log che possono essere utilizzate per creare questo rapporto. Devi creare almeno due dei seguenti elementi:

  1. Una metrica che conta gli eventi totali. Utilizza questa metrica nel valore totalServiceFilter del rapporto.

    Per l'esempio "stack-doctor", puoi creare una metrica basata su log che conteggia le voci di log in cui viene visualizzata la stringa del messaggio "request made".

  2. Se utilizzi una metrica che conteggia gli eventi "non validi", utilizza questa metrica nel valore badServiceFilter del rapporto.

    Per l'esempio "stack-doctor", puoi creare una metrica basata su log che conteggia le voci di log in cui viene visualizzata la stringa del messaggio "failure!".

  3. Se utilizzi una metrica che conteggia gli eventi "validi", utilizzala nel valore goodServiceFilter del rapporto.

    Per l'esempio "stack-doctor", puoi creare una metrica basata su log che conteggia le voci di log in cui viene visualizzata la stringa del messaggio "success!".

Lo SLI descritto in questo esempio si basa su una metrica per le richieste totali denominata log_based_total_requests e su una metrica per gli errori denominata log_based_errors.

Puoi creare metriche basate su log utilizzando la console Google Cloud, l'API Cloud Logging o Google Cloud CLI. Per creare metriche dei contatori basate su log utilizzando la console Google Cloud, puoi utilizzare la seguente procedura:

  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.

    La pagina delle metriche basate su log mostra una tabella di metriche definite dall'utente e una di metriche definite dal sistema.

  2. Fai clic su Crea metrica sopra la tabella delle metriche definite dall'utente.

  3. Nel riquadro Tipo di metrica, seleziona Contatore.

  4. Nel riquadro Dettagli, assegna un nome alla nuova metrica. Per l'esempio "stack-doctor", inserisci log_based_total_requests o log_based_errors.

    Puoi ignorare gli altri campi di questo esempio.

  5. Nel riquadro Selezione filtro, crea una query che recuperi solo le voci di log che vuoi conteggiare nella metrica.

    Per l'esempio "stack-doctor", la query per log_based_total_requests potrebbe includere quanto segue:

    resource.type="global"
logName="projects/stack-doctor/logs/bunyan_log"
jsonPayload.message="request made"

    La query per logs_based_errors modifica la stringa del messaggio:

    resource.type="global"
logName="projects/stack-doctor/logs/bunyan_log"
jsonPayload.message="failure!"

  6. Fai clic su Anteprima log per verificare il filtro e, se necessario, modificarlo.

  7. Ignora il riquadro Etichette per questo esempio.

  8. Fai clic su Crea metrica per completare la procedura.

Per saperne di più sulla creazione delle metriche dei contatori basate su log, consulta Creazione di una metrica dei contatori.

Metriche per gli SLI di latenza

Puoi esprimere uno SLI di latenza basata sulle richieste nell'API Cloud Monitoring utilizzando una struttura DistributionCut utilizzata nel campo distributionCut di una struttura RequestBasedSli. Per creare uno SLI di latenza, devi creare una metrica di distribuzione basata su log. In questo esempio viene creata una metrica di distribuzione basata su log denominata log_based_latency.

Puoi creare metriche basate su log utilizzando la console Google Cloud, l'API Cloud Logging o Google Cloud CLI. Per creare metriche di distribuzione basate su log utilizzando la console Google Cloud, puoi utilizzare la seguente procedura:

  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.

    La pagina delle metriche basate su log mostra una tabella di metriche definite dall'utente e una di metriche definite dal sistema.

  2. Fai clic su Crea metrica sopra la tabella delle metriche definite dall'utente.

  3. Nel riquadro Tipo di metrica, seleziona Distribuzione.

  4. Nel riquadro Dettagli, assegna un nome alla nuova metrica. Per l'esempio "stack-doctor", inserisci log_based_latency.

    Puoi ignorare gli altri campi di questo esempio.

  5. Nel riquadro Selezione filtro, crea una query che recuperi solo le voci di log che vuoi conteggiare nella metrica.

    Per l'esempio "stack-doctor", la query per log_based_latency potrebbe includere quanto segue:

    resource.type="global"
logName="projects/stack-doctor/logs/bunyan_log"
jsonPayload.message="slept for"

    Specifica i seguenti campi per la query di filtro:

    • Nome campo: json.message

    • Espressione regolare: \s(\d*)\s

      Il formato della stringa del messaggio per le richieste completate è "solto per n ms". L'espressione regolare estrae il valore di latenza n dalla stringa.

  6. Ignora il riquadro Etichette per questo esempio.

  7. Fai clic su Crea metrica per completare la procedura.

Per ulteriori informazioni sulla creazione delle metriche di distribuzione basate su log, consulta Creazione delle metriche di distribuzione.

SLI di disponibilità

In Cloud Monitoring, puoi esprimere uno SLI di disponibilità basato su richiesta utilizzando una struttura TimeSeriesRatio. L'esempio seguente mostra uno SLO che utilizza le metriche log_based_total_requests e log_based_errors nel rapporto. Questo SLO prevede che il rapporto tra richieste "valide" e totali sia di almeno il 98% su un periodo continuativo di 24 ore:

{
 "serviceLevelIndicator": {
   "requestBased": {
     "goodTotalRatio": {
       "totalServiceFilter":
         "metric.type=\"logging.googleapis.com/user/log_based_total_requests\"
          resource.type=\"global\"",
       "badServiceFilter":
         "metric.type=\"logging.googleapis.com/user/log_based_errors\"
          resource.type=\"global\""
     }
   }
 },
 "goal": 0.98,
 "rollingPeriod": "86400s",
 "displayName": "Log-Based Availability"
}

SLI di latenza

In Cloud Monitoring, puoi esprimere uno SLI di latenza basato sulle richieste utilizzando una struttura DistributionCut. L'esempio seguente mostra uno SLO che utilizza la metrica log_based_latency e prevede che il 98% delle richieste sia inferiore a 500 ms in un periodo continuativo di 24 ore:

{
  "serviceLevelIndicator": {
    "requestBased": {
      "distributionCut": {
        "distributionFilter":
          "metric.type=\"logging.googleapis.com/user/log_based_latency\"
          resource.type=\"global\"",
        "range": {
          "min": 0,
          "max": 500
        }
      }
    }
  },
  "goal": 0.98,
  "rollingPeriod": "86400s",
  "displayName": "98% requests under 500 ms"
}

Risorse aggiuntive