找出 config.yaml 檔案。通常位於 Linux 的 /etc/bindplane-agent/ 目錄,或 Windows 的安裝目錄。
使用文字編輯器 (例如 nano、vi 或記事本) 開啟檔案。
按照下列方式編輯 config.yaml 檔案:
receivers:udplog:# Replace the port and IP address as requiredlisten_address:"0.0.0.0:514"exporters:chronicle/chronicle_w_labels:compression:gzip# Adjust the path to the credentials file you downloaded in Step 1creds_file_path:'/path/to/ingestion-authentication-file.json'# Replace with your actual customer ID from Step 2customer_id:<customer_id>
endpoint:malachiteingestion-pa.googleapis.com# Add optional ingestion labels for better organizationingestion_labels:log_type:'OPENAM'raw_log_field:bodyservice:pipelines:logs/source0__chronicle_w_labels-0:receivers:-udplogexporters:-chronicle/chronicle_w_labels
[[["容易理解","easyToUnderstand","thumb-up"],["確實解決了我的問題","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["難以理解","hardToUnderstand","thumb-down"],["資訊或程式碼範例有誤","incorrectInformationOrSampleCode","thumb-down"],["缺少我需要的資訊/範例","missingTheInformationSamplesINeed","thumb-down"],["翻譯問題","translationIssue","thumb-down"],["其他","otherDown","thumb-down"]],["上次更新時間:2025-09-04 (世界標準時間)。"],[],[],null,["# Collect ForgeRock OpenAM logs\n=============================\n\nSupported in: \nGoogle secops [SIEM](/chronicle/docs/secops/google-secops-siem-toc)\n| **Note:** This feature is covered by [Pre-GA Offerings Terms](https://chronicle.security/legal/service-terms/) of the Google Security Operations Service Specific Terms. Pre-GA features might have limited support, and changes to pre-GA features might not be compatible with other pre-GA versions. For more information, see the [Google SecOps Technical Support Service guidelines](https://chronicle.security/legal/technical-support-services-guidelines/) and the [Google SecOps Service Specific Terms](https://chronicle.security/legal/service-terms/).\n\nThis document explains how to ingest ForgeRock OpenAM logs to\nGoogle Security Operations using Bindplane. The parser extracts fields from the logs\nin CSV, Syslog + KV, or JSON formats, normalizes them, and maps them to the\nUnified Data Model (UDM). It handles various OpenAM event types, including\nlogin/logout, access outcomes, and general logs, enriching the data with user,\ngroup, and network information while also performing specific transformations\nfor different log formats and event types. The parser prioritizes JSON parsing,\nthen falls back to Syslog+KV, and finally CSV, dropping logs of unsupported\nformats.\n\nBefore you begin\n----------------\n\nMake sure you have the following prerequisites:\n\n- Google SecOps instance\n- Windows 2016 or later, or a Linux host with `systemd`\n- If running behind a proxy, firewall [ports](/chronicle/docs/ingestion/use-bindplane-agent#verify_the_firewall_configuration) are open\n- Privileged access to Forgerock OpenAM (for example, amAdmin)\n\nGet Google SecOps ingestion authentication file\n-----------------------------------------------\n\n1. Sign in to the Google SecOps console.\n2. Go to **SIEM Settings \\\u003e Collection Agents**.\n3. Download the **Ingestion Authentication File**. Save the file securely on the system where Bindplane will be installed.\n\nGet Google SecOps customer ID\n-----------------------------\n\n1. Sign in to the Google SecOps console.\n2. Go to **SIEM Settings \\\u003e Profile**.\n3. Copy and save the **Customer ID** from the **Organization Details** section.\n\nInstall the Bindplane agent\n---------------------------\n\nInstall the Bindplane agent on your Windows or Linux operating system according\nto the following instructions.\n\n### Windows installation\n\n1. Open the **Command Prompt** or **PowerShell** as an administrator.\n2. Run the following command:\n\n msiexec /i \"https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi\" /quiet\n\n### Linux installation\n\n1. Open a terminal with root or sudo privileges.\n2. Run the following command:\n\n sudo sh -c \"$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)\" install_unix.sh\n\n### Additional installation resources\n\nFor additional installation options, consult the [installation guide](/chronicle/docs/ingestion/use-bindplane-agent#install_the_bindplane_agent).\n\nConfigure the Bindplane agent to ingest Syslog and send to Google SecOps\n------------------------------------------------------------------------\n\n1. Access the configuration file:\n - Locate the `config.yaml` file. Typically, it's in the `/etc/bindplane-agent/` directory on Linux or in the installation directory on Windows.\n - Open the file using a text editor (for example, `nano`, `vi`, or Notepad).\n2. Edit the `config.yaml` file as follows:\n\n receivers:\n udplog:\n # Replace the port and IP address as required\n listen_address: \"0.0.0.0:514\"\n\n exporters:\n chronicle/chronicle_w_labels:\n compression: gzip\n # Adjust the path to the credentials file you downloaded in Step 1\n creds_file_path: '/path/to/ingestion-authentication-file.json'\n # Replace with your actual customer ID from Step 2\n customer_id: \u003ccustomer_id\u003e\n endpoint: malachiteingestion-pa.googleapis.com\n # Add optional ingestion labels for better organization\n ingestion_labels:\n log_type: 'OPENAM'\n raw_log_field: body\n\n service:\n pipelines:\n logs/source0__chronicle_w_labels-0:\n receivers:\n - udplog\n exporters:\n - chronicle/chronicle_w_labels\n\n3. Replace the port and IP address as required in your infrastructure.\n\n4. Replace `\u003ccustomer_id\u003e` with the actual customer ID.\n\n5. Update `/path/to/ingestion-authentication-file.json` to the path where the authentication file was saved in the [Get Google SecOps ingestion authentication file](/chronicle/docs/ingestion/default-parsers/forgerock-openam#get-auth-file) section.\n\nRestart the Bindplane agent to apply the changes\n------------------------------------------------\n\n- To restart the Bindplane agent in Linux, run the following command:\n\n sudo systemctl restart bindplane-agent\n\n- To restart the Bindplane agent in Windows, you can either use the **Services**\n console or enter the following command:\n\n net stop BindPlaneAgent && net start BindPlaneAgent\n\nConfigure Audit Logging in Forgerock OpenAM\n-------------------------------------------\n\n1. Sign in to the **AM** console.\n2. Go to **Configure \\\u003e Global Services \\\u003e Audit Logging**.\n3. **Activate** Audit logging to start the audit logging feature.\n4. In the Field allowlist filters and Field blocklist filters lists, enter values to include (allowlist) or exclude (blocklist) from the audit event logs.\n5. Click **Save**.\n\nConfigure Syslog Handlers for Forgerock OpenAM\n----------------------------------------------\n\n1. Sign in to the AM console as an administrator, for example **amAdmin**.\n2. To create the event handler in the **global configuration** , go to **Configure \\\u003e Global Services \\\u003e Audit Logging**.\n3. To create the event handler in a **realm** , go to **Realms \\\u003e Realm Name \\\u003e Services \\\u003e Audit Logging**.\n4. Click **Add a Secondary Configuration \\\u003e Syslog**.\n5. Provide the following configuration details:\n - **Name** : Enter a name for the event handler (for example, Google SecOps `Syslog Event Handler`).\n - **Server hostname**: Enter the Bindplane agent IP address.\n - **Server port** : Enter the Bindplane agent port number (for example, `514` for UDP).\n - **Transport Protocol** : Select **UDP**.\n - **Connection timeout** : Enter the number of seconds to connect (for example, `120`).\n - Optional: Enable the **Buffering** option.\n6. Click **Create**.\n7. After the syslog audit event handler is created, several configuration tabs appear.\n8. On the **General Handler Configuration** tab, select **Enabled** to activate the event handler, if disabled.\n9. Select the topics for audit logs:\n - Access\n - Activity\n - Authentication\n - Configuration\n10. Click **Save**.\n11. On the **Syslog Configuration** tab, provide the following configuration details:\n - Server hostname: Enter the Bindplane agent IP address.\n - Server port: Enter the Bindplane agent port number.\n - **Connection timeout** : Enter the number of seconds to connect (for example, `120`).\n - Transport Protocol: Select **UDP**.\n - Facility: Select **Local0**.\n - All topics set the severity to **INFORMATIONAL**.\n12. Click **Save**.\n13. On the **Buffering** tab, select **Buffering Enabled** to activate it.\n\n | **Note:** When buffering is enabled, all audit events that get generated are formatted as syslog messages and put into a queue. A dedicated thread constantly pulls events from the queue in batches and transmits them to the syslog server. If the queue becomes empty, the dedicated thread goes to sleep until a new item gets added. The default queue size is 5000.\n14. Click **Save**.\n\nUDM mapping table\n-----------------\n\n**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/google-security-operations-2)"]]