Cache HTTP Varnish

L'integrazione di Varnish raccoglie le metriche relative a cache e sessioni. Monitora il numero di oggetti che entrano ed escono dalla cache, nonché il numero di sessioni e connessioni di backend. L'integrazione raccoglie anche i log di Varnish e li analizza in un payload JSON standardizzato.

Per ulteriori informazioni su Varnish, consulta la documentazione della cache HTTP Varnish.

Prerequisiti

Per raccogliere la telemetria di Varnish, devi installare Ops Agent:

  • Per le metriche, installa la versione 2.15.0 o successive.
  • Per i log, installa la versione 2.16.0 o successiva.

Questa integrazione supporta le versioni 6.x e 7.0.x di Varnish.

Configura l'istanza Varnish

Il processore di log Varnish elabora i log utilizzando varnishncsa. Varnish può attivare il logging varnishncsa seguendo questa guida, a seconda del sistema operativo.

Per impostazione predefinita, i log vengono scritti in /var/log/varnish/varnishncsa.log. Se scegli un'altra destinazione, devi aggiornare la configurazione del ricevitore. I log dovrebbero essere nel formato predefinito e deve essere configurata una rotazione dei log.

Configurare Ops Agent per Varnish

Seguendo la guida alla configurazione di Ops Agent, aggiungi gli elementi necessari per raccogliere i dati di telemetria dalle istanze Varnish e riavvia l'agente.

Configurazione di esempio

I seguenti comandi creano la configurazione per raccogliere e importare la telemetria per Varnish e riavviare Ops Agent.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    varnish:
      type: varnish
  service:
    pipelines:
      varnish:
        receivers:
          - varnish
logging:
  receivers:
    varnish:
      type: varnish
  service:
    pipelines:
      varnish:
        receivers:
          - varnish

EOF

sudo service google-cloud-ops-agent restart
sleep 30

Configura la raccolta dei log

Per importare i log da Varnish, devi creare un ricevitore per i log prodotti da Varnish e poi una pipeline per il nuovo ricevitore.

Per configurare un destinatario per i log varnish, specifica i seguenti campi:

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorsi del file system da escludere dall'insieme corrispondente a include_paths.
include_paths [/var/log/varnish/varnishncsa.log] Un percorso del log varnishncsa predefinito da leggere tramite il monitoraggio di ciascun file.
record_log_file_path false Se impostato su true, il percorso del file specifico da cui è stato ottenuto il record del log viene visualizzato nella voce di log di output come valore dell'etichetta agent.googleapis.com/log_file_path. Quando utilizzi un carattere jolly, viene registrato solo il percorso del file da cui è stato ottenuto il record.
type Questo valore deve essere varnish.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi file con caratteri jolly in include_paths. Specificato come durata, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile in caso di flussi di lavoro elevati per la registrazione, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Che cosa viene registrato nei log

Il logName è ricavato dagli ID dei destinatari specificati nella configurazione. I campi dettagliati all'interno di LogEntry sono i seguenti.

I log varnish contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
httpRequest oggetto Leggi HttpRequest
jsonPayload.host string Contenuti dell'intestazione Host
jsonPayload.user string Nome utente autenticato per la richiesta
severity stringa (LogSeverity) Livello di voce del log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da Varnish, devi creare un destinatario per le metriche prodotte da Varnish e poi una pipeline per il nuovo destinatario.

Questo ricevitore non supporta l'utilizzo di più istanze nella configurazione, ad esempio per monitorare più endpoint. Tutte queste istanze scrivono nella stessa serie temporale e Cloud Monitoring non ha modo di distinguerle.

Per configurare un destinatario per le metriche varnish, specifica i seguenti campi:

Campo Predefinito Descrizione
cache_dir Specifica il nome dell'istanza della directory della cache da utilizzare per la raccolta delle metriche. Se non specificato, il valore predefinito è l'host.
collection_interval 60s Un valore di durata, ad esempio 30s o 5m.
exec_dir La directory in cui si trovano i file eseguibili varnishadm e varnishstat. Se non specificato, presuppone che gli eseguibili siano nella cartella PATH dell'utente.
type Questo valore deve essere varnish.

Che cosa viene monitorato

La tabella seguente fornisce l'elenco delle metriche raccolte dall'Ops Agent dall'istanza Varnish.

Tipo di metrica 
Tipo, Tipo
Risorse monitorate		 Etichette
workload.googleapis.com/varnish.backend.connection.count
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/varnish.backend.request.count
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/varnish.cache.operation.count
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/varnish.client.request.count
CUMULATIVE, INT64
gce_instance 		state
workload.googleapis.com/varnish.client.request.error.count
CUMULATIVE, INT64
gce_instance 		status_code
workload.googleapis.com/varnish.object.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/varnish.object.expired
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/varnish.object.moved
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/varnish.object.nuked
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/varnish.session.count
CUMULATIVE, INT64
gce_instance 		kind
workload.googleapis.com/varnish.thread.operation.count
CUMULATIVE, INT64
gce_instance 		operation

Verificare la configurazione

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore Varnish. L'avvio della raccolta della telemetria da parte di Ops Agent potrebbe richiedere uno o due minuti.

Per verificare che i log di Varnish vengano inviati a Cloud Logging:

  1. Nella console Google Cloud, vai alla pagina Esplora log:

    Vai a Esplora log

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

  2. Inserisci la seguente query nell'editor e poi fai clic su Esegui query: 
    resource.type="gce_instance"
log_id("varnish")

Per verificare che le metriche di Varnish vengano inviate a Cloud Monitoring, procedi nel seguente modo:

  1. Nella console Google Cloud, vai alla pagina  Esplora metriche:

    Vai a Esplora metriche

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

  2. Nella barra degli strumenti del riquadro Query Builder, seleziona il pulsante  MQL o  PromQL.
  3. Verifica che sia selezionato MQL nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti che consente di formattare la query.
  4. Inserisci la seguente query nell'editor e poi fai clic su Esegui query: 
    fetch gce_instance
| metric 'workload.googleapis.com/varnish.backend.connection.count'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di Varnish, devi avere configurato un grafico o una dashboard. L'integrazione di Varnish include una o più dashboard. Le dashboard vengono installate automaticamente dopo aver configurato l'integrazione e dopo che Ops Agent ha iniziato a raccogliere i dati delle metriche.

Puoi anche visualizzare anteprime statiche delle dashboard senza installare l'integrazione.

Per visualizzare una dashboard installata:

  1. Nella console Google Cloud, vai alla pagina  Dashboard:

    Vai a Dashboard

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

  2. Seleziona la scheda Elenco dashboard e poi scegli la categoria Integrazioni.
  3. Fai clic sul nome della dashboard che vuoi visualizzare.

Se hai configurato un'integrazione, ma la dashboard non è stata installata, controlla che l'Ops Agent sia in esecuzione. Se non sono disponibili dati metrici per un grafico nella dashboard, l'installazione della dashboard non va a buon fine. Una volta che Ops Agent inizia a raccogliere le metriche, la dashboard viene installata per te.

Per visualizzare un'anteprima statica della dashboard:

  1. Nella console Google Cloud, vai alla pagina  Integrazioni:

    Vai a Integrations (Integrazioni).

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

  2. Fai clic sul filtro della piattaforma di deployment Compute Engine.
  3. Individua la voce relativa a Varnish e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard per visualizzare un'anteprima statica. Se la dashboard è installata, puoi accedervi facendo clic su Visualizza dashboard.

Per ulteriori informazioni sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.

Per ulteriori informazioni sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Installa i criteri di avviso

I criteri di avviso chiedono a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specifiche. L'integrazione di Varnish include uno o più criteri di avviso da utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrazioni in Monitoraggio.

Per visualizzare le descrizioni dei criteri di avviso disponibili e installarli:

  1. Nella console Google Cloud, vai alla pagina  Integrazioni:

    Vai a Integrations (Integrazioni).

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

  2. Individua la voce relativa a Varnish e fai clic su Visualizza dettagli.
  3. Seleziona la scheda Avvisi. Questa scheda fornisce descrizioni dei criteri di avviso disponibili e un'interfaccia per installarli.
  4. Installa i criteri di avviso. I criteri di avviso devono sapere dove inviare le notifiche che indicano che l'avviso è stato attivato, quindi richiedono informazioni da te per l'installazione. Per installare i criteri di avviso:
    1. Nell'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

    2. Nella sezione Configura notifiche, seleziona uno o più canali di notifica. Hai la possibilità di disattivare l'utilizzo dei canali di notifica, ma in questo caso i criteri di avviso vengono attivati in modo silenzioso. Puoi controllarne lo stato in monitoraggio, ma non ricevi notifiche.

      Per saperne di più sui canali di notifica, consulta la pagina Gestire i canali di notifica.

    3. Fai clic su Crea criteri.

Per ulteriori informazioni sui criteri di avviso in Cloud Monitoring, consulta la pagina Introduzione agli avvisi.

Per ulteriori informazioni sull'utilizzo della pagina Integrazioni, consulta Gestire le integrazioni.

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare l'Ops Agent, configurare un'applicazione di terze parti e installare una dashboard di esempio, guarda il video Installa l'Ops Agent per risolvere i problemi relativi alle applicazioni di terze parti.