Google utilise la technologie IA pour traduire le contenu dans votre langue préférée. Les traductions générées par IA peuvent contenir des erreurs.

Collecter les journaux Apache Tomcat

Version de l'analyseur : 3.0

Compatible avec :

Google SecOps SIEM

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 du pare-feu sont ouverts conformément aux exigences de l'agent BindPlane.
Accès administrateur au serveur Tomcat

Obtenir des identifiants Google SecOps pour l'agent BindPlane

Pour authentifier l'agent Bindplane auprès de Google SecOps, choisissez l'une des méthodes suivantes :

Nouveaux déploiements : utilisez l'API Chronicle (option 1).
Anciens déploiements : continuez à utiliser le fichier d'authentification d'ingestion (option 2) jusqu'à l'arrêt de l'API Ingestion le 20 juillet 2027.

Option 1 : Créer un compte de service pour l'API Chronicle (recommandé)

Connectez-vous à la consoleGoogle Cloud et sélectionnez le projet Google Cloud associé à votre instance Google SecOps.
Accédez à IAM et administration > Comptes de service.
Cliquez sur Créer un compte de service.
Fournissez les informations de configuration suivantes :
- Nom du compte de service : saisissez un nom pour le compte (par exemple, bindplane-ingest).
- Description du compte de service : saisissez une description (par exemple, Bindplane agent log ingestion).
Cliquez sur Créer et continuer.
Dans la section Autoriser ce compte de service à accéder au projet, cliquez sur Sélectionner un rôle, puis sélectionnez Éditeur Chronicle.
Cliquez sur Continue (Continuer), puis sur Done (OK).
Cliquez sur le compte de service que vous avez créé, puis accédez à l'onglet Clés.
Cliquez sur Ajouter une clé > Créer une clé.
Sélectionnez JSON, puis cliquez sur Créer. Le fichier de clé est téléchargé sur votre ordinateur.
Enregistrez le fichier de clé sous le nom ingestion-auth.json dans le répertoire du collecteur BindPlane (/opt/observiq-otel-collector/ingestion-auth.json sous Linux ou C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json sous Windows), ou mettez à jour creds_file_path dans config.yaml pour qu'il corresponde au chemin d'accès où vous l'enregistrez.
Accédez à IAM et administration > Paramètres, puis copiez le numéro du projet. Vous en aurez besoin pour la configuration de l'exportateur.

Option 2 : Télécharger le fichier d'authentification d'ingestion (ancienne méthode)

Connectez-vous à la console Google SecOps.
Accédez à Paramètres SIEM> Agents de collecte.
Téléchargez le fichier d'authentification d'ingestion.
Enregistrez le fichier de manière sécurisée sur le système où l'agent BindPlane sera installé.

Obtenir l'ID client Google SecOps

Connectez-vous à la console Google SecOps.
Accédez à Paramètres SIEM > Profil.
Copiez et enregistrez le numéro client dans la section Détails de l'organisation.

Remarque : L'ID client est requis pour configurer l'exportateur de l'agent Bindplane.

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

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

Exécutez la commande suivante :

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

Attendez la fin de l'installation.
Vérifiez l'installation en exécutant la commande suivante :
```
sc query observiq-otel-collector
```
Le service doit s'afficher comme étant EN COURS D'EXÉCUTION.

Installation de Linux

Ouvrez un terminal avec des droits d'accès racine ou sudo.

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

Attendez la fin de l'installation.
Vérifiez l'installation en exécutant la commande suivante :
```
sudo systemctl status observiq-otel-collector
```
Le service doit s'afficher comme actif (en cours d'exécution).

Ressources d'installation supplémentaires

Pour en savoir plus sur les options d'installation et le 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:
    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

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-le en fonction de votre répertoire de journaux Tomcat et de votre format de fichier.
- start_at : définissez cette option sur beginning pour lire les journaux existants ou sur end pour ne lire que les nouvelles entrées.
Configuration de l'exportateur :
- creds_file_path : chemin d'accès complet au fichier de clé JSON du compte de service (option 1) :
  - Linux : /opt/observiq-otel-collector/ingestion-auth.json
  - Windows : C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- customer_id : ID client copié depuis la console Google SecOps
- location : remplacez <LOCATION> par la région de votre instance Google SecOps (par exemple, us, europe ou asia-southeast1). L'exportateur ajoute cette valeur en préfixe à chronicle.googleapis.com. Pour obtenir la liste complète, consultez Points de terminaison régionaux.
- project : remplacez <PROJECT_NUMBER> par le numéro de projet indiqué dans IAM et administration > Paramètres.
- endpoint : laissez la valeur définie sur chronicle.googleapis.com.

Ancien exportateur d'API d'ingestion

Si vous utilisez le fichier d'authentification d'ingestion de l'option 2, remplacez le bloc exporters par le code suivant. Définissez creds_file_path sur le chemin d'accès au fichier d'authentification d'ingestion. Si votre instance se trouve en dehors des États-Unis, remplacez malachiteingestion-pa.googleapis.com par votre point de terminaison régional (par exemple, 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
```

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. Recherchez observIQ OpenTelemetry Collector.
  3. Effectuez un clic droit et 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

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

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"/>

Redémarrez Tomcat pour appliquer les modifications :

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

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

Table de mappage UDM

Champ du journal	Mappage UDM	Logique
`@timestamp`	`metadata.event_timestamp`	La valeur de `@timestamp` du journal brut est directement mappée à ce champ UDM. Il 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 d'observation.
`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 à la fois pour l'adresse IP principale et l'adresse IP 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 d'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 de la plate-forme principale.
`log.file.path`	`principal.process.file.full_path`	Le chemin d'accès au 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é du résultat de sécurité, les détails de la gravité et l'action. DEBUG, INFO et AUDIT correspondent au niveau de 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 du message est analysé au format 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 de cet analyseur

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