Collecter les journaux Apache Tomcat

Version de l'analyseur : 3.0

Compatible avec :

Ce document explique comment ingérer des journaux Apache Tomcat dans Google Security Operations à l'aide de l'agent Bindplane.

Apache Tomcat est un serveur d'applications Web qui génère des journaux d'accès JSON pour les requêtes HTTP, les événements d'authentification et l'activité du serveur. L'analyseur extrait les champs des journaux au format JSON et syslog, et les mappe au modèle de données unifié (UDM).

Avant de commencer

Assurez-vous de remplir les conditions suivantes :

  • Une instance Google SecOps
  • Windows Server 2016 ou version ultérieure, ou hôte Linux avec systemd
  • Agent Bindplane installé sur le serveur Tomcat (pour lire les fichiers journaux locaux)
  • Si vous exécutez l'agent derrière un proxy, assurez-vous que les ports de pare-feu sont ouverts conformément aux exigences de l'agent Bindplane.
  • Accès administrateur au serveur Tomcat

Obtenir le fichier d'authentification d'ingestion Google SecOps

  1. Connectez-vous à la console Google SecOps.
  2. Accédez à Paramètres SIEM> Agents de collecte.
  3. Téléchargez le fichier d'authentification d'ingestion.

  4. Enregistrez le fichier de manière sécurisée sur le système sur lequel Bindplane sera installé.

Obtenir l'ID client Google SecOps

  1. Connectez-vous à la console Google SecOps.
  2. Accédez à Paramètres du SIEM > Profil.

  3. Copiez et enregistrez le numéro client dans la section Informations sur l'organisation.

Installez l'agent Bindplane sur le serveur Tomcat pour collecter les fichiers journaux.

Installez l'agent BindPlane sur le serveur Tomcat lui-même, car il doit lire les fichiers journaux locaux.

Installation de Windows

  1. Ouvrez l'invite de commandes ou PowerShell en tant qu'administrateur.

  2. Exécutez la commande suivante :

    msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet

  3. Attendez la fin de l'installation.

  4. Vérifiez l'installation en exécutant la commande suivante :

    sc query observiq-otel-collector

    Le service doit être indiqué comme RUNNING (EN COURS D'EXÉCUTION).

Installation de Linux

  1. Ouvrez un terminal avec des privilèges root ou sudo.

  2. Exécutez la commande suivante :

    sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh

  3. Attendez la fin de l'installation.

  4. Vérifiez l'installation en exécutant la commande suivante :

    sudo systemctl status observiq-otel-collector

    Le service doit être indiqué comme actif (en cours d'exécution).

Autres ressources d'installation

Pour obtenir d'autres options d'installation et de dépannage, consultez le guide d'installation de l'agent Bindplane.

Configurer l'agent Bindplane pour ingérer les journaux Tomcat et les envoyer à Google SecOps

Localiser le fichier de configuration

  • Linux :

    sudo nano /opt/observiq-otel-collector/config.yaml

  • Windows :

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

Modifiez le fichier de configuration

  • Remplacez l'intégralité du contenu de config.yaml par la configuration suivante :

    receivers:
    filelog/tomcat:
        include:
            - /path/to/tomcat/logs/access-log.*.json
        start_at: beginning

exporters:
    chronicle/tomcat:
        compression: gzip
        creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: TOMCAT
        raw_log_field: body

service:
    pipelines:
        logs/tomcat_to_chronicle:
            receivers:
                - filelog/tomcat
            exporters:
                - chronicle/tomcat

Paramètres de configuration

Remplacez les espaces réservés suivants :

  • Configuration du récepteur :

    • include : chemin d'accès aux fichiers journaux d'accès JSON de Tomcat. Ajustez-les pour qu'ils correspondent à votre répertoire de journaux et à votre modèle de fichier Tomcat.
    • start_at : définissez la valeur sur beginning pour lire les journaux existants ou sur end pour lire uniquement les nouvelles entrées.

  • Configuration de l'exportateur :

    • creds_file_path : chemin d'accès complet au fichier d'authentification de l'ingestion :
      • Linux : /etc/bindplane-agent/ingestion-auth.json
      • Windows : C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
    • customer_id : ID client copié depuis la console Google SecOps
    • endpoint : URL du point de terminaison régional :
      • États-Unis : malachiteingestion-pa.googleapis.com
      • Europe : europe-malachiteingestion-pa.googleapis.com
      • Asie : asia-southeast1-malachiteingestion-pa.googleapis.com
      • Pour obtenir la liste complète, consultez Points de terminaison régionaux.

Enregistrez le fichier de configuration.

  • Après avoir modifié le fichier, enregistrez-le :
    • Linux : appuyez sur Ctrl+O, puis sur Enter, puis sur Ctrl+X.
    • Windows : cliquez sur Fichier > Enregistrer.

Redémarrez l'agent Bindplane pour appliquer les modifications.

  • Pour redémarrer l'agent Bindplane sous Linux, exécutez la commande suivante :

    sudo systemctl restart observiq-otel-collector

    1. Vérifiez que le service est en cours d'exécution :

      sudo systemctl status observiq-otel-collector

    2. Recherchez les erreurs dans les journaux :

      sudo journalctl -u observiq-otel-collector -f

  • Pour redémarrer l'agent Bindplane dans Windows, choisissez l'une des options suivantes :

    • Invite de commande ou PowerShell en tant qu'administrateur :

      net stop observiq-otel-collector && net start observiq-otel-collector

    • Console Services :

      1. Appuyez sur Win+R, saisissez services.msc, puis appuyez sur Entrée.
      2. Localisez observIQ OpenTelemetry Collector.
      3. Effectuez un clic droit, puis sélectionnez Redémarrer.

      4. Vérifiez que le service est en cours d'exécution :

        sc query observiq-otel-collector

      5. Recherchez les erreurs dans les journaux :

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

Configurer les journaux d'accès JSON dans Tomcat

  1. Ouvrez le fichier de configuration Tomcat à l'adresse $CATALINA_BASE/conf/server.xml.

  2. Recherchez la balise <Host> et ajoutez-y le code suivant :

    <Valve className="org.apache.catalina.valves.JsonAccessLogValve"
       directory="logs"
       prefix="access-log"
       suffix=".json"
       rotatable="true"
       maxDays="7"/>

  3. Redémarrez Tomcat pour appliquer les modifications :

    cd /path/to/tomcat
bin/catalina.sh stop
bin/catalina.sh start

  4. Un nouveau fichier journal JSON s'affiche chaque jour (par exemple, logs/access-log.2025-07-02.json).

Table de mappage UDM

Champ de journal Mappage UDM Logique
@timestamp metadata.event_timestamp La valeur de @timestamp du journal brut est directement mappée sur ce champ UDM. Elle représente l'heure à laquelle l'événement s'est produit.
agent.ephemeral_id additional.fields[ephemeral_id].value.string_value L'ID éphémère de l'agent est ajouté en tant que paire clé-valeur dans les champs additional.
agent.hostname observer.hostname Le nom d'hôte de l'agent est utilisé comme nom d'hôte de l'observateur.
agent.id observer.asset_id L'ID de l'agent est associé au type d'agent pour créer l'ID d'élément observateur (par exemple, filebeat: <agent_id>).
agent.type observer.application Le type d'agent est utilisé comme application d'observation.
agent.version observer.platform_version La version de l'agent est utilisée comme version de la plate-forme de l'observateur.
host.hostname principal.hostname Le nom d'hôte de l'hôte est utilisé comme nom d'hôte principal.
host.id principal.asset.asset_id L'ID de l'hôte est précédé de Host Id: pour créer l'ID d'élément principal.
host.ip principal.ip, observer.ip L'adresse IP de l'hôte est utilisée pour l'adresse IP du principal et de l'observateur. Si plusieurs adresses IP sont présentes, elles sont fusionnées dans un tableau.
host.mac principal.mac L'adresse MAC de l'hôte est utilisée comme adresse MAC principale. Si plusieurs MAC sont présents, ils sont fusionnés dans un tableau.
host.os.family principal.platform Si la famille de l'OS hôte est rhel ou redhat, la plate-forme principale est définie sur LINUX.
host.os.kernel principal.platform_patch_level La version du noyau de l'OS hôte est utilisée comme niveau de correctif principal de la plate-forme.
host.os.name additional.fields[os_name].value.string_value Le nom de l'OS hôte est ajouté en tant que paire clé-valeur dans les champs additional.
host.os.version principal.platform_version La version de l'OS hôte est utilisée comme version principale de la plate-forme.
log.file.path principal.process.file.full_path Le chemin du journal est utilisé comme chemin d'accès complet au fichier du processus principal.
log_level security_result.severity, security_result.severity_details, security_result.action Le niveau de journalisation permet de déterminer la gravité, les détails de gravité et l'action du résultat de sécurité. DEBUG, INFO et AUDIT correspondent à la gravité INFORMATIONAL et à l'action ALLOW. ERROR correspond à la gravité ERROR et à l'action BLOCK. Les valeurs WARNING et WARN correspondent à une gravité MOYENNE et à une action BLOCK. La valeur brute log_level est également mappée sur severity_details.
logstash.irm_environment additional.fields[irm_environment].value.string_value L'environnement Iron Mountain de Logstash est ajouté en tant que paire clé-valeur dans les champs additional.
logstash.irm_region additional.fields[irm_region].value.string_value La région Iron Mountain de Logstash est ajoutée en tant que paire clé-valeur dans les champs additional.
logstash.irm_site additional.fields[irm_site].value.string_value Le site Iron Mountain de Logstash est ajouté en tant que paire clé-valeur dans les champs additional.
logstash.process.host intermediary.hostname L'hôte de traitement Logstash est utilisé comme nom d'hôte intermédiaire.
logstash.process.timestamp metadata.collected_timestamp Le code temporel de traitement Logstash est utilisé comme code temporel collecté.
logstash.xyz_environment additional.fields[xyz_environment].value.string_value L'environnement xyz de Logstash est ajouté en tant que paire clé/valeur dans les champs additional.
logstash.xyz_region additional.fields[xyz_region].value.string_value La région xyz de Logstash est ajoutée en tant que paire clé-valeur dans les champs additional.
logstash.xyz_site additional.fields[xyz_site].value.string_value Le site xyz de Logstash est ajouté en tant que paire clé-valeur dans les champs additional.
message metadata.description Le champ de message est analysé en tant que JSON et son champ event_message est utilisé comme description des métadonnées. L'application intermédiaire est codée en dur sur logstash. Le type d'événement de métadonnées est codé en dur sur USER_UNCATEGORIZED. Le type de journal des métadonnées est défini sur TOMCAT à partir de batch.type ou batch.log_type du journal brut. Le nom du produit de métadonnées est codé en dur sur Tomcat. Le nom du fournisseur de métadonnées est codé en dur sur Tomcat.
user principal.user.userid Le champ "user" du journal brut est utilisé comme ID utilisateur principal.
product_event metadata.product_event_type Mappé à partir du journal des modifications
summary security_result.summary Mappé à partir du journal des modifications
query additional.fields Mappé à partir du journal des modifications

Journal des modifications

Afficher le journal des modifications pour ce parseur

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.