收集 Commvault 日志

解析器版本：3.0

本文档介绍了如何使用 Bindplane 代理将 Commvault 日志注入到 Google Security Operations。

Commvault 会针对备份操作、提醒、事件和系统活动生成 syslog 消息。解析器会从日志消息中提取字段，并将其映射到统一数据模型 (UDM)。

准备工作

请确保满足以下前提条件：

• Google SecOps 实例
• Windows Server 2016 或更高版本，或者具有 systemd 的 Linux 主机
• Bindplane 代理与 Commvault 系统之间的网络连接
• 如果在代理后面运行，请确保按照 Bindplane 代理要求打开防火墙端口
• 对 Commvault 管理控制台的特权访问权限

获取 Bindplane 代理的 Google SecOps 凭证

如需向 Google SecOps 验证 Bindplane 代理的身份，请选择以下方法之一：

• 新部署：使用 Chronicle API（选项 1）。
• 旧版部署：继续使用提取身份验证文件（方法 2），直到提取 API 于 2027 年 7 月 20 日停用。

方法 1：为 Chronicle API 创建服务账号（推荐）

1. 登录 Google Cloud 控制台，然后选择与您的 Google SecOps 实例关联的 Google Cloud 项目。
2. 前往 IAM 和管理 > 服务账号。
3. 点击创建服务账号。
4. 提供以下配置详细信息：
   • 服务账号名称：输入账号的名称（例如 bindplane-ingest）。
   • 服务账号说明：输入说明（例如 Bindplane agent log ingestion）。
5. 点击创建并继续。
6. 在向此服务账号授予对项目的访问权限部分，点击选择角色，然后选择 Chronicle Editor。
7. 点击继续，然后点击完成。
8. 点击您创建的服务账号，然后前往密钥标签页。
9. 依次点击添加密钥 > 创建新密钥。
10. 选择 JSON，然后点击创建。密钥文件会下载到您的计算机上。
11. 将密钥文件另存为 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 以匹配您保存该文件的路径。
12. 前往 IAM 和管理 > 设置，然后复制项目编号。您需要此信息才能配置导出器。

方法 2：下载数据注入身份验证文件（旧版）

1. 登录 Google SecOps 控制台。
2. 依次前往 SIEM 设置 > 收集代理。
3. 下载数据注入身份验证文件。
4. 将文件安全地保存在将安装 Bindplane 代理的系统上。

获取 Google SecOps 客户 ID

1. 登录 Google SecOps 控制台。
2. 前往 SIEM 设置 > 个人资料。

3. 复制并保存组织详细信息部分中的客户 ID。

安装 Bindplane 代理

根据以下说明，在 Windows 或 Linux 操作系统上安装 Bindplane 代理。

Windows 安装

1. 以管理员身份打开命令提示符或 PowerShell。

2. 运行以下命令：

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

3. 等待安装完成。

4. 运行以下命令，验证安装是否成功：

   sc query observiq-otel-collector
   

   该服务应显示为 RUNNING。

Linux 安装

1. 打开具有 root 或 sudo 权限的终端。

2. 运行以下命令：

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

3. 等待安装完成。

4. 运行以下命令，验证安装是否成功：

   sudo systemctl status observiq-otel-collector
   

   该服务应显示为 active (running)。

其他安装资源

如需了解其他安装选项和问题排查信息，请参阅 Bindplane 代理安装指南。

配置 Bindplane 代理以注入 syslog 并将其发送到 Google SecOps

找到配置文件

• Linux：

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

• Windows：

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

修改配置文件

• 将 config.yaml 的全部内容替换为以下配置：

  receivers:
    udplog:
      listen_address: "0.0.0.0:514"
  
  exporters:
    chronicle/commvault:
      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: COMMVAULT
      raw_log_field: body
  
  service:
    pipelines:
      logs/commvault_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/commvault
  

配置参数

替换以下占位符：

• 接收器配置：

  • listen_address：要监听的 IP 地址和端口：
    • 0.0.0.0，以监听所有接口（推荐）
    • 端口 514 是标准 syslog 端口（在 Linux 上需要 root 权限；对于非 root 用户，请使用 1514）

• 导出器配置：

  • creds_file_path：服务账号 JSON 密钥文件的完整路径（选项 1）：
    • Linux：/opt/observiq-otel-collector/ingestion-auth.json
    • Windows：C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • customer_id：从 Google SecOps 控制台复制的客户 ID
  • location：将 <LOCATION> 替换为 Google SecOps 实例所在的区域（例如 us、europe 或 asia-southeast1）。导出工具会在此值前面加上 chronicle.googleapis.com。如需查看完整列表，请参阅区域级端点。
  • project：将 <PROJECT_NUMBER> 替换为 IAM 和管理 > 设置中的项目编号。
  • endpoint：保持设置为 chronicle.googleapis.com。

旧版提取 API 导出工具

• 如果您使用选项 2 中的提取身份验证文件，请将 exporters 代码块替换为以下内容。将 creds_file_path 设置为数据注入身份验证文件的路径，如果您的实例位于美国境外，请将 malachiteingestion-pa.googleapis.com 替换为您的区域端点（例如 europe-malachiteingestion-pa.googleapis.com）。

  exporters:
    chronicle/commvault:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: COMMVAULT
      raw_log_field: body
  

保存配置文件

• 修改后，保存文件：
  • Linux：依次按 Ctrl+O、Enter 和 Ctrl+X
  • Windows：依次点击文件 > 保存

重启 Bindplane 代理以应用更改

• 如需在 Linux 中重启 Bindplane 代理，请运行以下命令：

  sudo systemctl restart observiq-otel-collector
  

  1. 验证服务是否正在运行：

     sudo systemctl status observiq-otel-collector
     

  2. 检查日志中的错误：

     sudo journalctl -u observiq-otel-collector -f
     

• 如需在 Windows 中重启 Bindplane 代理，请选择以下选项之一：

  • 以管理员身份运行命令提示符或 PowerShell：

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

  • “服务”控制台：

    1. 按 Win+R，输入 services.msc，然后按 Enter 键。
    2. 找到 observIQ OpenTelemetry 收集器。
    3. 右键点击并选择重启。

    4. 验证服务是否正在运行：

       sc query observiq-otel-collector
       

    5. 检查日志中的错误：

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

在 Commvault Cloud 中配置 syslog

1. 登录 Commvault 管理控制台。
2. 依次前往管理 > 系统。
3. 点击 SIEM 连接器卡片。
4. 点击添加连接器。
5. 在常规标签页上，输入以下详细信息：
   • 连接器名称：输入连接器的名称。
   • 连接器类型：选择 Syslog。
   • 流式数据：选择要导出的数据。
6. 点击下一步。
7. 在连接器定义标签页上，点击添加 Syslog 服务器。
8. 提供以下配置详细信息：
   • Syslog 服务器：输入 Bindplane 代理 IP 地址。
   • 端口号：输入 Bindplane 代理端口号。

9. 点击提交。

UDM 映射表

日志字段	UDM 映射	逻辑
AgentType	event.idm.read_only_udm.observer.application	值取自日志消息中的 AgentType 字段。
Alertid	event.idm.read_only_udm.security_result.detection_fields.value	从日志消息的 Alertid 字段中获取的值。此字段映射到 alert_id 键下。
Alertname	event.idm.read_only_udm.security_result.detection_fields.value	从日志消息的 Alertname 字段中获取的值。此字段映射到 alert_name 键下。
alertseverity	event.idm.read_only_udm.security_result.severity	此字段用于根据其值填充 security_result.severity 字段。
Alerttime	event.idm.read_only_udm.metadata.event_timestamp	从日志消息中的 Alerttime 字段获取并转换为时间戳的值。
BackupLevel	event.idm.read_only_udm.additional.fields.value.string_value	值取自日志消息中的 BackupLevel 字段。此字段映射到 backup_level 键下。
BackupSet	event.idm.read_only_udm.additional.fields.value.string_value	值取自日志消息中的 BackupSet 字段。此字段映射到 backup_set 键下。
客户	event.idm.read_only_udm.principal.hostname	值取自日志消息中的 Client 字段。
CommCell	event.idm.read_only_udm.additional.fields.value.string_value	从日志消息的 CommCell 字段中获取的值。此字段映射到 comcell_field 键下。
计算机	event.idm.read_only_udm.additional.fields.value.string_value	从日志消息的 Computer 字段中获取的值。此字段映射到 computer_field 键下。
说明	event.idm.read_only_udm.metadata.description	经过一些处理和清理后，从日志消息中的 Description 字段获取的值。
DetectedCriteria	event.idm.read_only_udm.security_result.detection_fields.value	值取自日志消息中的 DetectedCriteria 字段。此字段映射到 detected_criteria 键下。
DetectedTime	event.idm.read_only_udm.security_result.detection_fields.value	值取自日志消息中的 DetectedTime 字段。此字段映射到 detected_time 键下。
详细信息	event.idm.read_only_udm.additional.fields.value.string_value	从日志消息的 Details 字段中获取的值。此字段映射到 details_field 键下。
Eventid	event.idm.read_only_udm.metadata.product_log_id	值取自日志消息中的 Eventid 字段。
Eventseverity	event.idm.read_only_udm.security_result.severity	此字段用于根据其值填充 security_result.severity 字段。
失败	event.idm.read_only_udm.security_result.detection_fields.value	值取自日志消息中的 Failure 字段。此字段映射到 failure_filed 键下。
实例	event.idm.read_only_udm.additional.fields.value.string_value	值取自日志消息中的 Instance 字段。此字段映射到 instance_field 键下。
Jobid	event.idm.read_only_udm.principal.process.pid	值取自日志消息中的 Jobid 字段。
MonitoringCriteria	event.idm.read_only_udm.additional.fields.value.string_value	值取自日志消息中的 MonitoringCriteria 字段。此字段映射到 monitoring_criteria 键下。
Occurencetime	event.idm.read_only_udm.metadata.event_timestamp	从日志消息中的 Occurencetime 字段获取并转换为时间戳的值。
Opid	event.idm.read_only_udm.security_result.detection_fields.value	值取自日志消息中的 Opid 字段。此字段映射到 op_id 键下。
计划	event.idm.read_only_udm.principal.application	值取自日志消息中的 Program 字段。
Severitylevel	event.idm.read_only_udm.security_result.severity	值取自日志消息中的 Severitylevel 字段，并根据预定义映射进行映射。
StoragePoliciesUsed	event.idm.read_only_udm.additional.fields.value.string_value	值取自日志消息中的 StoragePoliciesUsed 字段。此字段映射到 storage_policies_used 键下。
子客户	event.idm.read_only_udm.additional.fields.value.string_value	值取自日志消息中的 Subclient 字段。此字段映射到 subclient_field 键下。
类型	event.idm.read_only_udm.security_result.detection_fields.value	值取自日志消息中的 Type 字段。此字段映射到 alert_type 键下。
用户名	event.idm.read_only_udm.principal.user.userid	从日志消息的 Username 字段中获取的值。
anomaly_type	event.idm.read_only_udm.security_result.detection_fields.value	使用 grok 模式从 Description 字段中提取的值。此字段映射到 detected_anomaly_type 键下。
错误	event.idm.read_only_udm.security_result.detection_fields.value	使用 grok 模式从 Description 字段中提取的值。此字段映射到 errors_field 键下。
file_name	event.idm.read_only_udm.security_result.detection_fields.value	使用 grok 模式从 Description 字段中提取的值。此字段映射到 detected_malicious_file 键下。
media_agent	event.idm.read_only_udm.security_result.detection_fields.value	使用 grok 模式从 Description 字段中提取的值。此字段映射到 detected_media_agent 键下。
no_of_files_created	event.idm.read_only_udm.security_result.detection_fields.value	使用 grok 模式从 Description 字段中提取的值。此字段映射到 no_of_files_created_field 键下。
no_of_files_deleted	event.idm.read_only_udm.security_result.detection_fields.value	使用 grok 模式从 Description 字段中提取的值。此字段映射到 no_of_files_deleted_field 键下。
no_of_files_modified	event.idm.read_only_udm.security_result.detection_fields.value	使用 grok 模式从 Description 字段中提取的值。此字段映射到 no_of_files_modified_field 键下。
no_of_files_renamed	event.idm.read_only_udm.security_result.detection_fields.value	使用 grok 模式从 Description 字段中提取的值。此字段映射到 no_of_files_renamed_field 键下。
网址	event.idm.read_only_udm.network.http.referral_url	使用 grok 模式从 Description 字段中提取的值。
	event.idm.read_only_udm.metadata.event_type	如果存在 Client 字段，则此字段设置为 STATUS_UPDATE，否则设置为 GENERIC_EVENT。
	event.idm.read_only_udm.metadata.product_name	此字段设置为 COMMVAULT。
	event.idm.read_only_udm.metadata.vendor_name	此字段设置为 COMMVAULT。
	event.idm.read_only_udm.principal.user.user_role	如果 User 字段为 Administrator，则此字段设置为 ADMINISTRATOR。
Commcellname	additional.fields	从更新日志映射
Operation	metadata.description	从更新日志映射
Companyname	principal.user.company_name	从更新日志映射
machine_name	principal.hostname	从更新日志映射
locale	additional.fields	从更新日志映射

更新日志

查看此解析器的更新日志

需要更多帮助？获得社区成员和 Google SecOps 专业人士的解答。