收集 IBM WebSphere Application Server 服务器日志
本文档介绍了如何使用 Bindplane 代理将 IBM WebSphere Application Server 服务器日志注入 Google Security Operations。
IBM WebSphere Application Server 是一款 Java EE 应用服务器,可生成系统日志、安全审核日志和访问日志。解析器会将这些日志映射到统一数据模型 (UDM),提取进程详细信息、用户信息、事件时间戳和文件元数据。
准备工作
请确保满足以下前提条件:
- Google SecOps 实例
- Windows Server 2016 或更高版本,或者安装了
systemd的 Linux 主机 - Bindplane 代理与 IBM WebSphere Application Server 之间的网络连接
- 如果在代理后面运行,请确保按照 Bindplane 代理要求打开防火墙端口
- 对 IBM WebSphere Application Server 的管理员权限
获取 Bindplane 代理的 Google SecOps 凭证
如需向 Google SecOps 验证 Bindplane 代理,请选择以下方法之一:
- 新部署:使用 Chronicle API(选项 1)。
- 旧版部署:继续使用数据注入身份验证文件(方法 2),直到 Ingestion API 于 2027 年 7 月 20 日停用。
方法 1:为 Chronicle API 创建服务账号(推荐)
- 登录 Google Cloud 控制台,然后选择与您的 Google SecOps 实例关联的 Google Cloud 项目。
- 依次前往 IAM 和管理 > 服务账号。
- 点击创建服务账号。
- 提供以下配置详细信息:
- 服务账号名称:输入账号的名称(例如
bindplane-ingest)。 - 服务账号说明:输入说明(例如
Bindplane agent log ingestion)。
- 服务账号名称:输入账号的名称(例如
- 点击创建并继续。
- 在向此服务账号授予对项目的访问权限部分,点击选择角色,然后选择 Chronicle Editor。
- 点击继续,然后点击完成。
- 点击您创建的服务账号,然后前往密钥标签页。
- 依次点击添加密钥 > 创建新密钥。
- 选择 JSON,然后点击创建。密钥文件会下载到您的计算机上。
- 将密钥文件另存为 Bindplane 收集器目录(Linux 上的
/opt/observiq-otel-collector/ingestion-auth.json或 Windows 上的C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json)中的ingestion-auth.json,或更新config.yaml中的creds_file_path以匹配您保存它的路径。 - 前往 IAM 和管理 > 设置,然后复制项目编号。您在配置导出器时需要用到该名称。
方法 2:下载数据注入身份验证文件(旧版)
- 登录 Google SecOps 控制台。
- 依次前往设置 > 数据管理 > 收集代理。如果您使用的是仅限 SIEM 的平台,请依次前往设置 > 收集代理。
- 下载数据注入身份验证文件。
- 将该文件安全地保存在将要安装 Bindplane 代理的系统上。
获取 Google SecOps 客户 ID
- 登录 Google SecOps 控制台。
- 依次前往设置 > 管理 > 个人资料。如果您使用的是仅限 SIEM 的平台,请依次前往设置 > 个人资料。
复制并保存组织详细信息部分中的客户 ID。
安装 Bindplane 代理
根据以下说明,在 Windows 或 Linux 操作系统上安装 Bindplane 代理。
Windows 安装
- 以管理员身份打开命令提示符或 PowerShell。
运行以下命令:
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet等待安装完成。
运行以下命令,验证安装是否成功:
sc query observiq-otel-collector该服务应显示为正在运行。
Linux 安装
- 打开具有 root 或 sudo 权限的终端。
运行以下命令:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh等待安装完成。
运行以下命令,验证安装是否成功:
sudo systemctl status observiq-otel-collector该服务应显示为 active (running)。
其他安装资源
如需了解其他安装选项和问题排查,请参阅 Bindplane 代理安装指南。
配置 Bindplane 代理以注入日志并发送到 Google SecOps
找到配置文件
Linux:
sudo nano /opt/observiq-otel-collector/config.yamlWindows:
notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
修改配置文件
将
config.yaml的全部内容替换为以下配置:receivers: filelog: include: - /opt/IBM/WebSphere/AppServer/profiles/*/logs/*/SystemOut.log - /opt/IBM/WebSphere/AppServer/profiles/*/logs/*/SystemErr.log start_at: beginning exporters: chronicle/websphere: 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: IBM_WEBSPHERE_APP_SERVER raw_log_field: body ingestion_labels: env: production service: pipelines: logs/websphere_to_chronicle: receivers: - filelog exporters: - chronicle/websphere
配置参数
替换以下占位符:
接收器配置:
filelog:用于从磁盘收集日志文件的接收器类型include:要监控的文件路径列表。默认 WebSphere 日志位置:- Linux:
/opt/IBM/WebSphere/AppServer/profiles/<PROFILE>/logs/<SERVER>/SystemOut.log - Windows:
C:\IBM\WebSphere\AppServer\profiles\<PROFILE>\logs\<SERVER>\SystemOut.log
- Linux:
start_at:设置为beginning可读取现有日志,设置为end可仅读取新条目
导出器配置:
websphere:导出器的描述性名称creds_file_path:服务账号 JSON 密钥文件的完整路径(选项 1):- Linux:
/opt/observiq-otel-collector/ingestion-auth.json - Windows:
C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- Linux:
<customer_id>:上一步中的客户 IDlocation:将<LOCATION>替换为 Google SecOps 实例所在的区域(例如us、europe或asia-southeast1)。导出工具会在此值前面加上chronicle.googleapis.com。如需查看完整列表,请参阅区域级端点。project:将<PROJECT_NUMBER>替换为 IAM 和管理 > 设置中的项目编号。endpoint:保持设置为chronicle.googleapis.com。IBM_WEBSPHERE_APP_SERVER:日志类型,与 Chronicle 中显示的完全一致ingestion_labels:YAML 格式的可选标签(例如env: production)
流水线配置:
websphere_to_chronicle:流水线的描述性名称
旧版提取 API 导出工具
如果您使用选项 2 中的数据注入身份验证文件,请将
exporters代码块替换为以下内容。将creds_file_path设置为数据注入身份验证文件的路径,如果您的实例位于美国境外,请将malachiteingestion-pa.googleapis.com替换为您的区域端点(例如europe-malachiteingestion-pa.googleapis.com)。exporters: chronicle/websphere: compression: gzip creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json' customer_id: '<customer_id>' endpoint: malachiteingestion-pa.googleapis.com log_type: IBM_WEBSPHERE_APP_SERVER raw_log_field: body ingestion_labels: env: production
保存配置文件
- 修改后,保存文件:
- Linux:依次按
Ctrl+O、Enter和Ctrl+X - Windows:依次点击文件 > 保存
- Linux:依次按
重启 Bindplane 代理以应用更改
如需在 Linux 中重启 Bindplane 代理,请运行以下命令:
sudo systemctl restart observiq-otel-collector验证服务是否正在运行:
sudo systemctl status observiq-otel-collector检查日志中的错误:
sudo journalctl -u observiq-otel-collector -f
如需在 Windows 中重启 Bindplane 代理,请选择以下选项之一:
以管理员身份运行命令提示符或 PowerShell:
net stop observiq-otel-collector && net start observiq-otel-collector“服务”控制台:
- 按
Win+R,输入services.msc,然后按 Enter 键。 - 找到 observIQ OpenTelemetry 收集器。
- 右键点击并选择重启。
验证服务是否正在运行:
sc query observiq-otel-collector检查日志中的错误:
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
- 按
配置 IBM WebSphere Application Server 日志记录
- 登录 IBM WebSphere Application Server 管理控制台。
- 依次前往问题排查 > 日志和跟踪记录。
- 选择服务器(例如
server1)。 - 点击诊断跟踪以配置轨迹日志记录级别,或点击 JVM 日志以配置 SystemOut 和 SystemErr 日志设置。
- 在 JVM 日志下,验证以下设置:
- System.out 日志文件名:
${SERVER_LOG_ROOT}/SystemOut.log - System.err 日志文件名:
${SERVER_LOG_ROOT}/SystemErr.log - 日志文件轮替:配置日志轮替(例如,按文件大小或时间),以防止日志文件无限增长。
- System.out 日志文件名:
- 依次点击应用和保存,以保存配置。
- 确定 WebSphere 服务器上的日志目录。默认位置包括:
<WAS_HOME>/profiles/<PROFILE>/logs/<SERVER>/SystemOut.log<WAS_HOME>/profiles/<PROFILE>/logs/<SERVER>/SystemErr.log<WAS_HOME>/profiles/<PROFILE>/logs/<SERVER>/BinaryAudit*(安全审核日志,如果已启用审核)
确保
config.yaml中的 Bindplane 代理include路径与 WebSphere 服务器上的实际日志文件位置一致。
UDM 映射表
| 日志字段 | UDM 映射 | 逻辑 |
|---|---|---|
| number, MemCount, JMSMessageID | 其他 | 合并为每个字段的键值对 |
| TrgAction,说明 | metadata.description | TrgAction 中的值(如果不为空),否则为说明 |
| 时间 | metadata.event_timestamp | 使用日期过滤器进行解析,格式为 MM/dd/yy HH:mm:ss.SSS Z、M/dd/yy H:mm:ss.SSS Z、UNIX_MS |
| metadata.event_type | 设置为“GENERIC_EVENT” | |
| 操作 | metadata.product_event_type | 直接复制的值 |
| product_log_id | metadata.product_log_id | 直接复制的值 |
| 版本 | metadata.product_version | 直接复制的值 |
| 产品 | metadata.product_name | 直接复制的值 |
| vendor | metadata.vendor_name | 直接复制的值 |
| file_name | target.file.full_path | 直接复制的值 |
| 命令 | target.process.command_line | 直接复制的值 |
| filename | target.process.file.full_path | 直接复制的值 |
| 成员 | target.user.group_identifiers | 从已处理的 Members 数组合并 |
| 开斋节 | target.user.product_object_id | 直接复制的值 |
| 个人资料 | target.user.user_display_name | 直接复制的值 |
principal_user |
event.idm.read_only_udm.principal.user.userid |
从更新日志映射 |
exception_code |
event.idm.read_only_udm.security_result.detection_fields |
从更新日志映射 |
exception_class |
event.idm.read_only_udm.security_result.detection_fields |
从更新日志映射 |
source_line |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
length |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
websphere_java_version |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
websphere_platform_details |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
java_compiler |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
java_vm_name |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
parent_context |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
event_context |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
method_name |
event.idm.read_only_udm.additional.fields |
从更新日志映射 |
principal_application |
event.idm.read_only_udm.principal.application |
从更新日志映射 |
os_version |
event.idm.read_only_udm.principal.asset.platform_software.platform_version |
从更新日志映射 |
os_name |
event.idm.read_only_udm.principal.asset.platform_software.platform_patch_level |
从更新日志映射 |
process_name |
event.idm.read_only_udm.principal.resource.name |
从更新日志映射 |
full_orb_version |
event.idm.read_only_udm.security_result.detection_fields |
从更新日志映射 |
target_application |
event.idm.read_only_udm.target.application |
从更新日志映射 |