收集 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 之間的網路連線
  • 如果是在 Proxy 後方執行，請確認防火牆通訊埠已按照 Bindplane 代理程式規定開啟
  • IBM WebSphere 應用程式伺服器的管理員權限

取得 Bindplane 代理程式的 Google SecOps 憑證

如要向 Google SecOps 驗證 Bindplane 代理程式，請選擇下列其中一種方法：

  • 新部署作業：使用 Chronicle API (選項 1)。
  • 舊版部署作業：繼續使用擷取驗證檔案 (選項 2)，直到 Ingestion API 於 2027 年 7 月 20 日停用。
  1. 登入 Google Cloud 控制台，選取連結至 Google SecOps 執行個體的 Google Cloud 專案。
  2. 依序前往 「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
  3. 按一下「建立服務帳戶」。
  4. 提供下列設定詳細資料：
    • 服務帳戶名稱：輸入帳戶名稱 (例如 bindplane-ingest)。
    • 服務帳戶說明：輸入說明 (例如 Bindplane agent log ingestion)。
  5. 點按「Create and continue」(建立並繼續)。
  6. 在「將專案存取權授予這個服務帳戶」部分，按一下「選取角色」，然後選取「Chronicle 編輯者」。
  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)，或更新 config.yaml 中的 creds_file_path，使其與儲存檔案的路徑相符。
  12. 依序前往「IAM 與管理」>「設定」，然後複製「專案編號」。設定匯出工具時會用到。

方法 2：下載擷取驗證檔案 (舊版)

  1. 登入 Google SecOps 控制台。
  2. 依序前往「SIEM Settings」 > 「Collection Agents」。
  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 代理程式，擷取記錄並傳送至 Google SecOps

找出設定檔

  • Linux：

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

  • Windows：

    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
    • 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
    • <customer_id>：上一步中的客戶 ID
    • location：將 <LOCATION> 替換為 Google SecOps 執行個體的區域 (例如 us、europe 或 asia-southeast1)。匯出工具會在這個值前面加上 chronicle.googleapis.com。如需完整清單，請參閱「區域性端點」。
    • project：依序前往「IAM 與管理」>「設定」，然後將 <PROJECT_NUMBER> 替換為專案編號。
    • endpoint：請將此值設為 chronicle.googleapis.com。
    • IBM_WEBSPHERE_APP_SERVER：記錄類型，與 Chronicle 中顯示的完全相同
    • ingestion_labels：YAML 格式的選用標籤 (例如 env: production)

  • 管道設定：

    • websphere_to_chronicle：管道的說明名稱

舊版 Ingestion 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：依序點選「檔案」>「儲存」

重新啟動 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 Collector」。
      3. 按一下滑鼠右鍵，然後選取「重新啟動」。

      4. 確認服務是否正在執行：

        sc query observiq-otel-collector

      5. 查看記錄檔是否有錯誤：

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

設定 IBM WebSphere Application Server 記錄

  1. 登入 IBM WebSphere Application Server 管理控制台。
  2. 依序前往「疑難排解」>「記錄和追蹤」。
  3. 選取伺服器 (例如 server1)。
  4. 按一下「Diagnostic Trace」，設定追蹤記錄層級，或按一下「JVM Logs」，設定 SystemOut 和 SystemErr 記錄。
  5. 在「JVM Logs」(JVM 記錄) 下方，確認下列設定：
    • System.out 記錄檔名稱：${SERVER_LOG_ROOT}/SystemOut.log
    • System.err 記錄檔名稱：${SERVER_LOG_ROOT}/SystemErr.log
    • 記錄檔輪替：設定記錄輪替 (例如依檔案大小或時間)，避免記錄檔無限增加。
  6. 依序點選「套用」和「儲存」，儲存設定。
  7. 找出 WebSphere 伺服器上的記錄目錄。預設位置包括：
    • <WAS_HOME>/profiles/<PROFILE>/logs/<SERVER>/SystemOut.log
    • <WAS_HOME>/profiles/<PROFILE>/logs/<SERVER>/SystemErr.log
    • <WAS_HOME>/profiles/<PROFILE>/logs/<SERVER>/BinaryAudit* (安全性稽核記錄，如果已啟用稽核功能)

  8. 確認 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 陣列合併
Eid 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 從變更記錄對應

變更記錄

查看這個剖析器的變更記錄

還有其他問題嗎？向社群成員和 Google SecOps 專家尋求解答。