Console
    Start free

    Collect BeyondTrust Privileged Identity logs

    Supported in:

    This document explains how to ingest BeyondTrust Privileged Identity logs to Google Security Operations using the Bindplane agent.

    BeyondTrust Privileged Identity is a privileged account management solution that generates syslog messages in CEF and non-CEF formats for security events, authentication, and account activity. The parser normalizes fields and maps them to the Unified Data Model (UDM).

    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 BeyondTrust Privileged Identity instance
    • If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
    • Privileged access to an instance of BeyondTrust Privileged Identity

    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 IDfrom the Organization Detailssection.

    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 Promptor PowerShellas 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 
 : 
  
 udplog 
 : 
  
 listen_address 
 : 
  
 "0.0.0.0:514" 
 exporters 
 : 
  
 chronicle/beyondtrust_pi 
 : 
  
 compression 
 : 
  
 gzip 
  
 creds_file_path 
 : 
  
 '/etc/bindplane-agent/ingestion-auth.json' 
  
 customer_id 
 : 
  
 '<customer_id>' 
  
 endpoint 
 : 
  
 malachiteingestion-pa.googleapis.com 
  
 log_type 
 : 
  
 BEYONDTRUST_PI 
  
 raw_log_field 
 : 
  
 body 
 service 
 : 
  
 pipelines 
 : 
  
 logs/beyondtrust_pi_to_chronicle 
 : 
  
 receivers 
 : 
  
 - 
  
 udplog 
  
 exporters 
 : 
  
 - 
  
 chronicle/beyondtrust_pi

    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 syslog in BeyondTrust Privileged Identity

    1. Sign in to the BeyondTrust Privileged Appliance.
    2. Go to Appliance > Security > Appliance Administration.
    3. Go to the Syslogsection.
    4. Provide the following configuration details:
      • Hostname: Enter the Bindplane agent IP address.
      • Port: Default port is set to 514 (UDP).
      • Format: Select RFC 5424.
    5. Click Save.

    UDM mapping table

    Log Field UDM Mapping Logic
    cs1
    		 additional.fields[0].key Directly mapped from the raw log field cs1Label .
    cs1Label
    		 additional.fields[0].value.string_value Directly mapped from the raw log field cs1 .
    cs3
    		 additional.fields[1].value.string_value Directly mapped from the raw log field cs3Label .
    cs3Label
    		 additional.fields[1].key Directly mapped from the raw log field cs3 .
    cs4
    		 additional.fields[2].value.string_value Directly mapped from the raw log field cs4Label .
    cs4Label
    		 additional.fields[2].key Directly mapped from the raw log field cs4 .
    data
    		 metadata.description For CEF messages, the msg field (extracted from data ) is mapped to metadata.description . For non-CEF messages, the sMessage field (or parts of it, depending on the specific message format) is mapped to metadata.description .
    dhost
    		 target.hostname Directly mapped from the raw log field dhost .
    dntdom
    		 target.administrative_domain Directly mapped from the raw log field dntdom .
    duser
    		 target.user.user_display_name Directly mapped from the raw log field duser .
    msg
    		 metadata.description Directly mapped from the raw log field msg in CEF messages.
    rt
    		 metadata.event_timestamp.seconds The epoch timestamp is extracted from the rt field in CEF messages.
    sEventType
    		 metadata.product_event_type Directly mapped from the raw log field sEventType in non-CEF messages.
    shost
    		 principal.ip Directly mapped from the raw log field shost .
    sIpAddress
    		 principal.ip Directly mapped from the raw log field sIpAddress in non-CEF messages.
    sLoginName
    		 principal.user.userid Extracted from the sLoginName field using a regular expression to separate the domain and user ID.
    sMessage
    		 security_result.description Directly mapped from the raw log field sMessage in non-CEF messages, or extracted parts of it are used for security_result.description .
    sntdom
    		 principal.administrative_domain Directly mapped from the raw log field sntdom .
    sOriginatingAccount
    		 principal.user.userid Extracted from the sOriginatingAccount field using a regular expression to separate the domain and user ID.
    sOriginatingApplicationComponent
    		 principal.application Used in combination with sOriginatingApplicationName to populate principal.application .
    sOriginatingApplicationName
    		 principal.application Used in combination with sOriginatingApplicationComponent to populate principal.application .
    sOriginatingSystem
    		 principal.hostname Directly mapped from the raw log field sOriginatingSystem in non-CEF messages.
    suser
    		 principal.user.user_display_name Directly mapped from the raw log field suser . Determined by parser logic based on the presence and values of other fields like dst , src , shost , and suid . Possible values are NETWORK_CONNECTION , STATUS_UPDATE , USER_UNCATEGORIZED , and GENERIC_EVENT . Set to "BEYONDTRUST_PI". Set to "BeyondTrust Remote Support". Extracted from the CEF header in CEF messages. Set to "BeyondTrust". Set to "ALLOW" or "BLOCK" based on the status , reason , or sMessage fields. Set to LOW .

    Change Log

    View the Change Log for this parser

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

    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: