Apache Tomcat-Logs erfassen

Parserversion: 3.0

Unterstützt in:

In diesem Dokument wird beschrieben, wie Sie Apache Tomcat-Logs mit dem Bindplane-Agenten in Google Security Operations aufnehmen.

Apache Tomcat ist ein Webanwendungsserver, der JSON-Zugriffslogs für HTTP-Anfragen, Authentifizierungsereignisse und Serveraktivitäten generiert. Der Parser extrahiert Felder aus JSON- und Syslog-formatierten Logs und ordnet sie dem Unified Data Model (UDM) zu.

Hinweis

Prüfen Sie, ob folgende Voraussetzungen erfüllt sind:

  • Eine Google SecOps-Instanz
  • Windows Server 2016 oder höher oder Linux-Host mit systemd
  • Bindplane-Agent, der auf dem Tomcat-Server installiert ist (zum Lesen lokaler Logdateien)
  • Wenn der Agent hinter einem Proxy ausgeführt wird, müssen die Firewallports gemäß den Anforderungen des Bindplane-Agents geöffnet sein.
  • Administratorzugriff auf den Tomcat-Server

Google SecOps-Anmeldedaten für den Bindplane-Agenten abrufen

Wählen Sie eine der folgenden Methoden aus, um den Bindplane-Agenten bei Google SecOps zu authentifizieren:

  • Neue Deployments: Verwenden Sie die Chronicle API (Option 1).
  • Legacy-Bereitstellungen: Verwenden Sie die Authentifizierungsdatei für die Datenaufnahme (Option 2) weiter, bis die Ingestion API am 20. Juli 2027 eingestellt wird.
  1. Melden Sie sich in der Google Cloud Console an und wählen Sie das Google Cloud -Projekt aus, das mit Ihrer Google SecOps-Instanz verknüpft ist.
  2. Rufen Sie IAM & Verwaltung > Dienstkonten auf.
  3. Klicken Sie auf Dienstkonto erstellen.
  4. Geben Sie die folgenden Konfigurationsdetails an:
    • Name des Dienstkontos: Geben Sie einen Namen für das Konto ein, z. B. bindplane-ingest.
    • Dienstkontobeschreibung: Geben Sie eine Beschreibung ein (z. B. Bindplane agent log ingestion).
  5. Klicken Sie auf Erstellen und fortfahren.
  6. Klicken Sie im Abschnitt Diesem Dienstkonto Zugriff auf das Projekt erteilen auf Rolle auswählen und wählen Sie Chronicle Editor aus.
  7. Klicken Sie auf Weiter und dann auf Fertig.
  8. Klicken Sie auf das von Ihnen erstellte Dienstkonto und rufen Sie den Tab Schlüssel auf.
  9. Klicken Sie auf Schlüssel hinzufügen > Neuen Schlüssel erstellen.
  10. Wählen Sie JSON aus und klicken Sie auf Erstellen. Die Schlüsseldatei wird auf Ihren Computer heruntergeladen.
  11. Speichern Sie die Schlüsseldatei als ingestion-auth.json im Bindplane-Collector-Verzeichnis (/opt/observiq-otel-collector/ingestion-auth.json unter Linux oder C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json unter Windows) oder aktualisieren Sie creds_file_path in config.yaml, damit der Pfad mit dem Pfad übereinstimmt, in dem Sie die Datei speichern.
  12. Rufen Sie IAM & Verwaltung > Einstellungen auf und kopieren Sie die Projektnummer. Sie benötigen sie für die Konfiguration des Exporters.

Option 2: Authentifizierungsdatei für die Datenaufnahme herunterladen (Legacy)

  1. Melden Sie sich in der Google SecOps-Konsole an.
  2. Rufen Sie die SIEM-Einstellungen > Erfassungs-Agents auf.
  3. Laden Sie die Authentifizierungsdatei für die Aufnahme herunter.
  4. Speichern Sie die Datei sicher auf dem System, auf dem der Bindplane-Agent installiert werden soll.

Google SecOps-Kundennummer abrufen

  1. Melden Sie sich in der Google SecOps-Konsole an.
  2. Rufen Sie die SIEM-Einstellungen > Profile auf.
  3. Kopieren und speichern Sie die Kundennummer aus dem Bereich Organization Details (Organisationsdetails).

Bindplane-Agent auf dem Tomcat-Server installieren, um Logdateien zu erfassen

Installieren Sie den Bindplane-Agenten auf dem Tomcat-Server selbst, da er lokale Logdateien lesen muss.

Windows-Installation

  1. Öffnen Sie die Eingabeaufforderung oder PowerShell als Administrator.
  2. Führen Sie dazu diesen Befehl aus:

    msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
    
  3. Warten Sie, bis die Installation abgeschlossen ist.

  4. Überprüfen Sie die Installation mit folgendem Befehl:

    sc query observiq-otel-collector
    

    Der Dienst sollte als RUNNING angezeigt werden.

Linux-Installation

  1. Öffnen Sie ein Terminal mit Root- oder sudo-Berechtigungen.
  2. Führen Sie dazu diesen Befehl aus:

    sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
    
  3. Warten Sie, bis die Installation abgeschlossen ist.

  4. Überprüfen Sie die Installation mit folgendem Befehl:

    sudo systemctl status observiq-otel-collector
    

    Der Dienst sollte als active (running) angezeigt werden.

Zusätzliche Installationsressourcen

Weitere Installationsoptionen und Informationen zur Fehlerbehebung finden Sie in der Installationsanleitung für den Bindplane-Agent.

Bindplane-Agent so konfigurieren, dass Tomcat-Logs aufgenommen und an Google SecOps gesendet werden

Konfigurationsdatei suchen

  • Linux:

    sudo nano /opt/observiq-otel-collector/config.yaml
    
  • Windows:

    notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
    

Konfigurationsdatei bearbeiten

  • Ersetzen Sie den gesamten Inhalt von config.yaml durch die folgende Konfiguration:

    receivers:
      filelog/tomcat:
        include:
          - /path/to/tomcat/logs/access-log.*.json
        start_at: beginning
    
    exporters:
      chronicle/tomcat:
        protocol: https
        # Region of your instance, for example us, europe, asia-southeast1
        location: <LOCATION>
        # Project number of the Google Cloud project linked to the instance
        project: '<PROJECT_NUMBER>'
        compression: gzip
        creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: chronicle.googleapis.com
        log_type: TOMCAT
        raw_log_field: body
    
    service:
      pipelines:
        logs/tomcat_to_chronicle:
          receivers:
            - filelog/tomcat
          exporters:
            - chronicle/tomcat
    

Konfigurationsparameter

Ersetzen Sie die folgenden Platzhalter:

  • Empfängerkonfiguration:

    • include: Pfad zu Tomcat-JSON-Zugriffsprotokolldateien. Passen Sie das Tomcat-Logverzeichnis und das Dateimuster an.
    • start_at: Legen Sie beginning fest, um vorhandene Logs zu lesen, oder end, um nur neue Einträge zu lesen.
  • Exporter-Konfiguration:

    • creds_file_path: Vollständiger Pfad zur JSON-Schlüsseldatei des Dienstkontos (Option 1):
      • Linux: /opt/observiq-otel-collector/ingestion-auth.json
      • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
    • customer_id: Die Kundennummer, die aus der Google SecOps Console kopiert wurde
    • location: Ersetzen Sie <LOCATION> durch die Region Ihrer Google SecOps-Instanz (z. B. us, europe oder asia-southeast1). Der Exporteur stellt diesem Wert das Präfix chronicle.googleapis.com voran. Eine vollständige Liste finden Sie unter Regionale Endpunkte.
    • project: Ersetzen Sie <PROJECT_NUMBER> durch die Projektnummer aus IAM & Verwaltung > Einstellungen.
    • endpoint: Behalten Sie die Einstellung chronicle.googleapis.com bei.

Exporter für die Legacy Ingestion API

  • Wenn Sie die Authentifizierungsdatei für die Datenaufnahme aus Option 2 verwenden, ersetzen Sie den Block exporters durch Folgendes. Legen Sie für creds_file_path den Pfad zur Authentifizierungsdatei für die Datenaufnahme fest. Wenn sich Ihre Instanz außerhalb der USA befindet, ersetzen Sie malachiteingestion-pa.googleapis.com durch Ihren regionalen Endpunkt (z. B. europe-malachiteingestion-pa.googleapis.com).

    exporters:
      chronicle/tomcat:
        compression: gzip
        creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: TOMCAT
        raw_log_field: body
    

Konfigurationsdatei speichern

  • Speichern Sie die Datei nach der Bearbeitung:
    • Linux: Drücken Sie Ctrl+O, dann Enter und dann Ctrl+X.
    • Windows: Klicken Sie auf Datei > Speichern.

Bindplane-Agent neu starten, um die Änderungen zu übernehmen

  • Führen Sie den folgenden Befehl aus, um den Bindplane-Agenten unter Linux neu zu starten:

    sudo systemctl restart observiq-otel-collector
    
    1. Prüfen Sie, ob der Dienst ausgeführt wird:

      sudo systemctl status observiq-otel-collector
      
    2. Prüfen Sie die Logs auf Fehler:

      sudo journalctl -u observiq-otel-collector -f
      
  • Wählen Sie eine der folgenden Optionen aus, um den Bindplane-Agenten unter Windows neu zu starten:

    • Eingabeaufforderung oder PowerShell als Administrator:

      net stop observiq-otel-collector && net start observiq-otel-collector
      
    • Dienstkonsole:

      1. Drücken Sie Win+R, geben Sie services.msc ein und drücken Sie die Eingabetaste.
      2. Suchen Sie nach observIQ OpenTelemetry Collector.
      3. Klicken Sie mit der rechten Maustaste und wählen Sie Neu starten aus.
      4. Prüfen Sie, ob der Dienst ausgeführt wird:

        sc query observiq-otel-collector
        
      5. Logs auf Fehler prüfen:

        type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
        

JSON-Zugriffslogs in Tomcat konfigurieren

  1. Öffnen Sie die Tomcat-Konfigurationsdatei unter $CATALINA_BASE/conf/server.xml.
  2. Suchen Sie das Tag <Host> und fügen Sie Folgendes hinzu:

    <Valve className="org.apache.catalina.valves.JsonAccessLogValve"
           directory="logs"
           prefix="access-log"
           suffix=".json"
           rotatable="true"
           maxDays="7"/>
    
  3. Starten Sie Tomcat neu, um die Änderungen zu übernehmen:

    cd /path/to/tomcat
    bin/catalina.sh stop
    bin/catalina.sh start
    
  4. Täglich wird eine neue JSON-Logdatei erstellt (z. B. logs/access-log.2025-07-02.json).

UDM-Zuordnungstabelle

Logfeld UDM-Zuordnung Logik
@timestamp metadata.event_timestamp Der Wert von @timestamp aus dem Rohlog wird direkt diesem UDM-Feld zugeordnet. Sie gibt den Zeitpunkt des Ereignisses an.
agent.ephemeral_id additional.fields[ephemeral_id].value.string_value Die sitzungsspezifische ID des Agents wird als Schlüssel/Wert-Paar in den additional-Feldern hinzugefügt.
agent.hostname observer.hostname Der Hostname des Agents wird als Hostname des Beobachters verwendet.
agent.id observer.asset_id Die Agent-ID wird mit dem Agent-Typ kombiniert, um die Observer-Asset-ID zu erstellen (z.B. filebeat: <agent_id>).
agent.type observer.application Der Agent-Typ wird als Observer-Anwendung verwendet.
agent.version observer.platform_version Die Agent-Version wird als Observer-Plattformversion verwendet.
host.hostname principal.hostname Der Hostname des Hosts wird als Prinzipal-Hostname verwendet.
host.id principal.asset.asset_id Der Host-ID wird Host Id: vorangestellt, um die Haupt-Asset-ID zu erstellen.
host.ip principal.ip, observer.ip Die IP-Adresse des Hosts wird sowohl für die IP-Adresse des Hauptnutzers als auch für die IP-Adresse des Beobachters verwendet. Wenn mehrere IP-Adressen vorhanden sind, werden sie in einem Array zusammengeführt.
host.mac principal.mac Die MAC-Adresse des Hosts wird als primäre MAC-Adresse verwendet. Wenn mehrere MAC-Adressen vorhanden sind, werden sie in einem Array zusammengeführt.
host.os.family principal.platform Wenn die Host-Betriebssystemfamilie rhel oder redhat ist, wird die Hauptplattform auf LINUX gesetzt.
host.os.kernel principal.platform_patch_level Die Kernel-Version des Hostbetriebssystems wird als primäre Patch-Ebene der Plattform verwendet.
host.os.name additional.fields[os_name].value.string_value Der Name des Host-Betriebssystems wird als Schlüssel/Wert-Paar in den additional-Feldern hinzugefügt.
host.os.version principal.platform_version Die Host-Betriebssystemversion wird als Hauptplattformversion verwendet.
log.file.path principal.process.file.full_path Der Logpfad wird als vollständiger Pfad der Hauptprozessdatei verwendet.
log_level security_result.severity, security_result.severity_details, security_result.action Die Logebene wird verwendet, um den Schweregrad, die Details zum Schweregrad und die Aktion des Sicherheitsergebnisses zu bestimmen. DEBUG, INFO und AUDIT werden dem Schweregrad INFORMATIONAL und der Aktion ALLOW zugeordnet. „ERROR“ entspricht dem Schweregrad „ERROR“ und der Aktion „BLOCK“. WARNING und WARN werden dem Schweregrad MEDIUM und der Aktion BLOCK zugeordnet. Der Rohwert von „log_level“ wird auch „severity_details“ zugeordnet.
logstash.irm_environment additional.fields[irm_environment].value.string_value Die Iron Mountain-Umgebung aus Logstash wird als Schlüssel/Wert-Paar in den additional-Feldern hinzugefügt.
logstash.irm_region additional.fields[irm_region].value.string_value Die Iron Mountain-Region aus Logstash wird als Schlüssel/Wert-Paar in den additional-Feldern hinzugefügt.
logstash.irm_site additional.fields[irm_site].value.string_value Der Iron Mountain-Standort aus Logstash wird als Schlüssel/Wert-Paar in den additional-Feldern hinzugefügt.
logstash.process.host intermediary.hostname Der Logstash-Verarbeitungshost wird als Zwischenhostname verwendet.
logstash.process.timestamp metadata.collected_timestamp Der Logstash-Verarbeitungszeitstempel wird als erfasster Zeitstempel verwendet.
logstash.xyz_environment additional.fields[xyz_environment].value.string_value Die xyz-Umgebung aus Logstash wird als Schlüssel/Wert-Paar in den additional-Feldern hinzugefügt.
logstash.xyz_region additional.fields[xyz_region].value.string_value Die xyz-Region aus Logstash wird als Schlüssel/Wert-Paar in den additional-Feldern hinzugefügt.
logstash.xyz_site additional.fields[xyz_site].value.string_value Die xyz-Website von Logstash wird als Schlüssel/Wert-Paar in den additional-Feldern hinzugefügt.
message metadata.description Das Nachrichtenfeld wird als JSON geparst und das Feld event_message wird als Metadatenbeschreibung verwendet. Die Vermittleranwendung ist fest auf logstash codiert. Der Metadaten-Ereignistyp ist fest auf USER_UNCATEGORIZED codiert. Der Metadaten-Logtyp wird aus dem batch.type oder batch.log_type des Rohlogs auf TOMCAT festgelegt. Der Metadaten-Produktname ist fest auf Tomcat codiert. Der Name des Metadatenanbieters ist hartcodiert auf Tomcat.
user principal.user.userid Das Nutzerfeld aus dem Rohlog wird als Hauptkonto-Nutzer-ID verwendet.
product_event metadata.product_event_type Aus Änderungsprotokoll zugeordnet
summary security_result.summary Aus Änderungsprotokoll zugeordnet
query additional.fields Aus Änderungsprotokoll zugeordnet

Änderungsprotokoll

Änderungsprotokoll für diesen Parser ansehen

Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten