# Collect Hitachi Content Platform logs

Supported in:

This document explains how to ingest Hitachi Content Platform logs to Google Security Operations using Bindplane.

Hitachi Content Platform (HCP) is a distributed object storage system designed to support large, growing repositories of fixed-content data. HCP provides secure storage with features including data protection, compliance retention, versioning, and multi-protocol access through REST APIs, NFS, CIFS, and WebDAV. The platform supports multi-tenancy with namespace isolation and includes comprehensive system monitoring and logging capabilities.

## 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 Hitachi Content Platform
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- System-level user account with administrator or security role in HCP. The monitor or compliance role can view the Syslog page but cannot configure syslog logging or test connections
- Access to the HCP System Management Console

## 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/hcp:
          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: HITACHI_CLOUD_PLATFORM
          raw_log_field: body
          ingestion_labels:
            env: production

      service:
        pipelines:
          logs/hcp_to_chronicle:
            receivers:
              - udplog
            exporters:
              - chronicle/hcp

### Configuration parameters

Replace the following placeholders:

- **Receiver configuration:**

  - The receiver is configured as `udplog` to listen for UDP syslog messages on port 514.
  - `listen_address: "0.0.0.0:514"` listens on all interfaces on port 51. If port 514 requires root privileges on Linux, use port 1514 instead and configure HCP to send to that port.
- **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`
  - `customer_id`: Replace `YOUR_CUSTOMER_ID` with the 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`: Set to `HITACHI_CLOUD_PLATFORM` exactly as shown.
  - `ingestion_labels`: Optional labels in YAML format (for example, `env: production`).

### 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/hcp:
          compression: gzip
          creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
          customer_id: 'YOUR_CUSTOMER_ID'
          endpoint: malachiteingestion-pa.googleapis.com
          log_type: HITACHI_CLOUD_PLATFORM
          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, 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 Hitachi Content Platform syslog forwarding

1. Sign in to the **HCP System Management Console** using an account with administrator or security role.
2. In the top-level menu, select **Monitoring \> Syslog**.
3. In the **Syslog Server IP Addresses** field, enter the IP address of the Bindplane agent host, optionally followed by a colon and port number (for example, `192.168.1.100:514` or `192.168.1.100:1514`). If you omit the port number, HCP uses port 514 by default.
4. Click **Add**. The specified IP address moves into the list below the field.
5. In the **Send log messages at this level or higher** field, select the severity level of messages to be sent to the syslog server:
   - **NOTICE**: Sends messages with a severity level of Notice, Warning, or Error.
   - **WARNING**: Sends messages with a severity level of Warning or Error.
   - **ERROR**: Sends only messages with a severity level of Error.
6. In the **HTTP access Facility** field, select the syslog local facility to which to direct HTTP access log messages. The options are **local0** through **local7**.
7. To include log messages about HTTP-based data access events, select **Send log messages for HTTP-based data access requests**.
8. In the **MAPI access Facility** field, select the syslog local facility to which to direct management API log messages. The options are **local0** through **local7**.
9. To include log messages about management API request events, select **Send log messages for management API requests**.
10. To include log messages about security events (attempts to log into the System Management Console with an invalid username), select the option to send security events if available.
11. Click **Update Settings** to save the configuration.
12. To test the connection, click **Test** on the Syslog page. HCP sends a test message with severity level Notice to the syslog server. Check the Bindplane agent logs to verify the message was received.

    > [!NOTE]
    > **Note:** Each syslog server IP address must be routable from the HCP system network. When you specify multiple servers, HCP sends log messages to all of the specified servers.

## UDM mapping table

| Log Field | UDM Mapping | Logic |
|---|---|---|
| host_name | intermediary.hostname | Hostname of the intermediary device |
| event_type | metadata.event_type | Type of event (e.g., USER_LOGIN, NETWORK_CONNECTION) |
| product_event | metadata.product_event_type | Product-specific event type |
|   | network.application_protocol | Application protocol used (e.g., HTTP, HTTPS) |
| http_method | network.http.method | HTTP method (e.g., GET, POST) |
| url | network.http.referral_url | Referral URL for HTTP requests |
| response_code | network.http.response_code | HTTP response code |
| src_ip | principal.ip | Source IP address of the connection |
|   | metadata.product_name | Product name |
|   | metadata.vendor_name | Vendor/company name |

## Change Log

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

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