nginx

Die nginx-Einbindung erfasst Verbindungsmesswerte und Zugriffslogs. Verbindungsmesswerte erfassen den aktuellen Status der Verbindung: Aktiv, Lesen oder Warten. Zugriffslogs werden nach ihren Verbindungsdetails geparst, einschließlich Feldern, die der Anfrage, dem Client, dem Server und der Nachricht zugeordnet sind.

Weitere Informationen zu nginx finden Sie in der nginx-Dokumentation.

Vorbereitung

Zum Erfassen von nginx-Telemetriedaten müssen Sie den Ops-Agent installieren:

  • Installieren Sie für Messwerte die Version 2.1.0 oder höher.
  • Installieren Sie für Logs die Version 2.1.0 oder höher.

Diese Integration unterstützt die nginx-Versionen 1.18 und 1.20.

nginx-Instanz konfigurieren

Um eine lokal erreichbare URL einzurichten, z. B. http://www.example.com/nginx_status für die Statusseite, müssen Sie das Modul stub_status in der nginx-Konfigurationsdatei aktivieren. Führen Sie die folgenden Schritte aus, um das Modul stub_status zu aktivieren:

  1. Bearbeiten Sie die Datei status.conf oder erstellen Sie die Datei, wenn sie nicht vorhanden ist. Sie finden diese Datei im nginx-Konfigurationsverzeichnis, das sich normalerweise unter /etc/nginx/conf.d befindet.

  2. Fügen Sie dem server-Tag folgende Zeilen hinzu:

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

    Ihre Konfigurationsdatei kann wie im folgenden Beispiel aussehen:

    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. Laden Sie die nginx-Konfiguration neu.

    sudo service nginx reload

Mit dem folgenden Befehl können Sie die vorherigen Schritte automatisieren. Es wird eine status.conf-Datei erstellt, falls sie noch nicht vorhanden ist, oder die vorhandene Datei überschrieben. Der Befehl aktiviert stub_status, lädt nginx neu und überprüft, ob die erwarteten Informationen über den Endpunkt verfügbar gemacht werden.

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

Die Beispielausgabe ist:

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

Alternativ können Sie die Zeilen auch anstelle einer separaten status.conf-Datei direkt in die Hauptdatei nginx.conf einbetten, die sich normalerweise in einem der folgenden Verzeichnisse befindet: /etc/nginx, /usr/local/nginx/conf oder /usr/local/etc/nginx.

Ops-Agent für nginx konfigurieren

Fügen Sie die erforderlichen Elemente zum Erfassen von Telemetriedaten aus den nginx-Instanzen gemäß der Anleitung unter Ops-Agent konfigurieren hinzu und starten Sie den Agent neu.

Konfigurationsbeispiel

Mit den folgenden Befehlen wird die Konfiguration zum Erfassen und Aufnehmen von Telemetriedaten für nginx erstellt und der Ops-Agent neu gestartet.

# 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

Logerfassung konfigurieren

Um Logs von nginx aufzunehmen, müssen Sie Empfänger für die von nginx erzeugten Logs erstellen und dann eine Pipeline für die neuen Empfänger erstellen.

Geben Sie die folgenden Felder an, um einen Empfänger für Ihre nginx_access-Logs zu konfigurieren:

Feld Standard Beschreibung
exclude_paths Eine Liste von Dateisystempfadmustern, die aus dem mit include_paths übereinstimmenden Satz ausgeschlossen werden sollen.
include_paths [/var/log/nginx/access.log] Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (*) verwendet werden.
record_log_file_path false Wenn true festgelegt ist, wird der Pfad zu der spezifischen Datei, aus der der Logdatensatz abgerufen wurde, im Ausgabelogeintrag als Wert des Labels agent.googleapis.com/log_file_path angezeigt. Bei Verwendung eines Platzhalters wird nur der Pfad der Datei aufgezeichnet, aus der der Eintrag abgerufen wurde.
type Der Wert muss nginx_access betragen.
wildcard_refresh_interval 60s Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als Zeitdauer angegeben, die mit time.ParseDuration analysiert werden kann, z. B. 30s oder 2m. Dieses Attribut kann bei hohen Logging-Durchsätzen nützlich sein, wenn Logdateien schneller als das Standardintervall rotiert werden.

Geben Sie die folgenden Felder an, um einen Empfänger für Ihre nginx_error-Logs zu konfigurieren:

Feld Standard Beschreibung
exclude_paths Eine Liste von Dateisystempfadmustern, die aus dem mit include_paths übereinstimmenden Satz ausgeschlossen werden sollen.
include_paths [/var/log/nginx/error.log] Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (*) verwendet werden.
record_log_file_path false Wenn true festgelegt ist, wird der Pfad zu der spezifischen Datei, aus der der Logdatensatz abgerufen wurde, im Ausgabelogeintrag als Wert des Labels agent.googleapis.com/log_file_path angezeigt. Bei Verwendung eines Platzhalters wird nur der Pfad der Datei aufgezeichnet, aus der der Eintrag abgerufen wurde.
type Der Wert muss nginx_error betragen.
wildcard_refresh_interval 60s Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als Zeitdauer angegeben, die mit time.ParseDuration analysiert werden kann, z. B. 30s oder 2m. Dieses Attribut kann bei hohen Logging-Durchsätzen nützlich sein, wenn Logdateien schneller als das Standardintervall rotiert werden.

Was wird protokolliert?

Der logName wird von den Empfänger-IDs abgeleitet, die in der Konfiguration angegeben sind. Detaillierte Felder in LogEntry sind:

nginx_access-Logs enthalten die folgenden Felder in LogEntry:

Feld Typ Beschreibung
httpRequest Objekt Siehe HttpRequest
jsonPayload.host String Inhalt des Host-Headers, der normalerweise nicht von nginx gemeldet wird
jsonPayload.level String Logeintragsebene
jsonPayload.user String Authentifizierter Nutzername für die Anfrage
severity String (LogSeverity) Ebene des Logeintrags (übersetzt).

nginx_error-Logs enthalten die folgenden Felder in LogEntry:

Feld Typ Beschreibung
jsonPayload.client String IP-Adresse des Clients (optional)
jsonPayload.connection number Verbindungs-ID
jsonPayload.host String Host-Header (optional)
jsonPayload.level String Logeintragsebene
jsonPayload.message String Log-Nachricht
jsonPayload.pid number Prozess-ID, die das Log ausgibt
jsonPayload.referer String Referer-Header (optional)
jsonPayload.request String Ursprüngliche HTTP-Anfrage (optional)
jsonPayload.server String Nginx-Servername (optional)
jsonPayload.subrequest String Nginx-Unteranfrage (optional)
jsonPayload.tid number Thread-ID, von der das Log stammt
jsonPayload.upstream String Vorgelagerter Anfrage-URI (optional)
severity String (LogSeverity) Ebene des Logeintrags (übersetzt).

Messwerterfassung konfigurieren

Um Messwerte von nginx aufzunehmen, müssen Sie einen Empfänger für die von nginx erzeugten Messwerte erstellen und dann eine Pipeline für den neuen Empfänger erstellen.

Dieser Empfänger unterstützt die Verwendung mehrerer Instanzen in der Konfiguration, z. B. zum Überwachen mehrerer Endpunkte, nicht. Alle diese Instanzen schreiben in dieselbe Zeitachse und Cloud Monitoring kann sie nicht unterscheiden.

Um einen Empfänger für Ihre nginx-Messwerte zu konfigurieren, geben Sie die folgenden Felder an:

Feld Standard Beschreibung
collection_interval 60s Eine Zeitdauer, z. B. 30s oder 5m.
server_status_url http://localhost/status Die vom nginx-Stub-Statusmodul bereitgestellte URL.
type Dieser Wert muss nginx sein.

Was wird überwacht?

Die folgende Tabelle enthält die Liste der Messwerte, die der Ops-Agent aus der nginx-Instanz erfasst.

Messwerttyp
Art, Typ
Überwachte Ressourcen		 Labels
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 		 

Konfiguration prüfen

In diesem Abschnitt wird beschrieben, wie Sie prüfen können, ob Sie den nginx-Empfänger richtig konfiguriert haben. Es kann ein oder zwei Minuten dauern, bis der Ops-Agent Telemetriedaten erfasst.

So prüfen Sie, ob NGINX-Logs an Cloud Logging gesendet werden:

  1. Wählen Sie im Navigationsbereich der Google Cloud Console Logging und anschließend Log-Explorer aus:

    Zum Log-Explorer

  2. Geben Sie die folgende Abfrage in den Editor ein und klicken Sie dann auf Abfrage ausführen: 
    resource.type="gce_instance"
(log_id("nginx_access") OR log_id("nginx_error"))

So prüfen Sie, ob NGINX-Messwerte an Cloud Monitoring gesendet werden:

  1. Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend  Metrics Explorer aus:

    Zum Metrics Explorer

  2. Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche  MQL oder  PromQL.
  3. Prüfen Sie, ob MQL im Schalter Sprache ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.
  4. Geben Sie die folgende Abfrage in den Editor ein und klicken Sie dann auf Abfrage ausführen: 
    fetch gce_instance
| metric 'workload.googleapis.com/nginx.requests'
| every 1m

Dashboard aufrufen

Damit Sie Ihre nginx-Messwerte aufrufen können, müssen Sie ein Diagramm oder ein Dashboard konfiguriert haben. Die nginx-Integration umfasst ein oder mehrere Dashboards. Alle Dashboards werden automatisch installiert, nachdem Sie die Integration konfiguriert haben und der Ops-Agent mit dem Erfassen von Messwertdaten begonnen hat.

Sie können auch eine statische Vorschau von Dashboards aufrufen, ohne die Integration zu installieren.

So rufen Sie ein installiertes Dashboard auf:

  1. Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend  Dashboards aus:

    Dashboards aufrufen

  2. Wählen Sie den Tab Dashboard-Liste und dann die Kategorie Integrationen aus.
  3. Wählen Sie den Namen des Dashboards aus, das Sie aufrufen möchten.

Wenn Sie eine Integration konfiguriert haben, das Dashboard jedoch nicht installiert ist, prüfen Sie, ob der Ops-Agent ausgeführt wird. Wenn im Dashboard keine Messwertdaten für ein Diagramm vorhanden sind, schlägt die Installation des Dashboards fehl. Nachdem der Ops-Agent mit dem Erfassen von Messwerten begonnen hat, wird das Dashboard für Sie installiert.

So rufen Sie eine statische Vorschau des Dashboards auf:

  1. Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und dann  Integrationen aus:

    Rufen Sie Integrationen auf.

  2. Klicken Sie auf den Filter für die Deployment-Plattform Compute Engine.
  3. Suchen Sie den Eintrag für nginx und klicken Sie auf Details anzeigen.
  4. Wählen Sie den Tab Dashboards aus, um eine statische Vorschau aufzurufen. Wenn das Dashboard installiert ist, können Sie es aufrufen. Klicken Sie dazu auf Dashboard aufrufen.

Weitere Informationen zu Dashboards in Cloud Monitoring finden Sie unter Dashboards und Diagramme.

Weitere Informationen zur Verwendung der Seite Integrationen finden Sie unter Integrationen verwalten.

Benachrichtigungsrichtlinien installieren

Durch Benachrichtigungsrichtlinien wird Cloud Monitoring angewiesen, Sie zu benachrichtigen, wenn bestimmte Bedingungen auftreten. Die nginx-Integration umfasst eine oder mehrere Benachrichtigungsrichtlinien, die Sie verwenden können. Sie können diese Benachrichtigungsrichtlinien auf der Seite Integrationen in Monitoring aufrufen und installieren.

So zeigen Sie die Beschreibungen der verfügbaren Benachrichtigungsrichtlinien an und installieren sie:

  1. Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und dann  Integrationen aus:

    Rufen Sie Integrationen auf.

  2. Suchen Sie den Eintrag für nginx und klicken Sie auf Details anzeigen.
  3. Wählen Sie den Tab Benachrichtigungen aus. Dieser Tab enthält Beschreibungen der verfügbaren Benachrichtigungsrichtlinien und eine Oberfläche für deren Installation.
  4. Installieren Sie Benachrichtigungsrichtlinien. Benachrichtigungsrichtlinien müssen wissen, wohin Benachrichtigungen gesendet werden sollen, dass die Benachrichtigung ausgelöst wurde. Daher benötigen sie Informationen von Ihnen für die Installation. So installieren Sie Benachrichtigungsrichtlinien:
    1. Wählen Sie aus der Liste der verfügbaren Benachrichtigungsrichtlinien die Richtlinien aus, die Sie installieren möchten.

    2. Wählen Sie im Abschnitt Benachrichtigungen konfigurieren einen oder mehrere Benachrichtigungskanäle aus. Sie haben die Möglichkeit, die Verwendung von Benachrichtigungskanälen zu deaktivieren. In diesem Fall werden Ihre Benachrichtigungsrichtlinien jedoch automatisch ausgelöst. Sie können ihren Status in Monitoring prüfen, aber Sie erhalten keine Benachrichtigungen.

      Weitere Informationen zu Benachrichtigungskanälen finden Sie unter Benachrichtigungskanäle verwalten.

    3. Klicken Sie auf Richtlinien erstellen.

Weitere Informationen zu Benachrichtigungsrichtlinien in Cloud Monitoring finden Sie unter Einführung in Benachrichtigungen.

Weitere Informationen zur Verwendung der Seite Integrationen finden Sie unter Integrationen verwalten.

Fehlerbehebung

Auf den meisten Distributionen ist nginx mit ngx_http_stub_status_module aktiviert. Mit dem folgenden Befehl können Sie prüfen, ob das Modul aktiviert ist:

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

Die erwartete Ausgabe ist with-http_stub_status_module. Das bedeutet, dass das Modul aktiviert ist. Wenn der Befehl keine Ausgabe zurückgibt, müssen Sie nginx über die öffentliche Dokumentation aus der Quelle mit dem -with-http_stub_status_module kompilieren.

Nächste Schritte

Eine Anleitung zur Installation von Ops-Agent mit Ansible zum Konfigurieren einer Drittanbieteranwendung und zum Installieren eines Beispieldashboards finden Sie im Video Ops-Agent installieren, um Fehler in Drittanbieteranwendungen zu beheben.