Collect Yamaha router logs

Supported in:

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

YAMAHA Router RTX1200 is a network router that generates syslog messages for firewall events, NAT translations, routing changes, and VPN connections.

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 YAMAHA router
  • If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
  • SSH or console access to the YAMAHA router CLI

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 Bindplane 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 IDfrom the Organization Detailssection.

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 Promptor PowerShellas 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 .

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

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 on YAMAHA router

  1. SSH or connect to the YAMAHA router CLI.
  2. Run the following commands (replace <bindplane-ip> with your Bindplane agent IP address):

     syslog host <bindplane-ip>
    syslog facility local0
    syslog notice on
    save 
    

UDM mapping table

Log Field UDM Mapping Logic
data
metadata.description The description is extracted from the data field of the raw log using grok patterns. Different patterns are used depending on the format of the log message. Examples: "initiate ISAKMP phase", "Connection closed", "succeeded for SSH".
data
metadata.event_timestamp The timestamp is extracted from the data field of the raw log using grok patterns and then converted to a timestamp object using the date filter. The MMM dd HH:mm:ss and MMM d HH:mm:ss formats are supported.
data
principal.asset.hostname The hostname is extracted from the data field of the raw log using grok patterns.
data
principal.asset.ip The principal IP address is extracted from the data field of the raw log using grok patterns. It is mapped to both principal.asset.ip and principal.ip .
data
principal.hostname The hostname is extracted from the data field of the raw log using grok patterns.
data
principal.ip The principal IP address is extracted from the data field of the raw log using grok patterns. It is mapped to both principal.asset.ip and principal.ip .
data
principal.user.userid The user ID is extracted from the data field of the raw log using grok patterns.
data
target.asset.ip The target IP address is extracted from the data field of the raw log using grok patterns.
data
target.ip The target IP address is extracted from the data field of the raw log using grok patterns. The event type is determined by the parser logic based on the presence of certain fields. If both principal and target are present, the event type is NETWORK_CONNECTION . If user is present, the event type is USER_UNCATEGORIZED . If only principal is present, the event type is STATUS_UPDATE . Otherwise, it defaults to GENERIC_EVENT . Hardcoded to "YAMAHA_ROUTER". Hardcoded to "YAMAHA_ROUTER". Hardcoded to "YAMAHA_ROUTER".
log_type
metadata.log_type Copied directly from the log_type field of the raw log.
timestamp
timestamp This is the ingestion time of the log and is added automatically by the Chronicle platform. It's not parsed from the raw log.

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

Design a Mobile Site
View Site in Mobile | Classic
Share by: