This document explains how to ingest Cloudian HyperStore logs to Google Security Operations using Bindplane. The parser first uses a series of grok patterns to extract relevant fields like timestamps, IP addresses, user names, and descriptions from the SYSLOG messages. Then, it maps those extracted fields to the corresponding fields in the unified data model (UDM) and sets the appropriate event type based on the identified activity.
Before you begin
Make sure you have the following prerequisites:
Google SecOps instance
Windows 2016 or later or a Linux host with systemd
If running behind a proxy, ensure firewall ports are open
Privileged access to the Cloudian HyperStore
Get Google SecOps ingestion authentication file
Sign in to the Google SecOps console.
Go to SIEM Settings > Collection Agents.
Download the Ingestion Authentication File. Save the file securely on the
system where Bindplane will be installed.
Get Google SecOps customer ID
Sign in to the Google SecOps console.
Go to SIEM Settings > Profile.
Copy and save the Customer ID from the Organization Details section.
Install the Bindplane agent
Install the Bindplane agent on your Windows or Linux operating system according
to the following instructions.
Windows installation
Open the Command Prompt or PowerShell as an administrator.
Configure the Bindplane agent to ingest Syslog and send to Google SecOps
Access the configuration file:
Locate the config.yaml file. Typically, it's in the /etc/bindplane-agent/
directory on Linux or in the installation directory on Windows.
Open the file using a text editor (for example, nano, vi, or Notepad).
Edit the config.yaml file as follows:
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 organizationlog_type:'CLOUDIAN_HYPERSTORE'raw_log_field:bodyingestion_labels:service:pipelines:logs/source0__chronicle_w_labels-0:receivers:-udplogexporters:-chronicle/chronicle_w_labels
Replace the port and IP address as required in your infrastructure.
Replace <customer_id> with the actual customer ID.
To restart the Bindplane agent in Linux, run the following command:
sudosystemctlrestartbindplane-agent
To restart the Bindplane agent in Windows, you can either use the
Services console or enter the following command:
net stop BindPlaneAgent && net start BindPlaneAgent
Configure Cloudian Hyperstore Syslog
Sign in to your HyperStore Config Controller node using CLI.
Run the following hsctl commands:
# hsctl config set logging.syslog.remote.enabled=true# hsctl config set logging.syslog.remote.host=<Bindplane Agent IP Address># hsctl config set logging.syslog.remote.protocol=<UDP or TCP protocol># hsctl config set logging.syslog.remote.port=<Bindplane Agent port number># hsctl config apply ALL# hsctl service restart s3 iam hyperstore firewall --nodes=ALL# hsctl config set monitoring.agent.logging.level=INFO# hsctl config apply monitoring
Replace the following:
<Bindplane Agent IP Address> with your actual Bindplane agent IP Address.
<UDP or TCP protocol> with the protocol configured in the Bindplane agent.
<Bindplane Agent port number> with your actual Bindplane agent port number.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[],[],null,["# Collect Cloudian HyperStore 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 Cloudian HyperStore logs to Google Security Operations using Bindplane. The parser first uses a series of `grok` patterns to extract relevant fields like timestamps, IP addresses, user names, and descriptions from the SYSLOG messages. Then, it maps those extracted fields to the corresponding fields in the unified data model (UDM) and sets the appropriate event type based on the identified activity.\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, ensure firewall [ports](/chronicle/docs/ingestion/use-bindplane-agent#verify_the_firewall_configuration) are open\n- Privileged access to the Cloudian HyperStore\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 log_type: 'CLOUDIAN_HYPERSTORE'\n raw_log_field: body\n ingestion_labels:\n\n service:\n pipelines:\n logs/source0__chronicle_w_labels-0:\n receivers:\n - udplog\n exporters:\n - chronicle/chronicle_w_labels\n\n - Replace the port and IP address as required in your infrastructure.\n - Replace `\u003ccustomer_id\u003e` with the actual customer ID.\n - 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/cloudian-hs#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\n **Services** console or enter the following command:\n\n net stop BindPlaneAgent && net start BindPlaneAgent\n\nConfigure Cloudian Hyperstore Syslog\n------------------------------------\n\n1. Sign in to your HyperStore Config Controller node using CLI.\n2. Run the following hsctl commands:\n\n # hsctl config set logging.syslog.remote.enabled=true\n # hsctl config set logging.syslog.remote.host=\u003cBindplane Agent IP Address\u003e\n # hsctl config set logging.syslog.remote.protocol=\u003cUDP or TCP protocol\u003e\n # hsctl config set logging.syslog.remote.port=\u003cBindplane Agent port number\u003e\n # hsctl config apply ALL\n # hsctl service restart s3 iam hyperstore firewall --nodes=ALL\n # hsctl config set monitoring.agent.logging.level=INFO\n # hsctl config apply monitoring\n\n3. Replace the following:\n\n - `\u003cBindplane Agent IP Address\u003e` with your actual Bindplane agent IP Address.\n - `\u003cUDP or TCP protocol\u003e` with the protocol configured in the Bindplane agent.\n - `\u003cBindplane Agent port number\u003e` with your actual Bindplane agent port number.\n\n**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/google-security-operations-2)"]]
