Collect Avaya Aura logs

Supported in:

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

Avaya Aura is a unified communications platform that generates syslog messages for user login/logout events, system configuration changes, and security events. The parser extracts fields from syslog messages using grok patterns 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 Avaya Aura system
  • If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
  • Privileged access to Avaya Aura

Get Google SecOps ingestion authentication file

  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.

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.

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.

Configure the Bindplane agent to ingest syslog and send to Google SecOps

Locate the configuration file

  • Linux:

    sudo nano /etc/bindplane-agent/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/avaya_aura:
            compression: gzip
            creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
            customer_id: '<customer_id>'
            endpoint: malachiteingestion-pa.googleapis.com
            log_type: AVAYA_AURA
            raw_log_field: body
    
    service:
        pipelines:
            logs/avaya_aura_to_chronicle:
                receivers:
                    - udplog
                exporters:
                    - chronicle/avaya_aura
    

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 ingestion authentication file:
      • Linux: /etc/bindplane-agent/ingestion-auth.json
      • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
    • customer_id: Customer ID copied from the Google SecOps console
    • endpoint: Regional endpoint URL:
      • US: malachiteingestion-pa.googleapis.com
      • Europe: europe-malachiteingestion-pa.googleapis.com
      • Asia: asia-southeast1-malachiteingestion-pa.googleapis.com
      • See Regional Endpoints for complete list

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 Avaya Aura

  1. Sign in to the Avaya Aura console.
  2. Go to EM > System Configuration > Logging Settings > Syslog.
  3. Enable SYSLOG Delivery of Logs.
  4. Click Add.
  5. Provide the following configuration details:
    • Server Address: Enter the Bindplane agent IP address.
    • Port: Enter the Bindplane agent listening port.
  6. Click Save.
  7. Click Confirm.
  8. Restart Avaya Aura.

UDM mapping table

Log field UDM mapping Logic
data{}.@timestamp metadata.event_timestamp The event timestamp is parsed from the data field using the grok pattern and assigned to the event_timestamp field in the metadata section of the UDM.
data{}.host principal.hostname The host value is extracted from the data field using the grok pattern and assigned to the hostname field within the principal section of the UDM.
data{}.portal security_result.about.resource.attribute.labels.value The portal value is extracted from the data field using the grok pattern and assigned as the value of the Portal label within the about.resource.attribute.labels section of the security_result in the UDM.
data{}.prod_log_id metadata.product_log_id The prod_log_id value is extracted from the data field using the grok pattern and assigned to the product_log_id field in the metadata section of the UDM.
data{}.sec_cat security_result.category_details The sec_cat value is extracted from the data field using the grok pattern and assigned to the category_details field within the security_result section of the UDM.
data{}.sec_desc security_result.description The sec_desc value is extracted from the data field using the grok pattern and assigned to the description field within the security_result section of the UDM.
data{}.severity security_result.severity The severity value is extracted from the data field using the grok pattern. If the severity is warn, fatal, or error (case-insensitive), it is mapped to HIGH in the security_result.severity field of the UDM. Otherwise, if the severity is info (case-insensitive), it is mapped to LOW.
data{}.summary security_result.summary The summary value is extracted from the data field using the grok pattern and assigned to the summary field within the security_result section of the UDM.
data{}.user_id target.user.userid The user_id value is extracted from the data field using the grok pattern and assigned to the userid field within the target.user section of the UDM.
extensions.auth.type The auth.type field is set to AUTHTYPE_UNSPECIFIED if the event_name field contains log(in|on) or logoff (case-insensitive), or if the summary field contains login or logoff (case-insensitive) and the user_id field is not empty.
metadata.description The description field is populated with the value of the desc field if it is not empty.
metadata.event_type The event_type field is determined based on the following logic: - If the event_name field contains log(in|on) or the summary field contains login (case-insensitive) and the user_id field is not empty, the event_type is set to USER_LOGIN. - If the event_name field contains logoff or the summary field contains logoff (case-insensitive) and the user_id field is not empty, the event_type is set to USER_LOGOUT. - If the has_principal field is true, the event_type is set to STATUS_UPDATE. - Otherwise, the event_type remains as GENERIC_EVENT (default value).
metadata.log_type The log_type is hardcoded to AVAYA_AURA.
metadata.product_event_type The product_event_type field is populated with the value of the event_name field if it is not empty.
metadata.product_name The product_name is hardcoded to AVAYA AURA.
metadata.vendor_name The vendor_name is hardcoded to AVAYA AURA.
security_result.action The action field within the security_result section is set based on the following logic: - If the summary field contains fail or failed (case-insensitive), the action is set to BLOCK. - If the summary field contains success (case-insensitive), the action is set to ALLOW.
security_result.severity_details The severity_details field is populated with the value of the severity_details field if it is not empty.
timestamp.nanos metadata.event_timestamp.nanos The nanos value from the timestamp field is directly mapped to the nanos field within the event_timestamp section of the metadata in the UDM.
timestamp.seconds metadata.event_timestamp.seconds The seconds value from the timestamp field is directly mapped to the seconds field within the event_timestamp section of the metadata in the UDM.

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