nginx

L'integrazione di nginx raccoglie le metriche di connessione e i log degli accessi. Connessione acquisiscono lo stato corrente della connessione: attiva, in lettura o in attesa. I log degli accessi vengono analizzati per trovare i dettagli della connessione, che includono i campi mappati a richiesta, client, server e messaggio.

Per saperne di più su nginx, Documentazione di nginx.

Prerequisiti

Per raccogliere i dati di telemetria nginx, devi installa Ops Agent:

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

Questa integrazione supporta le versioni 1.18 e 1.20 di nginx.

Configura l'istanza nginx

Per impostare il modulo stub_status nel file di configurazione nginx, devi abilitare un URL raggiungibile a livello locale, ad esempio http://www.example.com/nginx_status per la pagina di stato. Per attivare il modulo stub_status, completa i seguenti passaggi passaggi:

  1. Modifica il file status.conf oppure crea il file se non esiste. Puoi questo file si trova nella directory di configurazione nginx, /etc/nginx/conf.d.

  2. Aggiungi le seguenti righe alla sezione server:

    location /nginx_status {
    stub_status on;
    access_log off;
    allow 127.0.0.1;
    deny all;
}

    Il file di configurazione potrebbe essere simile all'esempio seguente:

    server {
   listen 80;
   server_name 127.0.0.1;
   location /nginx_status {
       stub_status on;
       access_log off;
       allow 127.0.0.1;
       deny all;
   }
   location / {
       root /dev/null;
   }
}

  3. Ricarica la configurazione di nginx.

    sudo service nginx reload

Puoi eseguire questo comando per automatizzare i passaggi precedenti. Crea un file status.conf se non esiste o sovrascrive quello esistente, se presente esiste. Il comando attiva stub_status, ricarica nginx e verifica che le informazioni previste vengano compromesse attraverso l'endpoint.

sudo tee /etc/nginx/conf.d/status.conf > /dev/null << EOF
server {
    listen 80;
    server_name 127.0.0.1;
    location /nginx_status {
        stub_status on;
        access_log off;
        allow 127.0.0.1;
        deny all;
    }
    location / {
       root /dev/null;
    }
}
EOF
sudo service nginx reload
curl http://127.0.0.1:80/nginx_status

L'output di esempio è:

Active connections: 1
server accepts handled requests
 23 23 74
Reading: 0 Writing: 1 Waiting: 0

In alternativa, anziché utilizzare un file status.conf separato, puoi anche Incorporare direttamente le righe nel file nginx.conf principale, in genere si trova in una delle seguenti directory: /etc/nginx, /usr/local/nginx/conf o /usr/local/etc/nginx.

Configura Ops Agent per nginx

Seguendo la guida alla configurazione delle operazioni Agent, aggiungi gli elementi richiesti per raccogliere dati di telemetria dalle istanze nginx riavvia l'agente.

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare dati di telemetria per nginx e riavvia 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:
    nginx:
      type: nginx
      stub_status_url: http://127.0.0.1:80/nginx_status
  service:
    pipelines:
      nginx:
        receivers:
          - nginx
logging:
  receivers:
    nginx_access:
      type: nginx_access
    nginx_error:
      type: nginx_error
  service:
    pipelines:
      nginx:
        receivers:
          - nginx_access
          - nginx_error
EOF

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

Configura la raccolta dei log

Per importare i log da nginx, devi creare ricevitori per i log prodotto da nginx, poi crea una pipeline per i nuovi ricevitori.

Per configurare un ricevitore per i log di nginx_access, specifica quanto segue campi:

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorso del file system da escludere dal set con corrispondenza in base a include_paths.
include_paths [/var/log/nginx/access.log] Un elenco di percorsi di file system da leggere eseguendo il tailing di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*).
record_log_file_path false Se il criterio viene impostato su true, il percorso del file specifico da cui è stato ottenuto il record di 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 Il valore deve essere nginx_access.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_path. Valore come durata analizzabile da time.ParseDuration, ad esempio 30s o 2m. Questa proprietà può essere utile in caso di velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Per configurare un ricevitore per i log di nginx_error, specifica quanto segue campi:

Campo Predefinito Descrizione
exclude_paths Un elenco di pattern di percorso del file system da escludere dal set con corrispondenza in base a include_paths.
include_paths [/var/log/nginx/error.log] Un elenco di percorsi di file system da leggere eseguendo il tailing di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*).
record_log_file_path false Se il criterio viene impostato su true, il percorso del file specifico da cui è stato ottenuto il record di 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 Il valore deve essere nginx_error.
wildcard_refresh_interval 60s L'intervallo di aggiornamento dei percorsi dei file con caratteri jolly in include_path. Valore come durata analizzabile da time.ParseDuration, ad esempio 30s o 2m. Questa proprietà può essere utile in caso di velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente dell'intervallo predefinito.

Che cosa viene registrato

logName deriva da gli ID destinatario specificati nella configurazione. Campi dettagliati all'interno LogEntry sono i seguenti.

I log nginx_access contengono i seguenti campi in LogEntry:

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

I log nginx_error contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.client string Indirizzo IP client (facoltativo)
jsonPayload.connection numero ID connessione
jsonPayload.host string Intestazione host (facoltativa)
jsonPayload.level string Livello voce di log
jsonPayload.message string Messaggio di log
jsonPayload.pid numero L'ID di processo che emette il log
jsonPayload.referer string Intestazione referrer (facoltativa)
jsonPayload.request string Richiesta HTTP originale (facoltativa)
jsonPayload.server string Nome server NGINX (facoltativo)
jsonPayload.subrequest string Richiesta secondaria Nginx (facoltativa)
jsonPayload.tid numero ID thread da cui ha avuto origine il log
jsonPayload.upstream string URI della richiesta upstream (facoltativo)
severity stringa (LogSeverity) Livello voce di log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da nginx, devi creare un ricevitore per le metriche prodotto da nginx, quindi crea una pipeline per il nuovo ricevitore.

Questo ricevitore non supportare l'uso 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 distinguerli.

Per configurare un ricevitore per le metriche nginx, specifica quanto segue campi:

Campo Predefinito Descrizione
collection_interval 60s Una durata di tempo, ad esempio 30s o 5m.
server_status_url http://localhost/status L'URL esposto dal modulo dello stato stub nginx.
type Questo valore deve essere nginx.

Che cosa viene monitorato

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

Tipo di metrica
Tipo, tipo
Risorse monitorate		 Etichette
workload.googleapis.com/nginx.connections_accepted
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/nginx.connections_current
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/nginx.connections_handled
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/nginx.requests
CUMULATIVE, INT64
gce_instance 		 

Verificare la configurazione

In questa sezione viene descritto come verificare la corretta configurazione del ricevitore nginx. Potrebbero essere necessari uno o due minuti prima che Ops Agent inizi a raccogliere dati di telemetria.

per verificare che i log nginx vengano inviati Cloud Logging, segui questi passaggi:

  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("nginx_access") OR log_id("nginx_error"))

per verificare che le metriche nginx vengano inviate Cloud Monitoring, segui questi passaggi:

  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 Monitoraggio.

  2. Nella barra degli strumenti della riquadro Query Builder, seleziona il pulsante con  MQL o  PromQL.
  3. Verifica che sia selezionato MQL con l'opzione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti. 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/nginx.requests'
| every 1m

Visualizza dashboard

Per visualizzare le metriche nginx, devi avere un grafico o una dashboard configurato. L'integrazione di nginx include una o più dashboard per te. Qualsiasi dashboard viene installata automaticamente dopo integrazione e Ops Agent ha iniziato a raccogliere dati delle metriche.

Puoi anche visualizzare anteprime statiche delle dashboard senza installando 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 Monitoraggio.

  2. Seleziona la scheda Elenco dashboard, quindi scegli la Categoria Integrazioni.
  3. Fai clic sul nome della dashboard che vuoi visualizzare.

Se hai configurato un'integrazione, ma la dashboard non è stata installato, quindi verifica che Ops Agent sia in esecuzione. Quando non c'è dati delle metriche per un grafico nella dashboard, l'installazione della dashboard non riesce. Dopo 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  Integrazioni pagina:

    Vai a Integrazioni

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

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

Per saperne di più sulle dashboard in Cloud Monitoring, consulta Dashboard e grafici.

Per saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestisci le integrazioni.

Installa criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di avvisarti quando che si verifichino determinate condizioni. L'integrazione di nginx include uno o più criteri di avviso per da utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrations (Integrazioni) in monitoraggio.

Per visualizzare le descrizioni dei criteri di avviso disponibili e procedi nel seguente modo:

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

    Vai a Integrazioni

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

  2. Individua la voce per nginx e fai clic su Visualizza dettagli.
  3. Seleziona la scheda Avvisi. Questa scheda fornisce le descrizioni criteri di avviso disponibili e fornisce un'interfaccia per l'installazione che li rappresentano.
  4. Installa i criteri di avviso. I criteri di avviso richiedono per sapere dove inviare le notifiche relative a un avviso vengono attivati, quindi richiedono informazioni per l'installazione. Per installare i criteri di avviso, segui questi passaggi:
    1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli da installare.

    2. Nella sezione Configura notifiche, seleziona una o più canali di notifica. Puoi scegliere di disattivare i canali di notifica, ma se lo fai, la funzione si attivano automaticamente. Puoi verificarne lo stato nella Monitoraggio, ma non riceverai notifiche.

      Per ulteriori informazioni sui canali di notifica, consulta Gestire canali di notifica.

    3. Fai clic su Crea criteri.

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

Per saperne di più sull'utilizzo della pagina Integrazioni, vedi Gestisci le integrazioni.

Risoluzione dei problemi

Nella maggior parte delle distribuzioni, nginx è abilitato per ngx_http_stub_status_module. Puoi verificare se il modulo è abilitato eseguendo questo comando:

sudo nginx -V 2>&1 | grep -o with-http_stub_status_module

L'output previsto è with-http_stub_status_module, il che significa che il modulo sia abilitato. In rari casi, se il comando non restituisce alcun output, è necessario compilare nginx dall'origine con -with-http_stub_status_module che segue nginx documentazione pubblica.

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configura un un'applicazione di terze parti e installare una dashboard di esempio, consulta Video: installa Ops Agent per risolvere i problemi relativi alle applicazioni di terze parti.