nginx

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

Per ulteriori informazioni su nginx, consulta la documentazione di nginx.

Prerequisiti

Per raccogliere la telemetria di nginx, devi installare 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 nginx 1.18 e 1.20.

Configura l'istanza nginx

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

  1. Modifica il file status.conf o creane uno se non esiste. Puoi trovare questo file nella directory di configurazione di nginx, in genere in /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 avere il seguente aspetto:

    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

Per automatizzare i passaggi precedenti, puoi eseguire il comando seguente. Crea un file status.conf se non esiste o sovrascrive quello esistente se esiste. Il comando attiva stub_status, ricarica nginx e verifica che le informazioni previste siano esposte tramite 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, che in genere si trova in una delle seguenti directory: /etc/nginx, /usr/local/nginx/conf o /usr/local/etc/nginx.

Configurare Ops Agent per nginx

Segui la guida alla configurazione di Ops Agent, aggiungi gli elementi necessari per raccogliere la telemetria dalle istanze Nginx e riavvia l'agente.

Configurazione di esempio

I seguenti comandi creano la configurazione per raccogliere e importare la telemetria per nginx 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:
    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 un ricevitore per i log prodotti da nginx e poi una pipeline per il nuovo ricevitore.

Per configurare un destinatario per i log nginx_access, 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/nginx/access.log] Un elenco di percorsi del file system da leggere tramite il comando tail di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*).
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 nginx_access.
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.

Per configurare un destinatario per i log nginx_error, 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/nginx/error.log] Un elenco di percorsi del file system da leggere tramite il comando tail di ogni file. Nei percorsi è possibile utilizzare un carattere jolly (*).
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 nginx_error.
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 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 segnalati da nginx)
jsonPayload.level string Livello di voce di log
jsonPayload.user string Nome utente autenticato per la richiesta
severity stringa (LogSeverity) Livello di voce del log (tradotto).

I log nginx_error contengono i seguenti campi in LogEntry:

Campo Tipo Descrizione
jsonPayload.client string (Facoltativo) Indirizzo IP del client
jsonPayload.connection numero ID connessione
jsonPayload.host string Intestazione host (facoltativa)
jsonPayload.level string Livello di voce di log
jsonPayload.message string Messaggio di log
jsonPayload.pid numero L'ID processo che genera il log
jsonPayload.referer string Intestazione referrer (facoltativa)
jsonPayload.request string Richiesta HTTP originale (facoltativa)
jsonPayload.server string Nome del 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 a monte (facoltativo)
severity stringa (LogSeverity) Livello di voce del log (tradotto).

Configurazione della raccolta di metriche

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

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 nginx, specifica i seguenti campi:

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

Che cosa viene monitorato

La tabella seguente fornisce l'elenco delle metriche raccolte dall'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

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

Per verificare che i log di nginx 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("nginx_access") OR log_id("nginx_error"))

Per verificare che le metriche di nginx 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/nginx.requests'
| every 1m

Visualizza dashboard

Per visualizzare le metriche di nginx, devi avere configurato un grafico o una dashboard. L'integrazione di nginx 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 nginx 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 nginx 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 per nginx 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.

Risoluzione dei problemi

Nella maggior parte delle distribuzioni, nginx è fornito con ngx_http_stub_status_module abilitato. Puoi verificare se il modulo è abilitato eseguendo il seguente 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 è attivo. In rari casi, se il comando non restituisce alcun output, devi compilare nginx dal codice sorgente con -with-http_stub_status_module seguendo la documentazione pubblica di nginx.

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 delle applicazioni di terze parti.