Raccogli i log di Apache Tomcat

Versione parser: 3.0

Supportata in:

Google SecOps SIEM

Questo documento spiega come importare i log di Apache Tomcat in Google Security Operations utilizzando l'agente Bindplane.

Apache Tomcat è un server di applicazioni web che genera log di accesso JSON per richieste HTTP, eventi di autenticazione e attività del server. Il parser estrae i campi dai log formattati in JSON e syslog e li mappa al modello UDM (Unified Data Model).

Prima di iniziare

Assicurati di soddisfare i seguenti prerequisiti:

• Un'istanza Google SecOps
• Windows Server 2016 o versioni successive o host Linux con systemd
• Agente Bindplane installato sul server Tomcat (per leggere i file di log locali)
• Se l'esecuzione avviene dietro un proxy, assicurati che le porte del firewall siano aperte in base ai requisiti dell'agente Bindplane
• Accesso amministrativo al server Tomcat

Recupera le credenziali Google SecOps per l'agente Bindplane

Per autenticare l'agente Bindplane in Google SecOps, scegli uno dei seguenti metodi:

• Nuove implementazioni: utilizza l'API Chronicle (opzione 1).
• Deployment legacy: continua a utilizzare il file di autenticazione dell'acquisizione (Opzione 2) fino alla dismissione dell'API Ingestion il 20 luglio 2027.

Opzione 1: crea un account di servizio per l'API Chronicle (consigliata)

1. Accedi alla Google Cloud console e seleziona il progetto Google Cloud collegato alla tua istanza Google SecOps.
2. Vai a IAM e amministrazione > Service account.
3. Fai clic su Crea service account.
4. Fornisci i seguenti dettagli di configurazione:
   • Nome service account: inserisci un nome per l'account (ad esempio bindplane-ingest).
   • Descrizione service account: inserisci una descrizione (ad esempio Bindplane agent log ingestion).
5. Fai clic su Crea e continua.
6. Nella sezione Concedi a questo account di servizio l'accesso al progetto, fai clic su Seleziona un ruolo e seleziona Editor Chronicle.
7. Fai clic su Continua e poi su Fine.
8. Fai clic sul account di servizio che hai creato, quindi vai alla scheda Chiavi.
9. Fai clic su Aggiungi chiave > Crea nuova chiave.
10. Seleziona JSON e fai clic su Crea. Il file della chiave viene scaricato sul computer.
11. Salva il file della chiave come ingestion-auth.json nella directory del raccoglitore Bindplane (/opt/observiq-otel-collector/ingestion-auth.json su Linux o C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json su Windows) o aggiorna creds_file_path in config.yaml in modo che corrisponda al percorso in cui lo salvi.
12. Vai a IAM e amministrazione > Impostazioni e copia il Numero progetto. Ti servirà per la configurazione dell'esportatore.

Nota: la chiave JSON è una credenziale. Limita l'accesso al file sull'host Bindplane e ruota la chiave in base alle norme della tua organizzazione.

Opzione 2: scarica il file di autenticazione dell'acquisizione (legacy)

1. Accedi alla console Google SecOps.
2. Vai a Impostazioni SIEM > Agenti di raccolta.
3. Scarica il file di autenticazione dell'acquisizione.
4. Salva il file in modo sicuro sul sistema in cui verrà installato l'agente Bindplane.

Nota: questo file autentica l'agente nell'API Ingestion precedente (malachiteingestion-pa.googleapis.com), che Google ha programmato per la fine del ciclo di vita il 20 luglio 2027. Pianifica di passare all'opzione 1 prima di questa data.

Ottieni l'ID cliente Google SecOps

1. Accedi alla console Google SecOps.
2. Vai a Impostazioni SIEM > Profilo.

3. Copia e salva l'ID cliente dalla sezione Dettagli organizzazione.

   Nota: l'ID cliente è necessario per configurare l'esportatore dell'agente Bindplane.

Installa l'agente Bindplane sul server Tomcat per raccogliere i file di log

Installa l'agente Bindplane sul server Tomcat stesso, poiché deve leggere i file di log locali.

Installazione di Windows

1. Apri il prompt dei comandi o PowerShell come amministratore.

2. Esegui questo comando:

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

3. Attendi il completamento dell'installazione.

4. Verifica l'installazione eseguendo:

   sc query observiq-otel-collector
   

   Il servizio dovrebbe essere visualizzato come RUNNING.

Installazione di Linux

1. Apri un terminale con privilegi root o sudo.

2. Esegui questo comando:

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

3. Attendi il completamento dell'installazione.

4. Verifica l'installazione eseguendo:

   sudo systemctl status observiq-otel-collector
   

   Il servizio dovrebbe essere visualizzato come attivo (in esecuzione).

Risorse aggiuntive per l'installazione

Per ulteriori opzioni di installazione e risoluzione dei problemi, consulta la guida all'installazione dell'agente Bindplane.

Nota: la configurazione dell'esportatore dell'API Chronicle richiede Bindplane Collector v1.106.0 o versioni successive. I comandi precedenti installano l'ultima release. Se stai aggiornando un'installazione esistente, esegui l'upgrade del raccoglitore prima di modificare la configurazione.

Configura l'agente Bindplane per importare i log di Tomcat e inviarli a Google SecOps

Individua il file di configurazione

• Linux:

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

• Windows:

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

Modifica il file di configurazione

• Sostituisci l'intero contenuto di config.yaml con la seguente configurazione:

  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
  

Parametri di configurazione

Sostituisci i seguenti segnaposto:

• Configurazione del ricevitore:

  • include: percorso dei file di log di accesso JSON di Tomcat. Modifica in base alla directory dei log e al pattern dei file di Tomcat.
  • start_at: impostalo su beginning per leggere i log esistenti o su end per leggere solo le nuove voci.

• Configurazione dell'esportatore:

  • creds_file_path: percorso completo del file della chiave JSON del account di servizio (opzione 1):
    • Linux: /opt/observiq-otel-collector/ingestion-auth.json
    • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • customer_id: ID cliente copiato dalla console Google SecOps
  • location: sostituisci <LOCATION> con la regione della tua istanza Google SecOps (ad esempio us, europe o asia-southeast1). L'esportatore antepone chronicle.googleapis.com a questo valore. Per l'elenco completo, consulta Endpoint regionali.
  • project: sostituisci <PROJECT_NUMBER> con il numero di progetto in IAM e amministrazione > Impostazioni.
  • endpoint: mantieni l'impostazione su chronicle.googleapis.com.

Esportatore API di importazione legacy

• Se utilizzi il file di autenticazione dell'importazione dell'opzione 2, sostituisci il blocco exporters con il seguente. Imposta creds_file_path sul percorso del file di autenticazione dell'importazione e, se la tua istanza si trova al di fuori degli Stati Uniti, sostituisci malachiteingestion-pa.googleapis.com con l'endpoint regionale (ad esempio, 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
  

Nota: questo esportatore smetterà di funzionare quando l'API Ingestion verrà ritirata il 20 luglio 2027.

Salva il file di configurazione

• Dopo la modifica, salva il file:
  • Linux: premi Ctrl+O, poi Enter e infine Ctrl+X.
  • Windows: fai clic su File > Salva.

Riavvia l'agente Bindplane per applicare le modifiche

• Per riavviare l'agente Bindplane in Linux, esegui questo comando:

  sudo systemctl restart observiq-otel-collector
  

  1. Verifica che il servizio sia in esecuzione:

     sudo systemctl status observiq-otel-collector
     

  2. Controlla i log per verificare la presenza di errori:

     sudo journalctl -u observiq-otel-collector -f
     

• Per riavviare l'agente Bindplane in Windows, scegli una delle seguenti opzioni:

  • Prompt dei comandi o PowerShell come amministratore:

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

  • Console Servizi:

    1. Premi Win+R, digita services.msc e premi Invio.
    2. Individua observIQ OpenTelemetry Collector.
    3. Fai clic con il tasto destro del mouse e seleziona Riavvia.

    4. Verifica che il servizio sia in esecuzione:

       sc query observiq-otel-collector
       

    5. Controlla i log per verificare la presenza di errori:

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

Configura i log di accesso JSON in Tomcat

1. Apri il file di configurazione di Tomcat all'indirizzo $CATALINA_BASE/conf/server.xml.

2. Individua il tag <Host> e aggiungi quanto segue al suo interno:

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

3. Riavvia Tomcat per applicare le modifiche:

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

4. Ogni giorno verrà visualizzato un nuovo file di log JSON (ad esempio, logs/access-log.2025-07-02.json).

Tabella di mappatura UDM

Campo log	Mappatura UDM	Logica
@timestamp	metadata.event_timestamp	Il valore di @timestamp del log non elaborato viene mappato direttamente a questo campo UDM. Rappresenta l'ora in cui si è verificato l'evento.
agent.ephemeral_id	additional.fields[ephemeral_id].value.string_value	L'ID effimero dell'agente viene aggiunto come coppia chiave-valore nei campi additional.
agent.hostname	observer.hostname	Il nome host dell'agente viene utilizzato come nome host dell'osservatore.
agent.id	observer.asset_id	L'ID agente viene combinato con il tipo di agente per creare l'ID risorsa dell'osservatore (ad es. filebeat: <agent_id>).
agent.type	observer.application	Il tipo di agente viene utilizzato come applicazione osservatore.
agent.version	observer.platform_version	La versione dell'agente viene utilizzata come versione della piattaforma dell'osservatore.
host.hostname	principal.hostname	Il nome host dell'host viene utilizzato come nome host principale.
host.id	principal.asset.asset_id	L'ID host è preceduto da Host Id: per creare l'ID risorsa principale.
host.ip	principal.ip, observer.ip	L'indirizzo IP dell'host viene utilizzato sia per l'IP principale sia per l'IP osservatore. Se sono presenti più indirizzi IP, questi vengono uniti in un array.
host.mac	principal.mac	L'indirizzo MAC dell'host viene utilizzato come indirizzo MAC principale. Se sono presenti più indirizzi MAC, questi vengono uniti in un array.
host.os.family	principal.platform	Se la famiglia del sistema operativo host è rhel o redhat, la piattaforma principale è impostata su LINUX.
host.os.kernel	principal.platform_patch_level	La versione kernel del sistema operativo host viene utilizzata come livello di patch della piattaforma principale.
host.os.name	additional.fields[os_name].value.string_value	Il nome del sistema operativo host viene aggiunto come coppia chiave-valore nei campi additional.
host.os.version	principal.platform_version	La versione del sistema operativo host viene utilizzata come versione principale della piattaforma.
log.file.path	principal.process.file.full_path	Il percorso del log viene utilizzato come percorso completo del file di processo principale.
log_level	security_result.severity, security_result.severity_details, security_result.action	Il livello di log viene utilizzato per determinare la gravità, i dettagli della gravità e l'azione del risultato di sicurezza. DEBUG, INFO e AUDIT vengono mappati alla gravità INFORMATIONAL e all'azione ALLOW. ERROR corrisponde alla gravità ERROR e all'azione BLOCK. WARNING e WARN vengono mappati alla gravità MEDIA e all'azione BLOCK. Il valore log_level non elaborato viene mappato anche a severity_details.
logstash.irm_environment	additional.fields[irm_environment].value.string_value	L'ambiente Iron Mountain di Logstash viene aggiunto come coppia chiave-valore nei campi additional.
logstash.irm_region	additional.fields[irm_region].value.string_value	La regione Iron Mountain di Logstash viene aggiunta come coppia chiave-valore nei campi additional.
logstash.irm_site	additional.fields[irm_site].value.string_value	Il sito Iron Mountain di Logstash viene aggiunto come coppia chiave-valore nei campi additional.
logstash.process.host	intermediary.hostname	L'host di elaborazione Logstash viene utilizzato come nome host intermediario.
logstash.process.timestamp	metadata.collected_timestamp	Il timestamp di elaborazione di Logstash viene utilizzato come timestamp della raccolta.
logstash.xyz_environment	additional.fields[xyz_environment].value.string_value	L'ambiente xyz di Logstash viene aggiunto come coppia chiave-valore nei campi additional.
logstash.xyz_region	additional.fields[xyz_region].value.string_value	La regione xyz di Logstash viene aggiunta come coppia chiave-valore nei campi additional.
logstash.xyz_site	additional.fields[xyz_site].value.string_value	Il sito xyz di Logstash viene aggiunto come coppia chiave-valore nei campi additional.
message	metadata.description	Il campo del messaggio viene analizzato come JSON e il relativo campo event_message viene utilizzato come descrizione dei metadati. L'applicazione intermediaria è impostata come hardcoded su logstash. Il tipo di evento dei metadati è codificato in modo permanente su USER_UNCATEGORIZED. Il tipo di log dei metadati è impostato su TOMCAT dal batch.type o batch.log_type del log non elaborato. Il nome del prodotto dei metadati è impostato come hardcoded su Tomcat. Il nome del fornitore dei metadati è impostato come hardcoded su Tomcat.
user	principal.user.userid	Il campo user del log non elaborato viene utilizzato come ID utente principale.
product_event	metadata.product_event_type	Mappato dal log delle modifiche
summary	security_result.summary	Mappato dal log delle modifiche
query	additional.fields	Mappato dal log delle modifiche

Log delle modifiche

Visualizza il log delle modifiche per questo parser

Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.