# Collect BeyondTrust Secure Remote Access (formerly BeyondTrust Privileged Remote Access) logs

Supported in:

This document explains how to ingest BeyondTrust Secure Remote Access (formerly known as BeyondTrust Privileged Remote Access) logs to Google Security Operations using Bindplane.

BeyondTrust Secure Remote Access is a privileged access management solution that lets organizations control, monitor, and audit privileged remote access for vendors, contractors, and internal administrators connecting to critical systems. It provides credential injection, just-in-time access, and session recording. BeyondTrust Secure Remote Access logs session activity, authentication events, and administrative actions via syslog.

## Before you begin

Make sure you have the following prerequisites:

- A Google SecOps instance.
- A Windows 2016 or later or Linux host with systemd.
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements.
- Administrative access to the BeyondTrust Secure Remote Access B Series Appliance interface (`/appliance`).

## 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](https://console.cloud.google.com/) 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]
> **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 **Settings \> Data Management \> Collection Agents** . If you are on a SIEM-only platform, go to **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]
> **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 **Settings \> Administration \> Profile** . If you are on a SIEM-only platform, go to **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 the **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

### 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

### Additional installation resources

For additional installation options, consult this [installation guide](https://docs.cloud.google.com/chronicle/docs/ingestion/use-bindplane-agent#install_the_bindplane_agent).

> [!NOTE]
> **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 the Bindplane agent to ingest Syslog and send to Google SecOps

1. Access the Configuration File:

   - Locate the `config.yaml` file. Typically, it's in the `/opt/observiq-otel-collector/` directory on Linux or in the installation directory on Windows.
   - Open the file using a text editor (for example, `nano`, `vi`, or Notepad).
2. Edit the `config.yaml` file as follows:

       receivers:
         udplog:
           # Replace the port and IP address as required
           listen_address: "0.0.0.0:514"

       exporters:
         chronicle/chronicle_w_labels:
           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
           # Adjust the path to the credentials file you downloaded in Step 1
           creds_file_path: '/path/to/ingestion-authentication-file.json'
           # Replace with your actual customer ID from Step 2
           customer_id: <your_customer_id>
           endpoint: chronicle.googleapis.com
           # Add optional ingestion labels for better organization
           log_type: 'BEYONDTRUST_REMOTE_ACCESS'
           raw_log_field: body
           ingestion_labels:

       service:
         pipelines:
           logs/source0__chronicle_w_labels-0:
             receivers:
               - udplog
             exporters:
               - chronicle/chronicle_w_labels

- Replace the port and IP address as required in your infrastructure.
- 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.
- Replace `<PROJECT_NUMBER>` with the project number from **IAM \& Admin \> Settings**.
- Replace `<your_customer_id>` with the actual Customer ID.
- Update `/path/to/ingestion-authentication-file.json` to the file path where the service account key file (Option 1) was saved in Step 1.

  > [!NOTE]
  > **Note:** BeyondTrust Secure Remote Access uses `local0` facility and defaults to UDP port 514 for non-TLS syslog. If you configure Syslog over TLS on the appliance, use `tcplog` as the receiver and set the port to `6514`.

### 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](https://docs.cloud.google.com/chronicle/docs/reference/ingestion-api#regional-endpoints) (for example, `europe-malachiteingestion-pa.googleapis.com`).

      exporters:
        chronicle/chronicle_w_labels:
          compression: gzip
          # Adjust the path to the credentials file you downloaded in Step 1
          creds_file_path: '/path/to/ingestion-authentication-file.json'
          # Replace with your actual customer ID from Step 2
          customer_id: <your_customer_id>
          endpoint: malachiteingestion-pa.googleapis.com
          # Add optional ingestion labels for better organization
          log_type: 'BEYONDTRUST_REMOTE_ACCESS'
          raw_log_field: body
          ingestion_labels:

> [!NOTE]
> **Note:** This exporter will stop working when the Ingestion API is discontinued on July 20, 2027.

## Restart the Bindplane agent to apply the changes

To restart the Bindplane agent in Linux:

1. Run the following command:

       sudo systemctl restart observiq-otel-collector

2. Verify the service is running:

       sudo systemctl status observiq-otel-collector

3. Check logs for errors:

       sudo journalctl -u observiq-otel-collector -f

To restart the Bindplane agent in Windows:

1. 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**.
2. Verify the service is running:

       sc query observiq-otel-collector

3. Check logs for errors:

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

## Configure BeyondTrust Secure Remote Access syslog forwarding

1. Sign in to the BeyondTrust Secure Remote Access **B Series Appliance** interface (`/appliance`).
2. Go to **Security** \> **Appliance Administration**.
3. Scroll down to the **Syslog** section.
4. In the **Remote Syslog Server** field, enter the hostname or IP address of the Bindplane agent host (for example, `192.168.1.100`).
5. Select the **Message Format** for event notification messages:
   - **RFC 5424** - modern syslog standard with structured data (recommended).
   - **BSD (legacy)** - legacy BSD syslog format (RFC 3164).
   - **Syslog over TLS** - encrypted syslog using TCP port 6514.
6. If necessary, change the default port:
   - RFC 5424 and BSD formats default to **UDP 514**.
   - Syslog over TLS defaults to **TCP 6514**.
7. Click **Save**.

   > [!NOTE]
   > **Note:** You can configure up to three syslog servers on the B Series Appliance. When adding or changing a syslog server, an alert is emailed to the administrator's email address.

   > [!NOTE]
   > **Note:** Events from both the `/login` administrative interface (such as user login attempts, account creation, and configuration changes) and the `/appliance` interface are sent as syslog messages. BeyondTrust Secure Remote Access logs are sent using the `local0` facility.

### Verify syslog delivery

1. After configuring syslog forwarding, initiate a test support session or sign in to the `/login` administrative interface.
2. On the Bindplane agent host, verify that logs are being received:

       sudo journalctl -u observiq-otel-collector -f

For more information, see the [BeyondTrust Privileged Remote Access syslog documentation](https://docs.beyondtrust.com/pra/docs/syslog).

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
| `_field` | `additional.fields` | Merged |
| `additional_device_product` | `additional.fields` | Merged |
| `additional_device_vendor` | `additional.fields` | Merged |
| `additional_dst_priv` | `additional.fields` | Merged |
| `additional_event_name` | `additional.fields` | Merged |
| `additional_external_key_label` | `additional.fields` | Merged |
| `additional_jumpGroupId` | `additional.fields` | Merged |
| `additional_jumpGroupName` | `additional.fields` | Merged |
| `additional_jumpGroupType` | `additional.fields` | Merged |
| `additional_jumpointId` | `additional.fields` | Merged |
| `additional_jumpointName` | `additional.fields` | Merged |
| `additional_segment_number` | `additional.fields` | Merged |
| `additional_site_id` | `additional.fields` | Merged |
| `additional_total_segments` | `additional.fields` | Merged |
| `appliance_identifier_label` | `additional.fields` | Merged |
| `appliance_label` | `additional.fields` | Merged |
| `eventid_label` | `additional.fields` | Merged |
| `eventsubject_label` | `additional.fields` | Merged |
| `eventtype_label` | `additional.fields` | Merged |
| `format_version_label` | `additional.fields` | Merged |
| `nvps_actiontype_label` | `additional.fields` | Merged |
| `nvps_authenticationtype_label` | `additional.fields` | Merged |
| `nvps_createdate_label` | `additional.fields` | Merged |
| `nvps_eventseverity_label` | `additional.fields` | Merged |
| `nvps_subjectdescription_label` | `additional.fields` | Merged |
| `product_label` | `additional.fields` | Merged |
| `eventName` | `extensions.auth.auth_details` | Directly mapped |
| `mechanism` | `extensions.auth.mechanism` | Merged |
| `target` | `extensions.auth.type` | Mapped: `"rep_client", "web/login"` → `MACHINE`, `"rep_client", "web/login"` → `SSO`, \`rep_c... |
| `intermediary_hostname` | `intermediary.asset.hostname` | Directly mapped |
| `intermediary_ip` | `intermediary.asset.ip` | Merged |
| `intermediary_hostname` | `intermediary.hostname` | Directly mapped |
| `intermediary_ip` | `intermediary.ip` | Merged |
| `msg` | `metadata.description` | Directly mapped |
| `datetime` | `metadata.event_timestamp` | Parsed as `RFC 3339` |
| `eventdate` | `metadata.event_timestamp` | Parsed as `MMM dd yyyy HH:mm:ss` |
| `timestamp` | `metadata.event_timestamp` | Parsed as `ISO8601` |
| `timestampvalue` | `metadata.event_timestamp` | Parsed as `yyyy-MM-ddTHH:mm:ssZZ` |
| `when` | `metadata.event_timestamp` | Parsed as `UNIX` |
| `device_vendor` | `metadata.event_type` | Mapped: `Bomgar` → `GENERIC_EVENT` |
| `eventName` | `metadata.event_type` | Mapped: `(?i)login` → `USER_LOGIN`, `(?i)logout` → `USER_LOGOUT` |
| `has_principal` | `metadata.event_type` | Mapped: `true` → `NETWORK_CONNECTION`, `true` → `STATUS_UPDATE` |
| `category` | `metadata.product_event_type` | Directly mapped |
| `event_name` | `metadata.product_event_type` | Directly mapped |
| `id` | `metadata.product_event_type` | Directly mapped |
| `nvps_auditid` | `metadata.product_log_id` | Directly mapped |
| `product_log_id` | `metadata.product_log_id` | Directly mapped |
| `device_version` | `metadata.product_version` | Directly mapped |
| `version` | `metadata.product_version` | Directly mapped |
| `sessionId` | `network.session_id` | Directly mapped |
| `agentid` | `observer.application` | Directly mapped |
| `product_event_type` | `principal.asset.hostname` | Directly mapped |
| `nvps_ipaddress` | `principal.asset.ip` | Merged |
| `sourceip` | `principal.asset.ip` | Merged |
| `product_event_type` | `principal.hostname` | Directly mapped |
| `nvps_ipaddress` | `principal.ip` | Merged |
| `sourceip` | `principal.ip` | Merged |
| `srcHost` | `principal.ip` | Merged |
| `who_ip` | `principal.ip` | Merged |
| `process_id` | `principal.process.pid` | Directly mapped |
| `srcUser` | `principal.user.user_display_name` | Directly mapped |
| `user_display_name` | `principal.user.user_display_name` | Directly mapped |
| `srcUid` | `principal.user.userid` | Directly mapped |
| `user` | `principal.user.userid` | Directly mapped |
| `userid` | `principal.user.userid` | Directly mapped |
| `who` | `principal.user.userid` | Directly mapped |
| `security_action` | `security_result.action` | Merged |
| `status` | `security_result.action_details` | Directly mapped |
| `reason` | `security_result.description` | Directly mapped |
| `severity` | `security_result.severity` | Mapped values (5 total, e.g. `0` → `UNKNOWN_SEVERITY`, `1` → `LOW`, `2` → `MEDIUM`) |
| `eventName` | `security_result.summary` | Directly mapped |
| `eventname` | `security_result.summary` | Directly mapped |
| `nvps_systemname` | `target.application` | Directly mapped |
| `target` | `target.application` | Directly mapped |
| `filePath` | `target.file.full_path` | Directly mapped |
| `fsize` | `target.file.size` | Directly mapped |
| `deviceHost` | `target.hostname` | Directly mapped |
| `site` | `target.hostname` | Directly mapped |
| `dstHost` | `target.ip` | Merged |
| `nvps_username_label` | `target.resource.attribute.labels` | Merged |
| `nvps_appuserid` | `target.user.product_object_id` | Directly mapped |
| `dstUser` | `target.user.user_display_name` | Directly mapped |
| `dstUid` | `target.user.userid` | Directly mapped |
| N/A | `extensions.auth.type` | Constant: `MACHINE` |
| N/A | `metadata.event_type` | Constant: `USER_LOGIN` |
| N/A | `metadata.product_name` | Constant: `BeyondTrust Secure Remote Access` |
| N/A | `metadata.vendor_name` | Constant: `BeyondTrust` |
| N/A | `security_result.severity` | Constant: `UNKNOWN_SEVERITY` |

**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/)