Collect uberAgent logs

Supported in:

Google SecOps SIEM

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 credentials for the Bindplane agent

To authenticate the Bindplane agent to Google SecOps, choose one of the following methods:

• New deployments: Use the Chronicle API (Option 1).
• Legacy deployments: Continue using the ingestion authentication file (Option 2) until the Ingestion API is discontinued on July 20, 2027.

Option 1: Create a service account for the Chronicle API (recommended)

1. Sign in to the Google Cloud console and select the Google Cloud project that is linked to your Google SecOps instance.
2. Go to IAM & Admin > Service Accounts.
3. Click Create service account.
4. Provide the following configuration details:
   • Service account name: Enter a name for the account (for example, bindplane-ingest).
   • Service account description: Enter a description (for example, Bindplane agent log ingestion).
5. Click Create and continue.
6. In the Grant this service account access to project section, click Select a role and select Chronicle Editor.
7. Click Continue, and then click Done.
8. Click the service account you created, and then go to the Keys tab.
9. Click Add key > Create new key.
10. Select JSON and click Create. The key file is downloaded to your computer.
11. Save the key file as ingestion-auth.json in the Bindplane collector directory (/opt/observiq-otel-collector/ingestion-auth.json on Linux or C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json on Windows), or update creds_file_path in config.yaml to match the path where you save it.
12. Go to IAM & Admin > Settings and copy the Project number. You'll need it for the exporter configuration.

Note: The JSON key is a credential. Restrict access to the file on the Bindplane host and rotate the key according to your organization's policy.

Option 2: Download the ingestion authentication file (legacy)

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.

Note: This file authenticates the agent to the legacy Ingestion API (malachiteingestion-pa.googleapis.com), which Google has scheduled for end of life on July 20, 2027. Plan to move to Option 1 before that date.

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.

   Note: The customer ID is required for configuring the Bindplane agent exporter.

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.

Note: The Chronicle API exporter configuration requires Bindplane collector v1.106.0 or later. The previous commands install the latest release. If you're updating an existing installation, upgrade the collector before changing the configuration.

Configure Bindplane agent to ingest logs and send to Google SecOps

Locate the configuration file

• Linux:

  sudo nano /opt/observiq-otel-collector/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:
      protocol: https
      # Region of your instance, for example us, europe, asia-southeast1
      location: <LOCATION>
      # Project number of the Google Cloud project linked to the instance
      project: '<PROJECT_NUMBER>'
      compression: gzip
      creds_file_path: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: chronicle.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 the service account JSON key file (Option 1):
    • Linux: /opt/observiq-otel-collector/ingestion-auth.json
    • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • <customer_id>: Customer ID from the previous step
  • location: Replace <LOCATION> with the region of your Google SecOps instance (for example, us, europe, or asia-southeast1). The exporter prefixes chronicle.googleapis.com with this value. See Regional Endpoints for the complete list.
  • project: Replace <PROJECT_NUMBER> with the project number from IAM & Admin > Settings.
  • endpoint: Keep set to chronicle.googleapis.com.
  • 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

Legacy ingestion API exporter

• If you use the ingestion authentication file from Option 2, replace the exporters block with the following. Set creds_file_path to the path to the ingestion authentication file, and if your instance is outside the US, replace malachiteingestion-pa.googleapis.com with your regional endpoint (for example, europe-malachiteingestion-pa.googleapis.com).

  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
  

Note: This exporter will stop working when the Ingestion API is discontinued on July 20, 2027.

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\
   

   Note: Replace C:\uberAgent\logs\` with the desired output path. For centralized collection, use a network file share path such as\SERVER\Share\uberagent-logs`. uberAgent outputs data in CSV format by default.

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.

   Note: For detailed configuration options, see the uberAgent documentation.

UDM mapping table

Log Field	UDM Mapping	Logic
SessionRpLatencyMs2, SessionHRes, SessionVRes, SessionColorDepth, SessionClientPlatform, SessionClientVersion, SessionClientOsLanguage, SessionPublishedName, SessionPublishedAppsCtx, SessionAppStateCtx, SessionEncryptionCtx, SessionClientTypeCtx, SessionBrokerDnsVmw, SessionBrokerUrlVmw, SessionBrokerTunneledVmw, SessionBrokerTunnelUrlVmw, SessionBrokerRemoteIpVmw, SessionBrokerUserVmw, SessionBrokerDomainVmw, SessionClientTimezoneVmw, SessionClientIdVmw, SessionTypeVmw, SessionBrokerType, SessionFgAppId, SessionFgAppVersion, SessionFgProcessName, SessionFgProcessId, SessionFgBrowserType, SessionFgBrowserActiveTabHost, SessionFgWindowTitle, SessionClientHwIdCtx2, SessionRoundTripTimeMs, SessionFps, SessionTransportProtocols, SessionProcessCount, SessionIOMB, SessionCPUTimeMs, SessionConnectionState, SessionUser, SessionIOCount, SessionNetKBPS, SessionWorkingSetMB, SessionCPUUsagePercent, SessionIOPS, SessionClientName, SessionIOLatencyMs, PowerSupportsS3, IsBatteryPresent, PowerSupportsS1, PowerSupportsS2, PowerSupportsS5, CPUMaxMhz, BaseboardSerial, CtxMachineCatalogName, AdDomainDns, HwHypervisorVendor, OsBuild, HwBiosVersion, PowerSupportsS4, HwIsVirtualMachine, IsUpsPresent, PowerSupportsConnectedStandby, OsInstallDate, Sourcetype, uberagent_index_name, data_stream.namespace, data_stream.dataset, data_stream.type, data_stream.subset, CPUCoresLogical, AdOu, AdDomainNetBios, logstash_pipeline, AdSite, CtxFarmName, CPUSockets, OsSpName, OsName, OsType, OsUpdateBuildRevision, ComputerNameCanonical, ComputerNameDn, CtxDeliveryGroupName, tags, user_agent.original	additional.fields	Merged as key-value pairs from the listed fields
	metadata.event_type	Set to STATUS_UPDATE if has_principal true and has_target false, NETWORK_CONNECTION if both true, GENERIC_EVENT otherwise
SessionGUID	metadata.product_log_id	Value copied directly
user_agent.original	network.http.parsed_user_agent	Converted to parsed user agent
user_agent.original	network.http.user_agent	Value copied directly
SessionTransportProtocols	network.ip_protocol	Set to UDP if matches (?i)udp, TCP if (?i)tcp
SessionID	network.session_id	Value copied directly
SessionClientUserDomain	principal.administrative_domain	Value copied directly
CPUCoresPhysical, RAMSizeGB, CPUName, HwManufacturer, OsArchitecture, BIOSSerial, HwModel	principal.asset.hardware	Merged into hardware object
SessionClientDomain, host	principal.asset.hostname	Value from SessionClientDomain if not empty, else host
prin_ip, SessionClientIp, system_ip	principal.asset.ip	Value from prin_ip if not empty, else SessionClientIp, else system_ip
SessionClientDomain, host	principal.hostname	Value from SessionClientDomain if not empty, else host
prin_ip, SessionClientIp, system_ip	principal.ip	Value from prin_ip if not empty, else SessionClientIp, else system_ip
SessionClientMac	principal.mac	Value from SessionClientMac, with - replaced by :, lowercased
SessionClientPlatform	principal.platform	Set to WINDOWS if matches (?i)windows
SessionClientVersion	principal.platform_version	Set to value if matches (?i)windows
SessionUser, SessionClientUser	principal.user.user_display_name	Value from SessionUser if not empty, else SessionClientUser
SessionBrokerRemoteIpVmw	target.ip	Value copied directly
SessionBrokerUserVmw	target.user.user_display_name	Value copied directly
SessionClientIdVmw	target.user.userid	Value copied directly
	metadata.product_name	Set to "UBERAGENT"
	metadata.vendor_name	Set to "UBERAGENT"

Change Log

View the Change Log for this parser

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