Collect Commvault logs

Parser Version: 3.0

Supported in:

Google SecOps SIEM

This document explains how to ingest Commvault logs to Google Security Operations using the Bindplane agent.

Commvault generates syslog messages for backup operations, alerts, events, and system activities. The parser extracts fields from the log messages and maps them to the Unified Data Model (UDM).

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 Commvault system
• If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
• Privileged access to the Commvault 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 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 the 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 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/commvault:
      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: '<customer_id>'
      endpoint: chronicle.googleapis.com
      log_type: COMMVAULT
      raw_log_field: body
  
  service:
    pipelines:
      logs/commvault_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/commvault
  

Configuration parameters

Replace the following placeholders:

• Receiver configuration:

  • listen_address: IP address and port to listen on:
    • 0.0.0.0 to listen on all interfaces (recommended)
    • Port 514 is the standard syslog port (requires root on Linux; use 1514 for non-root)

• 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: Customer ID copied from the Google SecOps console
  • 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.

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/commvault:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: COMMVAULT
      raw_log_field: body
  

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 syslog in Commvault Cloud

1. Sign in to the Commvault Management Console.
2. Go to Manage > System.
3. Click the SIEM connector tile.
4. Click Add connector.
5. On the General tab, enter the following details:
   • Connector name: Enter a name for the connector.
   • Connector type: Select Syslog.
   • Streaming data: Select the data that you want to export.
6. Click Next.
7. On the Connector Definition tab, click Add syslog server.
8. Provide the following configuration details:
   • Syslog server: Enter the Bindplane agent IP address.
   • Port number: Enter the Bindplane agent port number.

9. Click Submit.

   Note: Custom ports are not allowed on the GUI due to security restrictions. Although the interface allows entering any port, only the default ports are permitted: UDP Port: 514 and TCP Port: 6514.

UDM mapping table

Log Field	UDM Mapping	Logic
AgentType	event.idm.read_only_udm.observer.application	Value taken from AgentType field in the log message.
Alertid	event.idm.read_only_udm.security_result.detection_fields.value	Value taken from Alertid field in the log message. This field is mapped under the alert_id key.
Alertname	event.idm.read_only_udm.security_result.detection_fields.value	Value taken from Alertname field in the log message. This field is mapped under the alert_name key.
Alertseverity	event.idm.read_only_udm.security_result.severity	This field is used to populate the security_result.severity field based on its value.
Alerttime	event.idm.read_only_udm.metadata.event_timestamp	Value taken from Alerttime field in the log message and converted to a timestamp.
BackupLevel	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from BackupLevel field in the log message. This field is mapped under the backup_level key.
BackupSet	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from BackupSet field in the log message. This field is mapped under the backup_set key.
Client	event.idm.read_only_udm.principal.hostname	Value taken from Client field in the log message.
CommCell	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from CommCell field in the log message. This field is mapped under the comcell_field key.
Computer	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from Computer field in the log message. This field is mapped under the computer_field key.
Description	event.idm.read_only_udm.metadata.description	Value taken from Description field in the log message after some processing and cleanup.
DetectedCriteria	event.idm.read_only_udm.security_result.detection_fields.value	Value taken from DetectedCriteria field in the log message. This field is mapped under the detected_criteria key.
DetectedTime	event.idm.read_only_udm.security_result.detection_fields.value	Value taken from DetectedTime field in the log message. This field is mapped under the detected_time key.
Details	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from Details field in the log message. This field is mapped under the details_field key.
Eventid	event.idm.read_only_udm.metadata.product_log_id	Value taken from Eventid field in the log message.
Eventseverity	event.idm.read_only_udm.security_result.severity	This field is used to populate the security_result.severity field based on its value.
Failure	event.idm.read_only_udm.security_result.detection_fields.value	Value taken from Failure field in the log message. This field is mapped under the failure_filed key.
Instance	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from Instance field in the log message. This field is mapped under the instance_field key.
Jobid	event.idm.read_only_udm.principal.process.pid	Value taken from Jobid field in the log message.
MonitoringCriteria	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from MonitoringCriteria field in the log message. This field is mapped under the monitoring_criteria key.
Occurencetime	event.idm.read_only_udm.metadata.event_timestamp	Value taken from Occurencetime field in the log message and converted to a timestamp.
Opid	event.idm.read_only_udm.security_result.detection_fields.value	Value taken from Opid field in the log message. This field is mapped under the op_id key.
Program	event.idm.read_only_udm.principal.application	Value taken from Program field in the log message.
Severitylevel	event.idm.read_only_udm.security_result.severity	Value taken from Severitylevel field in the log message and mapped based on a predefined mapping.
StoragePoliciesUsed	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from StoragePoliciesUsed field in the log message. This field is mapped under the storage_policies_used key.
Subclient	event.idm.read_only_udm.additional.fields.value.string_value	Value taken from Subclient field in the log message. This field is mapped under the subclient_field key.
Type	event.idm.read_only_udm.security_result.detection_fields.value	Value taken from Type field in the log message. This field is mapped under the alert_type key.
Username	event.idm.read_only_udm.principal.user.userid	Value taken from Username field in the log message.
anomaly_type	event.idm.read_only_udm.security_result.detection_fields.value	Value extracted from the Description field using grok patterns. This field is mapped under the detected_anomaly_type key.
errors	event.idm.read_only_udm.security_result.detection_fields.value	Value extracted from the Description field using grok patterns. This field is mapped under the errors_field key.
file_name	event.idm.read_only_udm.security_result.detection_fields.value	Value extracted from the Description field using grok patterns. This field is mapped under the detected_malicious_file key.
media_agent	event.idm.read_only_udm.security_result.detection_fields.value	Value extracted from the Description field using grok patterns. This field is mapped under the detected_media_agent key.
no_of_files_created	event.idm.read_only_udm.security_result.detection_fields.value	Value extracted from the Description field using grok patterns. This field is mapped under the no_of_files_created_field key.
no_of_files_deleted	event.idm.read_only_udm.security_result.detection_fields.value	Value extracted from the Description field using grok patterns. This field is mapped under the no_of_files_deleted_field key.
no_of_files_modified	event.idm.read_only_udm.security_result.detection_fields.value	Value extracted from the Description field using grok patterns. This field is mapped under the no_of_files_modified_field key.
no_of_files_renamed	event.idm.read_only_udm.security_result.detection_fields.value	Value extracted from the Description field using grok patterns. This field is mapped under the no_of_files_renamed_field key.
URL	event.idm.read_only_udm.network.http.referral_url	Value extracted from the Description field using grok patterns.
	event.idm.read_only_udm.metadata.event_type	This field is set to STATUS_UPDATE if the Client field is present, otherwise it's set to GENERIC_EVENT.
	event.idm.read_only_udm.metadata.product_name	This field is set to COMMVAULT.
	event.idm.read_only_udm.metadata.vendor_name	This field is set to COMMVAULT.
	event.idm.read_only_udm.principal.user.user_role	This field is set to ADMINISTRATOR if the User field is Administrator.
Commcellname	additional.fields	Mapped from changelog
Operation	metadata.description	Mapped from changelog
Companyname	principal.user.company_name	Mapped from changelog
machine_name	principal.hostname	Mapped from changelog
locale	additional.fields	Mapped from changelog

Change Log

View the Change Log for this parser

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