nginx

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

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

Prerequisiti

Per raccogliere la telemetria 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 successive.

Questa integrazione supporta le versioni nginx 1.18 e 1.20.

Configura la tua istanza nginx

Devi abilitare il modulo stub_status nel file di configurazione nginx per impostare un URL raggiungibile a livello locale, ad esempio http://www.example.com/nginx_status per la pagina di stato. Per abilitare 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 nginx, in genere all'indirizzo /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 al seguente esempio:

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

Nota: 127.0.0.1 può essere sostituito con il nome reale del server, ad esempio server_name mynginx.domain.com. Il comando curl da verificare sarebbe curl http://mynginx.domain.com:80/nginx_status.

In alternativa, invece di 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.

Configura Ops Agent per nginx

Seguendo la guida per configurare Ops Agent, aggiungi gli elementi richiesti per raccogliere i dati di telemetria dalle istanze nginx e riavvia l'agente.

Configurazione di esempio

I comandi seguenti creano la configurazione per raccogliere e importare la telemetria di 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 prodotti da nginx, quindi creare una pipeline per i nuovi ricevitori.

Per configurare un ricevitore 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 dal set corrispondente da include_paths.
include_paths	[/var/log/nginx/access.log]	Un elenco di percorsi di file system da leggere mediante il tailing di ogni file. È possibile utilizzare un carattere jolly (*) nei percorsi.
record_log_file_path	false	Se il criterio è 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 con cui vengono aggiornati i percorsi dei file con caratteri jolly in include_paths. Data come durata di tempo analizzabile da time.ParseDuration, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile con velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito.

Per configurare un ricevitore 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 dal set corrispondente da include_paths.
include_paths	[/var/log/nginx/error.log]	Un elenco di percorsi di file system da leggere mediante il tailing di ogni file. È possibile utilizzare un carattere jolly (*) nei percorsi.
record_log_file_path	false	Se il criterio è 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 con cui vengono aggiornati i percorsi dei file con caratteri jolly in include_paths. Data come durata di tempo analizzabile da time.ParseDuration, ad esempio 30s o 2m. Questa proprietà potrebbe essere utile con velocità effettiva di logging elevate, in cui i file di log vengono ruotati più velocemente rispetto all'intervallo predefinito.

Cosa viene registrato

logName deriva dagli ID destinatario specificati nella configurazione. Di seguito sono riportati i campi dettagliati all'interno della LogEntry.

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 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	number	ID connessione
jsonPayload.host	string	Intestazione host (facoltativa)
jsonPayload.level	string	Livello di voce di log
jsonPayload.message	string	Messaggio di log
jsonPayload.pid	number	L'ID di processo che emette il log
jsonPayload.referer	string	Intestazione referer (facoltativa)
jsonPayload.request	string	Richiesta HTTP originale (facoltativo)
jsonPayload.server	string	Nome server Nginx (facoltativo)
jsonPayload.subrequest	string	(Facoltativo) Richiesta secondaria Nginx
jsonPayload.tid	number	ID thread da cui ha avuto origine il log
jsonPayload.upstream	string	URI della richiesta upstream (facoltativo)
severity	stringa (LogSeverity)	Livello di voce di log (tradotto).

Configurazione della raccolta di metriche

Per importare le metriche da nginx, devi creare un ricevitore per le metriche prodotta da nginx, quindi creare 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 ricevitore per le metriche nginx, specifica i seguenti campi:

Campo	Predefinito	Descrizione
collection_interval	60s	Una durata, ad esempio 30s o 5m.
server_status_url	http://localhost/status	L'URL esposto dal modulo di 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

Questa sezione descrive come verificare di aver configurato correttamente il ricevitore nginx. Ops Agent potrebbe impiegare uno o due minuti per iniziare a raccogliere i dati di telemetria.

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

1. Nel pannello di navigazione della console Google Cloud, seleziona Logging, quindi Esplora log:

   Vai a Esplora log

2. Inserisci la seguente query nell'editor e 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 a Cloud Monitoring:

1. Nella console Google Cloud, vai alla pagina Metrics Explorer :

   Vai a Metrics Explorer

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

2. Nella barra degli strumenti del riquadro del generatore di query, seleziona il pulsante il cui nome è  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 fai clic su Esegui query:
   

   fetch gce_instance
   | metric 'workload.googleapis.com/nginx.requests'
   | every 1m
   

Visualizza dashboard

Per visualizzare le metriche nginx, devi aver configurato un grafico o una dashboard. L'integrazione di nginx include una o più dashboard. Tutte le dashboard vengono installate automaticamente dopo la configurazione dell'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, segui questi passaggi:

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 il cui sottotitolo è Monitoring.

2. Seleziona la scheda Elenco dashboard, quindi scegli la categoria Integrazioni.
3. Fai clic sul nome della dashboard da visualizzare.

Se hai configurato un'integrazione, ma la dashboard non è stata installata, verifica che Ops Agent sia in esecuzione. Se nella dashboard non sono disponibili dati delle metriche per un grafico, l'installazione della dashboard non riesce. Dopo che Ops Agent ha iniziato a raccogliere le metriche, la dashboard viene installata automaticamente.

Per visualizzare un'anteprima statica della dashboard:

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

   Vai a Integrazioni

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

2. Fai clic sul filtro 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 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 criteri di avviso

I criteri di avviso indicano a Cloud Monitoring di inviarti una notifica quando si verificano condizioni specificate. L'integrazione di nginx include uno o più criteri di avviso che puoi utilizzare. Puoi visualizzare e installare questi criteri di avviso dalla pagina Integrazioni in Monitoring.

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

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

   Vai a Integrazioni

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato il cui 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 relative all'attivazione dell'avviso, per cui richiedono informazioni da parte tua per l'installazione. Per installare i criteri di avviso:
   1. Dall'elenco dei criteri di avviso disponibili, seleziona quelli che vuoi installare.

   2. Nella sezione Configura le notifiche, seleziona uno o più canali di notifica. Puoi disattivare l'utilizzo dei canali di notifica. Tuttavia, in questo caso i criteri di avviso si attivano in modo invisibile. Puoi verificarne lo stato in Monitoring, ma non ricevi notifiche.

      Per maggiori informazioni 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 Introduzione agli avvisi.

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

Risoluzione dei problemi

Sulla 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 è abilitato. In rari casi, se il comando non restituisce alcun output, devi compilare nginx dall'origine con -with-http_stub_status_module seguendo la documentazione pubblica di nginx.

Passaggi successivi

Per una procedura dettagliata su come utilizzare Ansible per installare Ops Agent, configurare un'applicazione di terze parti e installare una dashboard di esempio, consulta il video Installare Ops Agent per la risoluzione dei problemi delle applicazioni di terze parti.