Apache Tomcat

Die Apache Tomcat-Einbindung erfasst trafficbezogene Messwerte wie die Anzahl der aktiven Sitzungen oder den Netzwerkdurchsatz. Die Einbindung erfasst auch Zugriffs- und Catalina-Logs. Zugriffslogs werden in eine JSON-Nutzlast geparst, die auf Anfragedetails ausgerichtet ist. Catalina-Logs werden hingegen für allgemeine Details geparst. Der Empfänger tomcat erfasst Telemetriedaten von der Java Virtual Machine (JVM) des Tomcat-Servers über JMX.

Weitere Informationen zu Tomcat finden Sie in der Apache Tomcat-Dokumentation.

Vorbereitung

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

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

Diese Integration unterstützt die Tomcat-Versionen 10.x und 9.0.x.

Tomcat-Instanz konfigurieren

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. Wenn Sie einen JMX-Endpunkt remote verfügbar machen möchten, müssen Sie auch das Systemattribut java.rmi.server.hostname festlegen.

Standardmäßig werden diese Attribute in der Datei tomcat-env.sh einer Tomcat-Bereitstellung festgelegt.

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

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

Ops-Agent für Tomcat konfigurieren

Fügen Sie die erforderlichen Elemente zum Erfassen von Telemetriedaten aus den Tomcat-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 Tomcat 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:
    tomcat:
      type: tomcat
      endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:8050/jmxrmi
  service:
    pipelines:
      tomcat:
        receivers:
          - tomcat

logging:
  receivers:
    tomcat_access:
      type: tomcat_access
    tomcat_system:
      type: tomcat_system
  service:
    pipelines:
      tomcat:
        receivers:
          - tomcat_access
          - tomcat_system
EOF

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

Logerfassung konfigurieren

Um Logs von Tomcat aufzunehmen, müssen Sie Empfänger für die von Tomcat 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 tomcat_system-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`	`[/opt/tomcat/logs/catalina.out]`	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 `tomcat_system` 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 tomcat_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`	`[/opt/tomcat/logs/localhost_access_log.*.txt]`	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 `tomcat_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.

Was wird protokolliert?

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

tomcat_system-Logs enthalten die folgenden Felder in LogEntry:

Feld	Typ	Beschreibung
`jsonPayload.level`	String	Logeintragsebene
`jsonPayload.message`	String	Lognachricht, einschließlich eines detaillierten Stacktrace, sofern angegeben
`jsonPayload.module`	String	Modul von Tomcat, von dem das Log stammt
`jsonPayload.source`	String	Quelle, aus der das Log stammt
`severity`	String (`LogSeverity`)	Ebene des Logeintrags (übersetzt).

tomcat_access-Logs enthalten die folgenden Felder in LogEntry:

Feld	Typ	Beschreibung
`httpRequest`	Objekt	Siehe `HttpRequest`
`jsonPayload.host`	String	Inhalte des Host-Headers
`jsonPayload.user`	String	Authentifizierter Nutzername für die Anfrage
`severity`	String (`LogSeverity`)	Ebene des Logeintrags (übersetzt).

Messwerterfassung konfigurieren

Um Messwerte von Tomcat aufzunehmen, müssen Sie einen Empfänger für die von Tomcat 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 tomcat-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`	Eine Zeitdauer, z. B. `30s` oder `5m`.
`endpoint`	`localhost:8050`	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 `tomcat` 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 Tomcat-Instanz erfasst.

Messwerttyp
Art, Typ Überwachte Ressourcen	Label
`workload.googleapis.com/tomcat.errors`
`CUMULATIVE`, `INT64` gce_instance	`proto_handler`
`workload.googleapis.com/tomcat.max_time`
`GAUGE`, `INT64` gce_instance	`proto_handler`
`workload.googleapis.com/tomcat.processing_time`
`CUMULATIVE`, `INT64` gce_instance	`proto_handler`
`workload.googleapis.com/tomcat.request_count`
`CUMULATIVE`, `INT64` gce_instance	`proto_handler`
`workload.googleapis.com/tomcat.sessions`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/tomcat.threads`
`GAUGE`, `INT64` gce_instance	`proto_handler` `state`
`workload.googleapis.com/tomcat.traffic`
`CUMULATIVE`, `INT64` gce_instance	`direction` `proto_handler`

Konfiguration prüfen

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

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

Wählen Sie im Navigationsbereich der Google Cloud Console Logging und anschließend Log-Explorer aus:
Zum Log-Explorer
Geben Sie im Editor die folgende Abfrage ein und klicken Sie dann auf Abfrage ausführen:
```
resource.type="gce_instance"
(log_id("tomcat_system") OR log_id("tomcat_access"))
```

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

Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend Metrics Explorer aus:
Zum Metrics Explorer
Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche MQL oder PromQL.
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.
Geben Sie im Editor die folgende Abfrage ein und klicken Sie dann auf Abfrage ausführen:
```
fetch gce_instance
| metric 'workload.googleapis.com/tomcat.threads'
| every 1m
```

Dashboard aufrufen

Damit Sie Ihre Tomcat-Messwerte aufrufen können, müssen Sie ein Diagramm oder ein Dashboard konfiguriert haben. Die Tomcat-Einbindung enthält für Sie 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:

Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend Dashboards aus:
Dashboards aufrufen
Wählen Sie den Tab Dashboard-Liste und dann die Kategorie Integrationen aus.
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:

Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend Integrationen aus:
Zu „Integrationen“
Klicken Sie auf den Filter für die Deployment-Plattform Compute Engine.
Suchen Sie den Eintrag für Tomcat und klicken Sie auf Details ansehen.
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 Tomcat-Einbindung enthält 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:

Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend Integrationen aus:
Zu „Integrationen“
Suchen Sie den Eintrag für Tomcat und klicken Sie auf Details ansehen.
Wählen Sie den Tab Benachrichtigungen aus. Dieser Tab enthält Beschreibungen der verfügbaren Benachrichtigungsrichtlinien und eine Oberfläche für deren Installation.
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.