Jetty

Die Jetty-Integration erfasst Messwerte zur Sitzung und Threadnutzung. Die Integration erfasst auch Zugriffs- und Systemlogs. Zugriffslogs werden in eine JSON-Nutzlast geparst, die auf Anfragedetails ausgerichtet ist.

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

Vorbereitung

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

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

Diese Integration unterstützt die Jetty-Versionen 9.4.x, 10.x und 11.x.

Ops-Agent für Jetty konfigurieren

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

Zum Erfassen von Messwerten aus dieser Integration müssen Sie auch einen JMX-Endpunkt (Java Management Extensions) bereitstellen.

Wenn Sie einen JMX-Endpunkt verfügbar machen möchten, müssen Sie beim Starten der JVM das Systemattribut com.sun.management.jmxremote.port festlegen. Außerdem empfehlen wir, das Systemattribut com.sun.management.jmxremote.rmi.port auf denselben Port festzulegen.

Standardmäßig werden diese Attribute in der Jetty-Datei /etc/jetty-jmx.xml festgelegt.

Wenn Sie einen JMX-Endpunkt remote verfügbar machen möchten, müssen Sie auch das Systemattribut java.rmi.server.hostname festlegen.

Wenn Sie Systemattribute mithilfe von Befehlszeilenargumenten festlegen möchten, stellen Sie beim Starten der JVM dem Attributnamen -D voran. Wenn Sie beispielsweise das Attribut com.sun.management.jmxremote.port auf Port 1099 festlegen möchten, geben Sie beim Starten der JVM Folgendes an:

-Dcom.sun.management.jmxremote.port=1099

Konfigurationsbeispiel

Der folgende Befehl erstellt die Konfiguration zum Erfassen und Aufnehmen von Telemetriedaten für Jetty und startet den Ops-Agent unter Linux neu.

# 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:
    jetty_metrics:
      type: jetty
  service:
    pipelines:
      jetty_pipeline:
        receivers:
          - jetty_metrics
logging:
  receivers:
    jetty_access:
      type: jetty_access
  service:
    pipelines:
      jetty:
        receivers:
          - jetty_access
EOF

sudo service google-cloud-ops-agent restart

Logerfassung konfigurieren

Um Logs von Jetty aufzunehmen, müssen Sie Empfänger für die von Jetty 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 jetty_access-Logs zu konfigurieren:

Feld Standard Beschreibung
exclude_paths Eine Liste von Dateisystempfadmustern, die aus dem Satz ausgeschlossen werden sollen, der mit include_paths übereinstimmt.
include_paths ["/opt/logs/*.request.log"] Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (*) verwendet werden.
type Der Wert muss jetty_access betragen.
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.
wildcard_refresh_interval 60s Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als Zeitdauer angegeben, 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:

jetty_access-Logs enthalten die folgenden Felder in LogEntry:

Feld Typ Beschreibung
httpRequest.protocol String Für die Anfrage verwendetes Protokoll.
httpRequest.remoteIp String IP-Adresse des Clients.
httpRequest.requestMethod String HTTP-Methode.
httpRequest.requestUrl String Anfrage-URL (in der Regel nur der Pfadteil der URL)
httpRequest.responseSize String Größe der Antwort.
httpRequest.status String HTTP-Statuscode.
httpRequest.userAgent String Inhalt des Headers User-Agent.

syslog-Logs enthalten die folgenden Felder in LogEntry:

Feld Typ Beschreibung
jsonPayload.message String Log-Nachricht.

Messwerterfassung konfigurieren

Um Messwerte von Jetty aufzunehmen, müssen Sie einen Empfänger für die von Jetty 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 jetty-Messwerte zu konfigurieren, geben Sie die folgenden Felder an:

Feld Standard Beschreibung
collect_jvm_metrics true Konfiguriert den Empfänger so, dass auch die unterstützten JVM-Messwerte erfasst werden.
collection_interval 60s Ein Wert für time.Duration, wie z. B. 30s oder 5m.
endpoint localhost:1099 Die JMX-Dienst-URL oder der Host und Port, die zum Erstellen der Dienst-URL verwendet werden. Dieser Wert muss das Format service:jmx:<protocol>:<sap> oder host:port haben. Werte im Format host:port werden für das Erstellen der Dienst-URL service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi verwendet.
password Das konfigurierte Passwort, wenn JMX für eine erforderliche Authentifizierung konfiguriert ist.
type Dieser Wert muss jetty sein.
username Der konfigurierte Nutzername, wenn JMX für eine erforderliche Authentifizierung konfiguriert ist.

Was wird überwacht?

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

Messwerttyp
Art, Typ
Überwachte Ressourcen		 Labels
workload.googleapis.com/jetty.select.count
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/jetty.session.count
CUMULATIVE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.session.time.max
GAUGE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.session.time.total
GAUGE, INT64
gce_instance 		resource
workload.googleapis.com/jetty.thread.count
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/jetty.thread.queue.count
GAUGE, INT64
gce_instance 		 

Konfiguration prüfen

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

So prüfen Sie, ob Jetty-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("jetty_access")

So prüfen Sie, ob Jetty-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. Wählen Sie in der Symbolleiste des Bereichs „Query Builder“ die Schaltfläche mit dem Namen  MQL oder  PromQL aus.
  3. Prüfen Sie, ob im Umschalter Sprache MQL 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/jetty.select.count'
| every 1m

Dashboard aufrufen

Damit Sie Ihre Jetty-Messwerte aufrufen können, müssen Sie ein Diagramm oder ein Dashboard konfiguriert haben. Die Jetty-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:

    Zu Dashboards

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

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.