Coletar registros do Apache Tomcat

Versão do analisador:3.0

Compatível com:

Google SecOps SIEM

Neste documento, explicamos como ingerir registros do Apache Tomcat no Google Security Operations usando o agente do Bindplane.

O Apache Tomcat é um servidor de aplicativos da Web que gera registros de acesso JSON para solicitações HTTP, eventos de autenticação e atividade do servidor. O analisador extrai campos de registros formatados em JSON e syslog e os mapeia para o modelo de dados unificado (UDM).

Antes de começar

Verifique se você tem os pré-requisitos a seguir:

• Uma instância do Google SecOps
• Windows Server 2016 ou mais recente ou host do Linux com systemd
• Agente do Bindplane instalado no servidor do Tomcat (para ler arquivos de registro locais)
• Se você estiver executando por trás de um proxy, verifique se as portas do firewall estão abertas de acordo com os requisitos do agente do Bindplane.
• Acesso administrativo ao servidor Tomcat

Receber credenciais do Google SecOps para o agente do BindPlane

Para autenticar o agente do Bindplane no Google SecOps, escolha um dos seguintes métodos:

• Novas implantações: use a API Chronicle (opção 1).
• Implantações legadas: continue usando o arquivo de autenticação de ingestão (opção 2) até que a API Ingestion seja desativada em 20 de julho de 2027.

Opção 1: criar uma conta de serviço para a API Chronicle (recomendado)

1. Faça login no consoleGoogle Cloud e selecione o projeto Google Cloud vinculado à sua instância do Google SecOps.
2. Acesse IAM e administrador > Contas de serviço.
3. Clique em Criar conta de serviço.
4. Informe os seguintes detalhes de configuração:
   • Nome da conta de serviço: insira um nome para a conta (por exemplo, bindplane-ingest).
   • Descrição da conta de serviço: insira uma descrição (por exemplo, Bindplane agent log ingestion).
5. Clique em Criar e continuar.
6. Na seção Conceder a essa conta de serviço acesso ao projeto, clique em Selecionar uma função e escolha Editor do Chronicle.
7. Clique em Continuar e depois em Concluído.
8. Clique na conta de serviço que você criou e acesse a guia Chaves.
9. Clique em Adicionar chave > Criar nova chave.
10. Selecione JSON e clique em Criar. O download do arquivo de chave é feito no seu computador.
11. Salve o arquivo de chave como ingestion-auth.json no diretório do coletor do Bindplane (/opt/observiq-otel-collector/ingestion-auth.json no Linux ou C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json no Windows) ou atualize creds_file_path em config.yaml para corresponder ao caminho em que você o salvou.
12. Acesse IAM e administrador > Configurações e copie o número do projeto. Você vai precisar dele para configurar o exportador.

Observação: a chave JSON é uma credencial. Restrinja o acesso ao arquivo no host do BindPlane e alterne a chave de acordo com a política da sua organização.

Opção 2: fazer o download do arquivo de autenticação de ingestão (legado)

1. Faça login no console do Google SecOps.
2. Acesse Configurações do SIEM > Agentes de coleta.
3. Baixe o arquivo de autenticação de ingestão.
4. Salve o arquivo com segurança no sistema em que o agente do Bindplane será instalado.

Observação: esse arquivo autentica o agente na API Ingestion legada (malachiteingestion-pa.googleapis.com), que o Google programou para ser desativada em 20 de julho de 2027. Planeje a mudança para a Opção 1 antes dessa data.

Receber o ID de cliente do Google SecOps

1. Faça login no console do Google SecOps.
2. Acesse Configurações do SIEM > Perfil.

3. Copie e salve o ID de cliente na seção Detalhes da organização.

   Observação :o ID de cliente é necessário para configurar o exportador do agente do BindPlane.

Instale o agente do Bindplane no servidor Tomcat para coletar arquivos de registro

Instale o agente do BindPlane no próprio servidor do Tomcat, já que ele precisa ler arquivos de registro locais.

Instalação do Windows

1. Abra o Prompt de comando ou o PowerShell como administrador.

2. Execute este comando:

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

3. Aguarde a conclusão da instalação.

4. Execute o seguinte comando para confirmar a instalação:

   sc query observiq-otel-collector
   

   O serviço vai aparecer como EM EXECUÇÃO.

Instalação do Linux

1. Abra um terminal com privilégios de raiz ou sudo.

2. Execute este comando:

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

3. Aguarde a conclusão da instalação.

4. Execute o seguinte comando para confirmar a instalação:

   sudo systemctl status observiq-otel-collector
   

   O serviço precisa aparecer como active (running).

Outros recursos de instalação

Para mais opções de instalação e solução de problemas, consulte o guia de instalação do agente do Bindplane.

Observação: a configuração do exportador da API Chronicle requer o coletor do Bindplane v1.106.0 ou mais recente. Os comandos anteriores instalam a versão mais recente. Se você estiver atualizando uma instalação, faça upgrade do coletor antes de mudar a configuração.

Configurar o agente do Bindplane para ingerir registros do Tomcat e enviar ao Google SecOps

Localize o arquivo de configuração.

• Linux:

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

• Windows:

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

Editar o arquivo de configuração

• Substitua todo o conteúdo de config.yaml pela seguinte configuração:

  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
  

Parâmetros de configuração

Substitua os seguintes marcadores de posição:

• Configuração do receptor:

  • include: caminho para os arquivos de registro de acesso JSON do Tomcat. Ajuste para corresponder ao diretório de registros e ao padrão de arquivo do Tomcat.
  • start_at: defina como beginning para ler os registros atuais ou end para ler apenas as novas entradas.

• Configuração do exportador:

  • creds_file_path: caminho completo para o arquivo de chave JSON da conta de serviço (opção 1):
    • Linux: /opt/observiq-otel-collector/ingestion-auth.json
    • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • customer_id: ID de cliente copiado do console do Google SecOps
  • location: substitua <LOCATION> pela região da sua instância do Google SecOps (por exemplo, us, europe ou asia-southeast1). O exportador prefixa chronicle.googleapis.com com esse valor. Consulte Endpoints regionais para ver a lista completa.
  • project: substitua <PROJECT_NUMBER> pelo número do projeto em IAM e administrador > Configurações.
  • endpoint: mantenha definido como chronicle.googleapis.com.

Exportador da API de ingestão legada

• Se você usar o arquivo de autenticação de ingestão da Opção 2, substitua o bloco exporters pelo seguinte. Defina creds_file_path como o caminho para o arquivo de autenticação de ingestão e, se a instância estiver fora dos EUA, substitua malachiteingestion-pa.googleapis.com pelo endpoint regional (por exemplo, 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
  

Observação: esse exportador vai parar de funcionar quando a API Ingestion for desativada em 20 de julho de 2027.

Salve o arquivo de configuração.

• Depois de editar, salve o arquivo:
  • Linux: pressione Ctrl+O, depois Enter e, em seguida, Ctrl+X.
  • Windows: clique em Arquivo > Salvar.

Reinicie o agente do Bindplane para aplicar as mudanças:

• Para reiniciar o agente do Bindplane no Linux, execute o seguinte comando:

  sudo systemctl restart observiq-otel-collector
  

  1. Verifique se o serviço está em execução:

     sudo systemctl status observiq-otel-collector
     

  2. Verifique se há erros nos registros:

     sudo journalctl -u observiq-otel-collector -f
     

• Para reiniciar o agente do BindPlane no Windows, escolha uma das seguintes opções:

  • Prompt de comando ou PowerShell como administrador:

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

  • Console de serviços:

    1. Pressione Win+R, digite services.msc e pressione Enter.
    2. Localize o coletor do OpenTelemetry da observIQ.
    3. Clique com o botão direito do mouse e selecione Reiniciar.

    4. Verifique se o serviço está em execução:

       sc query observiq-otel-collector
       

    5. Verifique se há erros nos registros:

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

Configurar registros de acesso JSON no Tomcat

1. Abra o arquivo de configuração do Tomcat em $CATALINA_BASE/conf/server.xml.

2. Localize a tag <Host> e adicione o seguinte dentro dela:

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

3. Reinicie o Tomcat para aplicar as mudanças:

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

4. Um novo arquivo de registro JSON vai aparecer diariamente (por exemplo, logs/access-log.2025-07-02.json).

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
@timestamp	metadata.event_timestamp	O valor de @timestamp do registro bruto é mapeado diretamente para esse campo do UDM. Ele representa o momento em que o evento ocorreu.
agent.ephemeral_id	additional.fields[ephemeral_id].value.string_value	O ID efêmero do agente é adicionado como um par de chave-valor nos campos additional.
agent.hostname	observer.hostname	O nome do host do agente é usado como o nome do host do observador.
agent.id	observer.asset_id	O ID do agente é combinado com o tipo de agente para criar o código do recurso observador (por exemplo, filebeat: <agent_id>).
agent.type	observer.application	O tipo de agente é usado como o aplicativo observador.
agent.version	observer.platform_version	A versão do agente é usada como a versão da plataforma do observador.
host.hostname	principal.hostname	O nome do host é usado como o nome do host principal.
host.id	principal.asset.asset_id	O ID do host é precedido por Host Id: para criar o ID do recurso principal.
host.ip	principal.ip, observer.ip	O endereço IP do host é usado para o IP principal e o IP do observador. Se houver vários IPs, eles serão mesclados em uma matriz.
host.mac	principal.mac	O endereço MAC do host é usado como o endereço MAC principal. Se houver vários MACs, eles serão mesclados em uma matriz.
host.os.family	principal.platform	Se a família do SO host for rhel ou redhat, a plataforma principal será definida como LINUX.
host.os.kernel	principal.platform_patch_level	A versão do kernel do SO do host é usada como o nível principal de patch da plataforma.
host.os.name	additional.fields[os_name].value.string_value	O nome do SO do host é adicionado como um par de chave-valor nos campos additional.
host.os.version	principal.platform_version	A versão do SO do host é usada como a versão principal da plataforma.
log.file.path	principal.process.file.full_path	O caminho do registro é usado como o caminho completo do arquivo principal do processo.
log_level	security_result.severity, security_result.severity_details, security_result.action	O nível de registro é usado para determinar a gravidade do resultado de segurança, os detalhes da gravidade e a ação. DEBUG, INFO e AUDIT são mapeados para a gravidade INFORMATIONAL e a ação ALLOW. ERROR é mapeado para a gravidade ERROR e a ação BLOCK. WARNING e WARN são mapeados para a gravidade MEDIUM e a ação BLOCK. O valor bruto de log_level também é mapeado para severity_details.
logstash.irm_environment	additional.fields[irm_environment].value.string_value	O ambiente da Iron Mountain do Logstash é adicionado como um par de chave-valor nos campos additional.
logstash.irm_region	additional.fields[irm_region].value.string_value	A região da Iron Mountain do Logstash é adicionada como um par de chave-valor nos campos additional.
logstash.irm_site	additional.fields[irm_site].value.string_value	O site da Iron Mountain do Logstash é adicionado como um par de chave-valor nos campos additional.
logstash.process.host	intermediary.hostname	O host de processamento do Logstash é usado como o nome do host intermediário.
logstash.process.timestamp	metadata.collected_timestamp	O carimbo de data/hora de processamento do Logstash é usado como o carimbo de data/hora coletado.
logstash.xyz_environment	additional.fields[xyz_environment].value.string_value	O ambiente xyz do Logstash é adicionado como um par de chave-valor nos campos additional.
logstash.xyz_region	additional.fields[xyz_region].value.string_value	A região xyz do Logstash é adicionada como um par de chave-valor nos campos additional.
logstash.xyz_site	additional.fields[xyz_site].value.string_value	O site xyz do Logstash é adicionado como um par de chave-valor nos campos additional.
message	metadata.description	O campo de mensagem é analisado como JSON, e o campo event_message é usado como a descrição dos metadados. O aplicativo intermediário está fixado no código como logstash. O tipo de evento de metadados está fixado no código como USER_UNCATEGORIZED. O tipo de registro de metadados é definido como TOMCAT do batch.type ou batch.log_type do registro bruto. O nome do produto de metadados está fixado no código como Tomcat. O nome do fornecedor de metadados é fixado como Tomcat.
user	principal.user.userid	O campo de usuário do registro bruto é usado como o ID do usuário principal.
product_event	metadata.product_event_type	Mapeado do registro de mudanças
summary	security_result.summary	Mapeado do registro de alterações
query	additional.fields	Mapeado do registro de alterações

Registro de alterações

Ver o registro de alterações deste analisador

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.