Collect uberAgent logs

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

uberAgent is an endpoint security analytics and user experience monitoring platform for Windows and macOS. It collects telemetry data including process events, logon events, network connections, and application usage on monitored endpoints.

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 uberAgent endpoints
• If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
• Privileged access to the uberAgent management console or the endpoints where uberAgent is installed

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 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 logs 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 
   : 
    
   filelog 
   : 
    
   include 
   : 
    
   - 
    
   'C:\uberAgent\logs\*.log' 
    
   - 
    
   'C:\uberAgent\logs\*.csv' 
    
   start_at 
   : 
    
   beginning 
    
   poll_interval 
   : 
    
   5s 
   exporters 
   : 
    
   chronicle/uberagent 
   : 
    
   compression 
   : 
    
   gzip 
    
   creds_file_path 
   : 
    
   'C:\Program 
    
   Files\observIQ 
    
   OpenTelemetry 
    
   Collector\ingestion-auth.json' 
    
   customer_id 
   : 
    
   '<customer_id>' 
    
   endpoint 
   : 
    
   malachiteingestion-pa.googleapis.com 
    
   log_type 
   : 
    
   UBERAGENT 
    
   raw_log_field 
   : 
    
   body 
    
   ingestion_labels 
   : 
    
   env 
   : 
    
   production 
   service 
   : 
    
   pipelines 
   : 
    
   logs/uberagent_to_chronicle 
   : 
    
   receivers 
   : 
    
   - 
    
   filelog 
    
   exporters 
   : 
    
   - 
    
   chronicle/uberagent 
   
  

Configuration parameters

Replace the following placeholders:

• Receiver configuration:

  • include : Paths to uberAgent log files:
    • Windows (local): C:\uberAgent\logs\*.log and C:\uberAgent\logs\*.csv
    • Windows (file share): \\SERVER\Share\uberagent-logs\*.log
    • Adjust the path based on your uberAgent file output configuration
  • start_at : Set to beginning to read existing logs, or end to read only new entries
  • poll_interval : How often to check for new log data (default: 5s )

• Exporter configuration:

  • uberagent : Descriptive name for the exporter
  • 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 from the previous step
  • 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
  • UBERAGENT : Log type exactly as it appears in Chronicle
  • ingestion_labels : Optional labels in YAML format (for example, env: production )

• Pipeline configuration:

  • uberagent_to_chronicle : Descriptive name for the pipeline

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 uberAgent file output

uberAgent supports multiple output backends. To export data as files for collection by the Bindplane agent:

1. Open the uberAgent configuration file ( uberAgent.conf ) on the endpoint or via Group Policy.

2. Configure a file-based output receiver:

    [Receiver]
   Name = FileOutput
   Type = File
   Path = C:\uberAgent\logs\ 
   

3. Configure the metrics and sourcetypes to export:

   • Process: Process start/stop events, resource usage.
   • Logon: User logon/logoff events.
   • Network: Network connection events.
   • Application: Application usage and errors.

4. Save the configuration and restart the uberAgent service.

5. Verify that log files are being created in the configured output directory.

6. Ensure the Bindplane agent has read permissions on the log directory and files.

UDM mapping table

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