Collect Cloudian HyperStore logs

Supported in:

This document explains how to ingest Cloudian HyperStore logs to Google Security Operations using the Bindplane agent.

The parser extracts fields from Cloudian HyperStore syslog messages using grok patterns, including timestamps, IP addresses, user names, and descriptions. It maps extracted fields to 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:

  • A Google SecOps instance
  • Windows Server 2016 or later, or Linux host with systemd
  • Network connectivity between the Bindplane agent and the Cloudian HyperStore system
  • If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
  • Privileged access to the Cloudian HyperStore

Get Google SecOps ingestion authentication file

  1. Sign in to the Google SecOps console.
  2. Go to SIEM Settings > Collection Agents.
  3. Download the Ingestion Authentication File.

  4. Save the file securely on the system where the Bindplane agent will be installed.

Get Google SecOps customer ID

  1. Sign in to the Google SecOps console.
  2. Go to SIEM Settings > Profile.

  3. 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

  1. Open Command Prompt or PowerShell as an administrator.

  2. Run the following command:

    msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet

  3. Wait for the installation to complete.

  4. Verify the installation by running:

    sc query observiq-otel-collector

    The service should show as RUNNING.

Linux installation

  1. Open a terminal with root or sudo privileges.

  2. Run the following command:

    sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh

  3. Wait for the installation to complete.

  4. Verify the installation by running:

    sudo systemctl status observiq-otel-collector

    The service should show as active (running).

Additional installation resources

For additional installation options and troubleshooting, see the Bindplane agent installation guide.

Configure the Bindplane agent to ingest syslog and send to Google SecOps

Locate the configuration file

  • Linux:

    sudo nano /etc/bindplane-agent/config.yaml

  • Windows:

    notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"

Edit the configuration file

  • Replace the entire contents of config.yaml with the following configuration:

    receivers:
    udplog:
        listen_address: "0.0.0.0:514"

exporters:
    chronicle/cloudian_hyperstore:
        compression: gzip
        creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: CLOUDIAN_HYPERSTORE
        raw_log_field: body

service:
    pipelines:
        logs/cloudian_hyperstore_to_chronicle:
            receivers:
                - udplog
            exporters:
                - chronicle/cloudian_hyperstore

Configuration parameters

Replace the following placeholders:

  • Receiver configuration:

    • listen_address: IP address and port to listen on:
      • 0.0.0.0 to listen on all interfaces (recommended)
      • Port 514 is the standard syslog port (requires root on Linux; use 1514 for non-root)

  • Exporter configuration:

    • creds_file_path: Full path to ingestion authentication file:
      • Linux: /etc/bindplane-agent/ingestion-auth.json
      • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
    • customer_id: Customer ID copied from the Google SecOps console
    • endpoint: Regional endpoint URL:
      • US: malachiteingestion-pa.googleapis.com
      • Europe: europe-malachiteingestion-pa.googleapis.com
      • Asia: asia-southeast1-malachiteingestion-pa.googleapis.com
      • See Regional Endpoints for complete list

Save the configuration file

  • After editing, save the file:
    • Linux: Press Ctrl+O, then Enter, then Ctrl+X
    • Windows: Click File > Save

Restart the Bindplane agent to apply the changes

  • To restart the Bindplane agent in Linux, run the following command:

    sudo systemctl restart observiq-otel-collector

    1. Verify the service is running:

      sudo systemctl status observiq-otel-collector

    2. Check logs for errors:

      sudo journalctl -u observiq-otel-collector -f

  • To restart the Bindplane agent in Windows, choose one of the following options:

    • Command Prompt or PowerShell as administrator:

      net stop observiq-otel-collector && net start observiq-otel-collector

    • Services console:

      1. Press Win+R, type services.msc, and press Enter.
      2. Locate observIQ OpenTelemetry Collector.
      3. Right-click and select Restart.

      4. Verify the service is running:

        sc query observiq-otel-collector

      5. Check logs for errors:

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

Configure Cloudian HyperStore syslog

  1. Sign in to your HyperStore Config Controller node using CLI.

  2. Run the following hsctl commands:

    hsctl config set logging.syslog.remote.enabled=true
hsctl config set logging.syslog.remote.host=<BINDPLANE_IP>
hsctl config set logging.syslog.remote.protocol=<UDP_OR_TCP>
hsctl config set logging.syslog.remote.port=<BINDPLANE_PORT>
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 <BINDPLANE_IP> with the Bindplane agent IP address.
    • Replace <UDP_OR_TCP> with the protocol configured in the Bindplane agent.
    • Replace <BINDPLANE_PORT> with the Bindplane agent port number.

UDM mapping table

Log Field UDM Mapping Logic
description metadata.description Directly mapped
datetime metadata.event_timestamp Parsed as RFC3339
method network.http.method Renamed/mapped
url network.http.referral_url Directly mapped
status_code network.http.response_code Renamed/mapped
session_id network.session_id Directly mapped
application principal.application Directly mapped
hostname principal.hostname Directly mapped
source_ip principal.ip Merged
request_id principal.process.pid Directly mapped
target_ip target.ip Merged
port target.port Renamed/mapped
file_path target.process.file.full_path Directly mapped
user target.user.user_display_name Directly mapped
N/A extensions.auth.type Constant: AUTHTYPE_UNSPECIFIED
N/A metadata.event_type Constant: NETWORK_CONNECTION
N/A metadata.product_name Constant: Cloudian Hyperstore
N/A metadata.vendor_name Constant: Cloudian

Need more help? Get answers from Community members and Google SecOps professionals.