Collect Corelight logs

Supported in:

This document explains how to ingest Corelight logs to Google Security Operations using Bindplane.

The parser extracts fields from Corelight JSON formatted logs. It uses JSON parsing to process the log message and then maps these values to the Unified Data Model (UDM). It also sets default metadata values for the event source and type.

Before you begin

Make sure you have the following prerequisites:

  • A Google SecOps instance
  • Windows Server 2016 or later, or Linux host with systemd
  • If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
  • Privileged access to the Corelight Sensor web interface

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. Save the file securely on the system where Bindplane 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 Bindplane agent installation guide.

Configure 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:
        tcplog:
            listen_address: "0.0.0.0:514"
    
    exporters:
        chronicle/chronicle_w_labels:
            compression: gzip
            creds_file_path: '/path/to/ingestion-authentication-file.json'
            customer_id: 'YOUR_CUSTOMER_ID'
            endpoint: malachiteingestion-pa.googleapis.com
            log_type: 'CORELIGHT'
            raw_log_field: body
            ingestion_labels:
    
    service:
        pipelines:
            logs/source0__chronicle_w_labels-0:
                receivers:
                    - tcplog
                exporters:
                    - chronicle/chronicle_w_labels
    

Configuration parameters

  • Replace the following placeholders:

    • Receiver configuration:

      • tcplog: Use udplog for UDP syslog or tcplog for TCP syslog
      • 0.0.0.0: IP address to listen on (0.0.0.0 to listen on all interfaces)
      • 514: Port number to listen on (standard syslog port)
    • 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
      • YOUR_CUSTOMER_ID: Customer ID from the Get customer ID section
      • 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
      • log_type: Log type exactly as it appears in Chronicle (CORELIGHT)

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 Corelight syslog forwarding

  1. Sign in to the Corelight Sensor web interface.
  2. Go to Sensor > Export.
  3. Click Add Exporter or edit an existing exporter.
  4. Select Syslog as the export type.
  5. Provide the following configuration details:
    • Target Host: Enter the IP address of the Bindplane agent host.
    • Target Port: Enter 514.
    • Protocol: Select TCP.
    • Format: Select JSON (recommended for full data fidelity).
    • Log Filter: Select the log types to forward, or select All Logs for comprehensive coverage. Commonly used log types:
      • conn: Connection logs
      • dns: DNS queries
      • http: HTTP transactions
      • ssl: SSL/TLS connections
      • files: File analysis
      • notice: Zeek notices
      • weird: Protocol anomalies
      • x509: Certificate logs
  6. Click Save to apply the configuration.
  7. Verify logs are being sent by checking the Bindplane agent logs.

Alternatively, configure using Corelight Fleet Manager:

  1. Sign in to the Corelight Fleet Manager.
  2. Go to Fleet > Sensors.
  3. Select the target sensor.
  4. Go to Configuration > Export.
  5. Configure the syslog exporter as described above.
  6. Click Deploy Configuration.

UDM mapping table

Log field UDM mapping Logic
metadata.vendor_name The metadata.vendor_name UDM field is set to Corelight.
_path (string) metadata.product_event_type
_system_name (string) observer.hostname
ts (time) metadata.event_timestamp
uid (string) about.labels [uid], network.session_id
id.orig_h (string - addr) principal.ip
id.orig_p (integer - port) principal.port
id.resp_h (string - addr) target.ip
id.resp_p (integer - port) target.port
_write_ts metadata.collected_timestamp
id.vlan (integer - int) additional.fields [id_vlan]
id.vlan_inner (integer - int) additional.fields [id_vlan_inner]
id.orig_ep_cid (string) additional.fields [id_orig_ep_cid]
id.orig_ep_source (string) additional.fields [id_orig_ep_source]
id.orig_ep_status (string) additional.fields [id_orig_ep_status]
id.orig_ep_uid (string) additional.fields [id_orig_ep_uid]
id.resp_ep_cid (string) additional.fields [id_resp_ep_cid]
id.resp_ep_source (string) additional.fields [id_resp_ep_source]
id.resp_ep_status (string) additional.fields [id_resp_ep_status]
id.resp_ep_uid (string) additional.fields [id_resp_ep_uid]
uids (array[string] - vector of string) additional.fields [uid]
count (integer - int) additional.fields [count]
ts_last additional.fields [ts_last]

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