收集 Big Switch BigCloudFabric 日志

解析器版本: 2.0

支持平台:

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

Arista Networks Big Cloud Fabric (BCF)(现称为 Converged Cloud Fabric (CCF))是一种软件定义网络 (SDN) 解决方案,可通过集中式控制器提供自动数据中心网络管理。BCF/CCF 控制器管理叶脊网络架构,为企业数据中心网络提供集中式配置、监控和问题排查功能。此产品最初由 Big Switch Networks 开发,后被 Arista Networks 收购。

准备工作

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

  • Google SecOps 实例
  • Windows Server 2016 或更高版本,或者具有 systemd 的 Linux 主机
  • Bindplane 代理与 BCF/CCF 控制器之间的网络连接
  • 如果通过代理运行,请确保防火墙端口根据 Bindplane 代理要求处于打开状态
  • 通过 GUI 或 CLI 对 BCF/CCF 控制器的管理员权限
  • BCF/CCF 控制器版本 2.5 或更高版本(适用于 syslog 支持)

获取 Bindplane 代理的 Google SecOps 凭据

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

  • 新部署:使用 Chronicle API(方法 1)。
  • 旧版部署:继续使用注入身份验证文件(方法 2),直到注入 API 于 2027 年 7 月 20 日停用为止。
  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 收集器目录中的 ingestion-auth.json(在 Linux 上为 /opt/observiq-otel-collector/ingestion-auth.json,在 Windows 上为 C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json),或者更新 creds_file_path 在 config.yaml 中以与您保存该文件的路径匹配。
  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. 打开具有根权限或 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"
    

修改配置文件

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

    receivers:
      udplog:
        listen_address: "0.0.0.0:514"
    
    exporters:
      chronicle/bigswitch_bcf:
        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: 'YOUR_CUSTOMER_ID'
        endpoint: chronicle.googleapis.com
        log_type: BIGSWITCH_BCF
        raw_log_field: body
        ingestion_labels:
          env: production
          source: bcf_controller
    
    service:
      pipelines:
        logs/bcf_to_chronicle:
          receivers:
            - udplog
          exporters:
            - chronicle/bigswitch_bcf
    
  2. 替换以下占位符:

    • 接收器配置:

      • 接收器配置为监听 UDP 端口 514,以接收来自 BCF/CCF 控制器的 syslog 消息
      • 如需使用其他端口,请将 514 更改为所需的端口号(例如,对于无特权 Linux 安装,请使用 1514)
    • 导出器配置:

      • creds_file_path:服务帐号 JSON 密钥文件的完整路径(方法 1):

        • Linux: /opt/observiq-otel-collector/ingestion-auth.json
        • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
      • YOUR_CUSTOMER_ID:替换为您的 Customer ID。如需了解详情,请参阅获取 Google SecOps 客户 ID。

      • location:将 <LOCATION> 替换为 Google SecOps 实例的区域(例如,us、europe 或 asia-southeast1)。导出器会使用此值为 chronicle.googleapis.com 添加前缀。如需查看完整列表,请参阅区域级端点。

      • project:将 <PROJECT_NUMBER> 替换为 IAM 和管理 > 设置 中的项目编号。

      • endpoint:保持设置为 chronicle.googleapis.com。

      • log_type:设置为 BIGSWITCH_BCF(请勿更改)

      • ingestion_labels:用于对日志进行分类的可选标签(根据需要自定义)

旧版注入 API 导出器

  • 如果您使用方法 2 中的注入身份验证文件,请将 exporters 块替换为以下内容。将 creds_file_path 设置为注入身份验证文件的路径,如果您的实例位于美国境外,请将 malachiteingestion-pa.googleapis.com 替换为您的 区域级端点(例如,europe-malachiteingestion-pa.googleapis.com)。

    exporters:
      chronicle/bigswitch_bcf:
        compression: gzip
        creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: 'YOUR_CUSTOMER_ID'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: BIGSWITCH_BCF
        raw_log_field: body
        ingestion_labels:
          env: production
          source: bcf_controller
    

保存配置文件

修改后,请保存该文件:

  • Linux:按 Ctrl+O,然后按 Enter,再按 Ctrl+X
  • Windows:依次点击文件 > 保存

重启 Bindplane 代理以应用更改

  • 如需在 Linux 中重启 Bindplane 代理,请执行以下操作:

    1. 运行以下命令:

      sudo systemctl restart observiq-otel-collector
      
    2. 验证服务是否正在运行:

      sudo systemctl status observiq-otel-collector
      
    3. 检查日志中是否存在错误:

      sudo journalctl -u observiq-otel-collector -f
      
  • 如需在 Windows 中重启 Bindplane 代理,请执行以下操作:

    1. 请从下列选项中选择一项:

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

        net stop observiq-otel-collector && net start observiq-otel-collector
        
      • 服务控制台:

        1. 按 Win+R,输入 services.msc,然后按 Enter 键。
        2. 找到 observIQ OpenTelemetry Collector 。
        3. 右键点击并选择重启 。
    2. 验证服务是否正在运行:

      sc query observiq-otel-collector
      
    3. 检查日志中是否存在错误:

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

配置 Big Switch BigCloudFabric syslog 转发

配置 BCF/CCF 控制器,以使用 GUI 或 CLI 方法将 syslog 消息转发到 Bindplane 代理。

方法 1:使用 GUI 配置 syslog

  1. 使用管理员凭据登录 BCF/CCF 控制器网页界面。
  2. 依次前往维护 > 日志记录。
  3. 点击远程日志记录 标签页。
  4. 点击添加 以创建新的远程 syslog 服务器配置。
  5. 提供以下配置详细信息:
    • 服务器:输入 Bindplane 代理主机(例如 192.168.1.100)的 IP 地址。
    • 端口:输入 514(或在 Bindplane 代理 config.yaml 中配置的端口)。
    • 协议:选择 UDP。
  6. 点击保存 或应用 以保存配置。
  7. 验证配置是否显示在“远程日志记录”列表中。

方法 2:使用 CLI 配置 syslog

  1. 使用管理员凭据通过 SSH 连接到 BCF/CCF 控制器。
  2. 进入启用模式:

    controller-1> enable
    
  3. 进入配置模式:

    controller-1# configure
    
  4. 配置远程 syslog 服务器:

    controller-1(config)# logging remote 192.168.1.100
    

    将 192.168.1.100 替换为 Bindplane 代理主机的 IP 地址。

  5. 退出配置模式:

    controller-1(config)# exit
    
  6. 验证 syslog 配置:

    controller-1# show logging
    

    输出应显示配置的远程 syslog 服务器 IP 地址。

验证日志转发

  1. 通过执行配置更改或查看系统状态,在 BCF/CCF 控制器上生成测试日志事件。
  2. 检查 Bindplane 代理日志,验证是否收到了 syslog 消息:

    • Linux:

      sudo journalctl -u observiq-otel-collector -f
      
    • Windows:

      type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
      
  3. 登录 Google SecOps 控制台,验证日志是否显示在搜索 界面中,并带有注入标签 BIGSWITCH_BCF。

UDM 映射表

日志字段 UDM 映射 逻辑
description metadata.description 直接复制值,并移除开头和结尾的空格
target_host、time、product_event_type、description、application metadata.event_type 如果 target_host 和 time 不为空,则设置为 STATUS_HEARTBEAT;如果 product_event_type == PORT_DOWN,则设置为 SERVICE_STOP;如果 description 与“.Running job.”匹配,或者 product_event_type == PORT_UP 或 application == snmpd-execstart,则设置为 SERVICE_START;如果 description 与“.status down.”匹配,则设置为 STATUS_SHUTDOWN;如果 product_event_type == Removing Endpoint,则设置为 SERVICE_DELETION;如果 product_event_type == Adding Endpoint,则设置为 SERVICE_CREATION;如果 product_event_type == Moving Endpoint 或 description 与“.change instances.”匹配,则设置为 SERVICE_MODIFICATION;如果 target_host 不为空,则设置为 NETWORK_CONNECTION;否则设置为 GENERIC_EVENT
product_event_type metadata.product_event_type 直接复制值
application_protocol network.application_protocol 如果 application_protocol == "lldpa",则设置为 "UNKNOWN_APPLICATION_PROTOCOL"
host principal.hostname 直接复制值
ip principal.ip 直接复制值
process_id principal.process.pid 直接复制值
USER principal.user.userid 直接复制值
log_level security_result 如果 INFO,则将严重级别设置为 INFORMATIONAL 的对象;如果 WARN,则将严重级别设置为 MEDIUM 的对象;如果 ERROR,则将严重级别设置为 HIGH 的对象;如果 INFO 或 WARN,则将操作设置为 ALLOW;如果 ERROR,则将操作设置为 BLOCK
application target.application 直接复制值
target_host target.hostname 直接复制值
port target.port 转换为整数
COMMAND target.process.command_line 直接复制值
product_specific_id target.process.product_specific_process_id 带有“Bigswitch:”前缀
kv_1、kv2、kv3 target.user.group_identifiers 如果 kv_1 不为空,则从 kv_1 合并;如果 kv2 不为空,则从 kv2 合并;如果 kv3 不为空,则从 kv3 合并
metadata.product_name 设置为“Big Cloud Fabric”
metadata.vendor_name 设置为“Big Switch”

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