Collect Cloudian HyperStore logs
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.
Run the following command:
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
Linux installation
- Open a terminal with root or sudo privileges.
Run the following command:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
Additional installation resources
For additional installation options, consult the installation guide.
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).
- Locate the
Edit the
config.yaml
file as follows:receivers: udplog: # Replace the port and IP address as required listen_address: "0.0.0.0:514" exporters: chronicle/chronicle_w_labels: compression: gzip # Adjust the path to the credentials file you downloaded in Step 1 creds_file_path: '/path/to/ingestion-authentication-file.json' # Replace with your actual customer ID from Step 2 customer_id: <customer_id> endpoint: malachiteingestion-pa.googleapis.com # Add optional ingestion labels for better organization log_type: 'CLOUDIAN_HYPERSTORE' raw_log_field: body ingestion_labels: service: pipelines: logs/source0__chronicle_w_labels-0: receivers: - udplog exporters: - chronicle/chronicle_w_labels
- Replace the port and IP address as required in your infrastructure.
- Replace
<customer_id>
with the actual customer ID. - Update
/path/to/ingestion-authentication-file.json
to the path where the authentication file was saved in the Get Google SecOps ingestion authentication file section.
Restart the Bindplane agent to apply the changes
To restart the Bindplane agent in Linux, run the following command:
sudo systemctl restart bindplane-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.
Need more help? Get answers from Community members and Google SecOps professionals.