# Collect Akeyless Vault logs

**Parser Version:** 2.0
Supported in:

This document explains how to ingest Akeyless Vault logs to Google Security Operations using Bindplane.

Akeyless Vault is a cloud-native secrets management platform that provides centralized access to credentials, certificates, and encryption keys. It uses a patented Distributed Fragments Cryptography (DFC) technology that ensures secrets are never stored in a single location, providing zero-knowledge security across hybrid and multi-cloud environments.

## 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 Akeyless Gateway
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Privileged access to the Akeyless Gateway web UI with administrator permissions

## 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" /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](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:**

      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:
        udplog:
          listen_address: "0.0.0.0:514"

      exporters:
        chronicle/akeyless_vault:
          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: '<PLACEHOLDER_CREDS_FILE_PATH>'
          customer_id: '<PLACEHOLDER_CUSTOMER_ID>'
          endpoint: chronicle.googleapis.com
          log_type: AKEYLESS_VAULT
          raw_log_field: body
          ingestion_labels:
            env: production

      service:
        pipelines:
          logs/akeyless_to_chronicle:
            receivers:
              - udplog
            exporters:
              - chronicle/akeyless_vault

### Configuration parameters

Replace the following placeholders:

- **Receiver configuration:**

  - `udplog`: UDP syslog receiver for Akeyless Gateway log forwarding
  - `0.0.0.0:514`: IP address and port to listen on. Replace the port as required in your infrastructure
- **Exporter configuration:**

  - `<PLACEHOLDER_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`
  - `<PLACEHOLDER_CUSTOMER_ID>`: Google SecOps customer ID
  - `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`.

### 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/akeyless_vault:
          compression: gzip
          creds_file_path: '<PLACEHOLDER_CREDS_FILE_PATH>'
          customer_id: '<PLACEHOLDER_CUSTOMER_ID>'
          endpoint: malachiteingestion-pa.googleapis.com
          log_type: AKEYLESS_VAULT
          raw_log_field: body
          ingestion_labels:
            env: production

> [!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 syslog forwarding in Akeyless Vault

1. Sign in to your **Akeyless Gateway** web UI.
2. Go to **Log Forwarding**.
3. Select the **Enable** checkbox.
4. Choose the log format - select **JSON**.
5. In the **Audit Log Server** field, enter `https://audit.akeyless.io/`.
6. From the **Log Service** dropdown list, select **Syslog**.
7. Provide the following configuration details:
   - **Syslog Network** : Select the network protocol used by the Bindplane agent (for example, **UDP**).
   - **Syslog Host** : Enter the hostname or IP address of the Bindplane agent host (for example, `192.168.1.100:514`).
   - **Syslog Tag** : (Optional) Enter the tag for audit logs. The default value is `audit-export`.
   - **Syslog Formatter** : Select **Text** or **CEF**.
   - **TLS** : (Optional) Select the **TLS** checkbox and upload the **TLS Certificate** of your log server if TLS encryption is required.
8. Click **Save Changes**.

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
| `access_id` | `metadata.product_log_id` | Directly mapped from `access_id` field. If not present, extracted from the message field using regex. |
| `account_id` | `target.user.userid` | Directly mapped from `account_id` field. |
| `action` | `security_result.action_details` | Directly mapped from `action` field. |
| `component` | `target.resource.name` | Directly mapped from `component` field. |
| `duration` | `network.session_duration.seconds` | Directly mapped from `duration` field and converted to integer. |
| `remote_addr` | `principal.ip` | Extracted from `remote_addr` field, split by comma and added to the `principal.ip` array. |
| `request_parameters.access_type` | `target.resource.attribute.labels` (key: `access_type`) | Directly mapped from `request_parameters.access_type` field. If not present, extracted from the message field using regex. |
| `request_parameters.comment` | `target.resource.attribute.labels` (key: `comment`) | Directly mapped from `request_parameters.comment` field. |
| `request_parameters.operation` | `target.resource.attribute.labels` (key: `operation`) | Directly mapped from `request_parameters.operation` field. |
| `request_parameters.product` | `target.resource.attribute.labels` (key: `product`) | Directly mapped from `request_parameters.product` field. If not present, extracted from the message field using regex. |
| `request_parameters.token_id` | `target.resource.attribute.labels` (key: `token_id`) | Directly mapped from `request_parameters.token_id` field. |
| `request_parameters.transaction_type` | `target.resource.attribute.labels` (key: `transaction_type`) | Directly mapped from `request_parameters.transaction_type` field and converted to string. If not present, extracted from the message field using regex. |
| `request_parameters.unique_id` | `target.resource.attribute.labels` (key: `unique_id`) | Directly mapped from `request_parameters.unique_id` field. If not present, extracted from the message field using regex. |
| `request_parameters.universal_identity_rotate_type` | `target.resource.attribute.labels` (key: `universal_identity_rotate_type`) | Directly mapped from `request_parameters.universal_identity_rotate_type` field. |
| `request_parameters.user_agent` | `target.resource.attribute.labels` (key: `user_agent`) | Directly mapped from `request_parameters.user_agent` field. |
| `severity` | `security_result.severity` | Mapped from `severity` field: `Info` to `INFORMATIONAL`, `Error` to `ERROR`, `Warning` to `MEDIUM`, otherwise `UNKNOWN_SEVERITY`. |
| `status` | `network.http.response_code` | Directly mapped from `status` field and converted to integer. |
| `timestamp` | `metadata.event_timestamp` | Directly mapped from the log entry timestamp field. |
| N/A | `metadata.log_type` | Hardcoded to `AKEYLESS_VAULT`. |
| N/A | `metadata.event_type` | Set to `STATUS_UPDATE` if IP is present, otherwise defaults to `GENERIC_EVENT`. |
| N/A | `metadata.vendor_name` | Extracted from the message field using CEF regex pattern. |
| N/A | `metadata.product_name` | Extracted from the message field using CEF regex pattern. |
| N/A | `metadata.product_version` | Extracted from the message field using CEF regex pattern. |
| N/A | `metadata.product_event_type` | Extracted from the message field using syslog header regex pattern. |
| N/A | `target.namespace` | Extracted from the message field using regex. |
| `action` | `network.http.method` | Mapped from `action` field: `get` to `GET`, `put` and `Authentication` to `PUT`, `post` to `POST`, `delete` to `DELETE`. |
| `remote_addr` | `event.idm.read_only_udm.intermediary.ip` | Mapped from changelog |
| `syslog_hostname` | `event.idm.read_only_udm.observer.hostname` | Mapped from changelog |
| `process_name` | `event.idm.read_only_udm.observer.application` | Mapped from changelog |
| `pid` | `event.idm.read_only_udm.observer.process.pid` | Mapped from changelog |
| `severity` | `event.idm.read_only_udm.security_result.severity` | Mapped from changelog |
| `request_parameters.unique_id` | `event.idm.read_only_udm.principal.user.email_addresses` | Mapped from changelog |
| `item_type` | `event.idm.read_only_udm.target.resource.resource_subtype` | Mapped from changelog |
| `request_parameters.session_id` | `event.idm.read_only_udm.network.session_id` | Mapped from changelog |
| `duration_in_ms` | `event.idm.read_only_udm.target.resource.attribute.labels` | Mapped from changelog |
| `request_parameters.source` | `event.idm.read_only_udm.target.resource.attribute.labels` | Mapped from changelog |
| `request_parameters.item_accessibility` | `event.idm.read_only_udm.target.resource.attribute.labels` | Mapped from changelog |
| `remote_addr array` | `principal.ip` | Mapped from changelog |

## Change Log

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

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