# Collect Trellix Endpoint Security (HX) Audit (formerly FireEye HX) logs

**Parser Version:** 1.0
Supported in:

This document explains how to ingest Trellix Endpoint Security (HX) Audit (formerly known as FireEye HX) logs to Google Security Operations using Bindplane.

Trellix Endpoint Security (HX) provides endpoint detection and response capabilities with advanced threat hunting, forensics data collection, and behavioral analysis to detect and respond to advanced threats on endpoints using machine learning built from thousands of incident response engagements.

## Before you begin

Make sure you have the following prerequisites:

- A Google SecOps instance.
- Windows Server 2016 or later, or a Linux host with `systemd`.
- Network connectivity between the Bindplane agent and Trellix Endpoint Security (HX) appliance.
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements.
- Privileged access to the Trellix Endpoint Security (HX) management console.
- Administrative access to the Trellix Endpoint Security (HX) appliance CLI (SSH or console access).

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

> [!NOTE]
> **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](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](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 the [Bindplane agent 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

### Locate the configuration file

- **Linux:** `/opt/observiq-otel-collector/config.yaml`
- **Windows:** `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/trellix_hx:
          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: '/opt/observiq-otel-collector/ingestion-auth.json'
          customer_id: 'YOUR_CUSTOMER_ID'
          endpoint: chronicle.googleapis.com
          log_type: FIREEYE_HX_AUDIT
          raw_log_field: body
          ingestion_labels:
            env: production
            source: trellix_hx

      service:
        pipelines:
          logs/trellix_hx_to_chronicle:
            receivers:
              - tcplog
            exporters:
              - chronicle/trellix_hx

### Configuration parameters

Replace the following placeholders:

- **Receiver configuration:**

  - `tcplog`: TCP receiver is used because the Trellix Endpoint Security (HX) appliance CLI configures syslog forwarding over TCP protocol.
  - `listen_address`: IP address and port to listen on. Use `0.0.0.0:514` to listen on all interfaces on port **514** , or specify a different port such as `0.0.0.0:1514` if running as non-root on Linux.
- **Exporter configuration:**

  - `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`
  - `YOUR_CUSTOMER_ID`: Your actual 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](https://docs.cloud.google.com/chronicle/docs/reference/rest?rep_location=us#regional-service-endpoint) for the complete list.
  - `project`: Replace `<PROJECT_NUMBER>` with the project number from **IAM \& Admin \> Settings**.
  - `endpoint`: Keep set to `chronicle.googleapis.com`.
  - `log_type`: Must be exactly `FIREEYE_HX_AUDIT`.
  - `ingestion_labels`: Optional labels for organizing logs.

### 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/trellix_hx:
          compression: gzip
          creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
          customer_id: 'YOUR_CUSTOMER_ID'
          endpoint: malachiteingestion-pa.googleapis.com
          log_type: FIREEYE_HX_AUDIT
          raw_log_field: body
          ingestion_labels:
            env: production
            source: trellix_hx

> [!NOTE]
> **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:

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 Trellix Endpoint Security (HX) syslog forwarding

Trellix Endpoint Security (HX) supports two methods for forwarding logs: Event Streamer module for Windows Event Logs and CLI configuration for appliance logs in CEF format.

### Method 1: Configure Event Streamer for Windows Event Logs (UI)

1. Sign in to the **Trellix Endpoint Security (HX)** management console.
2. Go to **Event Streamer**.
3. Select **Enable Event Streamer on the host**.
4. Click **Save** to apply the policy changes.
5. Go to **Destinations \> Server settings \> Add syslog destination**.
6. Provide the following configuration details:
   - **Name** : Enter a descriptive name (for example, `Google SecOps-Collector`).
   - **IP address**: Enter the IP address of the Bindplane agent host.
   - **Port** : Enter the port number configured in the Bindplane agent (for example, `514`).
7. Click **Save**.

> [!NOTE]
> **Note:** The Event Streamer module supports streaming System, Application Experience, Security, AppLocker, PowerShell, Application, Windows Defender, Task Scheduler, Print Service, and Terminal Services Windows event logs using RFC 5424 syslog format.

### Method 2: Configure appliance syslog forwarding (CLI)

1. Sign in to the **Trellix Endpoint Security (HX)** appliance using **SSH** or console access.
2. Run the following command to enter privileged mode: `enable`
3. Run the following command to enter configuration mode: `configure terminal`
4. Run the following command to verify current logging configuration: `show logging`
5. Run the following commands to configure syslog forwarding:

       logging BINDPLANE_IP_ADDRESS trap none
       logging BINDPLANE_IP_ADDRESS trap override class cef priority info
       logging BINDPLANE_IP_ADDRESS protocol tcp

   *Replace `BINDPLANE_IP_ADDRESS` with the IP address of the Bindplane agent host.*
6. Run the following command to enable **RFC-3339** timestamp format: `logging fields timestamp format rfc-3339`

7. Run the following command to save the configuration: `write memory`

8. Run the following command to exit: `exit`

### Enable Data Acquisition for event log collection

1. Sign in to the **Trellix Endpoint Security (HX)** Web UI with admin access.
2. Go to **Admin \> Data Acquisition Scripts**.
3. Click **Standard Investigative Details**.
4. On the **Script Description** page, click **ACTIONS** and select **Edit**.
5. Click **Event Logs**.
6. Enable **Security logs** in the **Windows event logs** section.
7. Click **Save**.

### Enable Auto Triage

1. Sign in to the **Trellix Endpoint Security (HX)** Web UI with admin access.
2. Go to **Admin \> Triage Settings**.
3. Toggle the **Triage Settings switch to ON**.
4. Click **Save**.

### Enable File and Data Audits

1. Sign in to the **Trellix Endpoint Security (HX)** Web UI with admin access.
2. Go to **Admin \> Policies**.
3. Under **Configurations** , click **Audits - version number**.
4. Turn on **Enable the File and Data Audits on the host**.
5. Click **Save**.

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
| `alert.agent._id` | `principal.asset.asset_id` | Agent ID prefixed with **AGENT ID:** |
| `alert.agent.url` | `principal.labels.value` | Agent URL value. |
| `alert.condition._id` | `additional.fields.value.string_value` | Condition ID with **=** characters removed. |
| `alert.condition.url` | `additional.fields.value.string_value` | Condition URL with **=** characters removed. |
| `alert.decorators[].data.fireeye_report.indicator_verdict.malware_families.0` | `security_result.threat_name` | Malware family from FireEye report. |
| `alert.decorators[].data.fireeye_report.risk_summary` | `security_result.description` | Risk summary description. |
| `alert.decorators[].data.fireeye_verdict` | `security_result.severity_details` | FireEye verdict details. |
| `alert.event_at` | `read_only_udm.metadata.event_timestamp` | Event timestamp mapping. |
| `alert.event_id` | `read_only_udm.metadata.product_log_id` | Product log identifier. |
| `alert.event_type` | `read_only_udm.metadata.product_event_type` | Product event type identifier. |
| `alert.event_values.fileWriteEvent/fullPath` | `target.file.full_path` | Target file path. |
| `alert.event_values.fileWriteEvent/md5` | `target.file.md5` | Target file MD5 hash. |
| `alert.event_values.fileWriteEvent/pid` | `principal.process.pid` | Writing process PID. |
| `alert.event_values.fileWriteEvent/processPath` | `principal.process.file.full_path` | Writing process file path. |
| `alert.event_values.fileWriteEvent/size` | `target.file.size` | Target file size. |
| `alert.event_values.fileWriteEvent/username` | `principal.user.userid` | Writing user identifier. |
| `alert.event_values.ipv4NetworkEvent/localIP` | `principal.ip` | Principal local IP. |
| `alert.event_values.ipv4NetworkEvent/localPort` | `principal.port` | Principal local port. |
| `alert.event_values.ipv4NetworkEvent/protocol` | `network.ip_protocol` | Network IP protocol. |
| `alert.event_values.ipv4NetworkEvent/remoteIP` | `target.ip` | Target remote IP. |
| `alert.event_values.ipv4NetworkEvent/remotePort` | `target.port` | Target remote port. |
| `alert.event_values.processEvent/md5` | `target.process.file.md5` | Target process MD5. |
| `alert.event_values.processEvent/pid` | `target.process.pid` | Target process PID. |
| `alert.event_values.urlMonitorEvent/hostname` | `target.hostname` | Target destination hostname. |
| `alert.event_values.urlMonitorEvent/requestUrl` | `target.url` | Target request URL. |
| `alert.event_values.urlMonitorEvent/urlMethod` | `network.http.method` | Network HTTP method. |
| `alert.event_values.urlMonitorEvent/userAgent` | `network.http.user_agent` | Network HTTP user agent. |
| `alert.indicator.name` | `read_only_udm.security_result.summary` | Security result summary. |
| `host.agent_version` | `read_only_udm.metadata.product_version` | Product version mapping. |
| `host.containment_state` | `read_only_udm.principal.containment_state` | Principal containment state. |
| `host.hostname` | `read_only_udm.principal.hostname` | Principal hostname. |
| `host.os.platform` | `read_only_udm.principal.platform` | Principal OS platform. |
| `host.primary_ip_address` | `read_only_udm.principal.ip` | Principal primary IP. |
| `severity` | `security_result.severity` | Mapped to **LOW** , **MEDIUM** , or **HIGH**. |
| `timestamp` | `timestamp` | Raw log timestamp. |

## Change Log

[View the Change Log for this parser](https://docs.cloud.google.com/chronicle/docs/ingestion/parser-list/fireeye-hx-audit-changelog)

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