Google utiliza tecnología de IA para traducir contenido a tu idioma preferido. Las traducciones realizadas con IA pueden contener errores.

Recopila registros de Apache Tomcat

Versión del analizador: 3.0

Compatible con:

Google SecOps SIEM

En este documento, se explica cómo transferir registros de Apache Tomcat a Google Security Operations con el agente de Bindplane.

Apache Tomcat es un servidor de aplicaciones web que genera registros de acceso JSON para solicitudes HTTP, eventos de autenticación y actividad del servidor. El analizador extrae campos de los registros con formato JSON y syslog, y los asigna al modelo de datos unificado (UDM).

Antes de comenzar

Asegúrate de cumplir con los siguientes requisitos previos:

Una instancia de Google SecOps
Windows Server 2016 o posterior, o host de Linux con systemd
Agente de Bindplane instalado en el servidor de Tomcat (para leer archivos de registro locales)
Si se ejecuta detrás de un proxy, asegúrate de que los puertos del firewall estén abiertos según los requisitos del agente de Bindplane
Acceso de administrador al servidor de Tomcat

Obtén credenciales de Google SecOps para el agente de Bindplane

Para autenticar el agente de Bindplane en Google SecOps, elige uno de los siguientes métodos:

Implementaciones nuevas: Usa la API de Chronicle (opción 1).
Implementaciones heredadas: Sigue usando el archivo de autenticación de transferencia (opción 2) hasta que se descontinúe la API de Ingestion el 20 de julio de 2027.

Opción 1: Crea una cuenta de servicio para la API de Chronicle (recomendado)

Accede a la consola deGoogle Cloud y selecciona el proyecto de Google Cloud que está vinculado a tu instancia de Google SecOps.
Ve a IAM y administración > Cuentas de servicio.
Haga clic en Crear cuenta de servicio.
Proporciona los siguientes detalles de configuración:
- Nombre de la cuenta de servicio: Ingresa un nombre para la cuenta (por ejemplo, bindplane-ingest).
- Descripción de la cuenta de servicio: Ingresa una descripción (por ejemplo, Bindplane agent log ingestion).
Haz clic en Crear y continuar.
En la sección Otorga a esta cuenta de servicio acceso al proyecto, haz clic en Seleccionar un rol y elige Editor de Chronicle.
Haz clic en Continuar y, luego, en Listo.
Haz clic en la cuenta de servicio que creaste y, luego, ve a la pestaña Claves.
Haz clic en Agregar clave > Crear clave nueva.
Selecciona JSON y haz clic en Crear. El archivo de claves se descargará en tu computadora.
Guarda el archivo de claves como ingestion-auth.json en el directorio del recopilador de Bindplane (/opt/observiq-otel-collector/ingestion-auth.json en Linux o C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json en Windows) o actualiza creds_file_path en config.yaml para que coincida con la ruta de acceso en la que lo guardas.
Ve a IAM y administración > Configuración y copia el Número de proyecto. Lo necesitarás para la configuración del exportador.

Opción 2: Descarga el archivo de autenticación de transferencia (heredado)

Accede a la consola de Google SecOps.
Ve a Configuración > Administración de datos > Agentes de recopilación. Si estás en una plataforma solo de SIEM, ve a Configuración > Agentes de recopilación.
Descarga el archivo de autenticación de transferencia.
Guarda el archivo de forma segura en el sistema en el que se instalará el agente de Bindplane.

Obtén el ID de cliente de Google SecOps

Accede a la consola de Google SecOps.
Ve a Configuración > Administración > Perfil. Si estás en una plataforma solo de SIEM, ve a Configuración > Perfil.
Copia y guarda el ID de cliente de la sección Detalles de la organización.

Nota: El ID de cliente es obligatorio para configurar el exportador del agente de Bindplane.

Instalar el agente de BindPlane en el servidor de Tomcat para recopilar archivos de registro

Instala el agente de Bindplane en el servidor de Tomcat, ya que necesita leer los archivos de registro locales.

Instalación en Windows

Abre el símbolo del sistema o PowerShell como administrador.

Ejecuta el comando siguiente:

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

Espera a que se complete la instalación.
Ejecuta el siguiente comando para verificar la instalación:
```
sc query observiq-otel-collector
```
El servicio debería mostrarse como RUNNING.

Instalación en Linux

Abre una terminal con privilegios de raíz o sudo.

Ejecuta el comando siguiente:

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

Espera a que se complete la instalación.
Ejecuta el siguiente comando para verificar la instalación:
```
sudo systemctl status observiq-otel-collector
```
El servicio debería mostrarse como active (running).

Recursos de instalación adicionales

Para obtener más opciones de instalación y solución de problemas, consulta la guía de instalación del agente de Bindplane.

Configura el agente de BindPlane para transferir registros de Tomcat y enviarlos a Google SecOps

Ubica el archivo de configuración

Linux:

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

Windows:

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

Edita el archivo de configuración

Reemplaza todo el contenido de config.yaml por la siguiente configuración:

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 configuración

Reemplaza los marcadores de posición que se indican más abajo:

Configuración del receptor:
- include: Es la ruta de acceso a los archivos de registro de acceso JSON de Tomcat. Ajusta para que coincida con el directorio de registros y el patrón de archivos de Tomcat.
- start_at: Se establece en beginning para leer los registros existentes o en end para leer solo las entradas nuevas.
Configuración del exportador:
- creds_file_path: Ruta de acceso completa al archivo de claves JSON de la cuenta de servicio (opción 1):
  - Linux: /opt/observiq-otel-collector/ingestion-auth.json
  - Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- customer_id: Es el ID de cliente copiado de la consola de Google SecOps.
- location: Reemplaza <LOCATION> por la región de tu instancia de Google SecOps (por ejemplo, us, europe o asia-southeast1). El exportador agrega el prefijo chronicle.googleapis.com con este valor. Consulta Extremos regionales para obtener la lista completa.
- project: Reemplaza <PROJECT_NUMBER> por el número de proyecto de IAM y administración > Configuración.
- endpoint: Mantén la configuración como chronicle.googleapis.com.

Exportador de la API de transferencia heredada

Si usas el archivo de autenticación de transferencia de la opción 2, reemplaza el bloque exporters por lo siguiente. Establece creds_file_path en la ruta de acceso al archivo de autenticación de transferencia y, si tu instancia está fuera de EE.UU., reemplaza malachiteingestion-pa.googleapis.com por tu extremo regional (por ejemplo, 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
```

Guarda el archivo de configuración

Después de editarlo, guarda el archivo:
- Linux: Presiona Ctrl+O, luego Enter y, por último, Ctrl+X
- Windows: Haz clic en Archivo > Guardar.

Reinicia el agente de Bindplane para aplicar los cambios.

Para reiniciar el agente de Bindplane en Linux, ejecuta el siguiente comando:
```
sudo systemctl restart observiq-otel-collector
```
1. Verifica que el servicio esté en ejecución:
```
sudo systemctl status observiq-otel-collector
```
2. Revisa los registros en busca de errores:
```
sudo journalctl -u observiq-otel-collector -f
```
Para reiniciar el agente de Bindplane en Windows, elige una de las siguientes opciones:
- Símbolo del sistema o PowerShell como administrador:
```
net stop observiq-otel-collector && net start observiq-otel-collector
```
- Consola de servicios:
  1. Presiona Win+R, escribe services.msc y presiona Intro.
  2. Busca observIQ OpenTelemetry Collector.
  3. Haz clic con el botón derecho y selecciona Reiniciar.
  4. Verifica que el servicio esté en ejecución:
```
sc query observiq-otel-collector
```
  5. Revisa los registros en busca de errores:
```
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
```

Configura los registros de acceso JSON en Tomcat

Abre el archivo de configuración de Tomcat en $CATALINA_BASE/conf/server.xml.

Busca la etiqueta <Host> y agrega lo siguiente dentro de ella:

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

Reinicia Tomcat para aplicar los cambios:

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

Todos los días, aparecerá un archivo de registro JSON nuevo (por ejemplo, logs/access-log.2025-07-02.json).

Tabla de asignación de UDM

Campo de registro	Asignación de UDM	Lógica
`@timestamp`	`metadata.event_timestamp`	El valor de `@timestamp` del registro sin procesar se asigna directamente a este campo de UDM. Representa la hora en que ocurrió el evento.
`agent.ephemeral_id`	`additional.fields[ephemeral_id].value.string_value`	El ID efímero del agente se agrega como un par clave-valor en los campos `additional`.
`agent.hostname`	`observer.hostname`	El nombre de host del agente se usa como el nombre de host del observador.
`agent.id`	`observer.asset_id`	El ID del agente se combina con el tipo de agente para crear el ID del activo del observador (p.ej., `filebeat: <agent_id>`).
`agent.type`	`observer.application`	El tipo de agente se usa como la aplicación de observador.
`agent.version`	`observer.platform_version`	La versión del agente se usa como la versión de la plataforma del observador.
`host.hostname`	`principal.hostname`	El nombre de host del host se usa como el nombre de host principal.
`host.id`	`principal.asset.asset_id`	Se antepone `Host Id:` al ID del host para crear el ID del activo principal.
`host.ip`	`principal.ip`, `observer.ip`	La dirección IP del host se usa para la IP principal y la del observador. Si hay varias IPs, se combinan en un array.
`host.mac`	`principal.mac`	La dirección MAC del host se usa como la dirección MAC principal. Si hay varias MAC, se combinan en un array.
`host.os.family`	`principal.platform`	Si la familia de SO del host es `rhel` o `redhat`, la plataforma principal se establece en `LINUX`.
`host.os.kernel`	`principal.platform_patch_level`	La versión del kernel del SO del host se usa como el nivel de parche principal de la plataforma.
`host.os.name`	`additional.fields[os_name].value.string_value`	El nombre del SO del host se agrega como un par clave-valor en los campos `additional`.
`host.os.version`	`principal.platform_version`	La versión del SO del host se usa como la versión principal de la plataforma.
`log.file.path`	`principal.process.file.full_path`	La ruta de acceso del registro se usa como la ruta de acceso completa del archivo de proceso principal.
`log_level`	`security_result.severity`, `security_result.severity_details`, `security_result.action`	El nivel de registro se usa para determinar la gravedad del resultado de seguridad, los detalles de la gravedad y la acción. DEBUG, INFO y AUDIT se asignan a la gravedad INFORMATIONAL y a la acción ALLOW. ERROR se asigna a la gravedad ERROR y a la acción BLOCK. WARNING y WARN se asignan a la gravedad MEDIUM y a la acción BLOCK. El valor sin procesar de log_level también se asigna a severity_details.
`logstash.irm_environment`	`additional.fields[irm_environment].value.string_value`	El entorno de Iron Mountain de Logstash se agrega como un par clave-valor en los campos `additional`.
`logstash.irm_region`	`additional.fields[irm_region].value.string_value`	La región de Iron Mountain de Logstash se agrega como un par clave-valor en los campos `additional`.
`logstash.irm_site`	`additional.fields[irm_site].value.string_value`	El sitio de Iron Mountain de Logstash se agrega como un par clave-valor en los campos de `additional`.
`logstash.process.host`	`intermediary.hostname`	El host de procesamiento de Logstash se usa como el nombre de host intermediario.
`logstash.process.timestamp`	`metadata.collected_timestamp`	La marca de tiempo de procesamiento de Logstash se usa como la marca de tiempo recopilada.
`logstash.xyz_environment`	`additional.fields[xyz_environment].value.string_value`	El entorno xyz de Logstash se agrega como un par clave-valor en los campos `additional`.
`logstash.xyz_region`	`additional.fields[xyz_region].value.string_value`	La región xyz de Logstash se agrega como un par clave-valor en los campos `additional`.
`logstash.xyz_site`	`additional.fields[xyz_site].value.string_value`	El sitio xyz de Logstash se agrega como un par clave-valor en los campos `additional`.
`message`	`metadata.description`	El campo de mensaje se analiza como JSON y su campo `event_message` se usa como la descripción de los metadatos. La aplicación intermediaria está codificada en `logstash`. El tipo de evento de metadatos está codificado como `USER_UNCATEGORIZED`. El tipo de registro de metadatos se establece en `TOMCAT` desde batch.type o batch.log_type del registro sin procesar. El nombre del producto de metadatos está codificado como `Tomcat`. El nombre del proveedor de metadatos está codificado como `Tomcat`.
`user`	`principal.user.userid`	El campo de usuario del registro sin procesar se usa como el ID de usuario principal.
`product_event`	`metadata.product_event_type`	Asignado desde el registro de cambios
`summary`	`security_result.summary`	Asignado desde el registro de cambios
`query`	`additional.fields`	Asignado desde el registro de cambios

Registro de cambios

Consulta el registro de cambios de este analizador

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.