Collect VyOS logs

Supported in:

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

VyOS is an open source network router that generates syslog messages for firewall events, routing changes, VPN connections, and system events.

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 VyOS router
  • If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
  • SSH access to the VyOS router with administrative privileges

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 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 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/vyos:
        compression: gzip
        creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: VYOS
        raw_log_field: body

service:
    pipelines:
        logs/vyos_to_chronicle:
            receivers:
                - udplog
            exporters:
                - chronicle/vyos

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 VyOS

  1. Connect to the VyOS router using SSH.

  2. Enter configuration mode:

    configure

  3. Configure the remote syslog host (replace <bindplane-ip> with your Bindplane agent IP address):

    set system syslog host <bindplane-ip> facility all level info
set system syslog host <bindplane-ip> port 514
set system syslog host <bindplane-ip> protocol udp

  4. Commit and save the configuration:

    commit
save

UDM mapping table

Log Field UDM Mapping Logic
clientIp principal.ip Client IP address extracted from the DHCP message.
clientMac principal.mac Client MAC address extracted from the DHCP message.
datetime metadata.event_timestamp The timestamp extracted from the log message.
dst_ipaddress target.ip Destination IP address extracted from the log message.
hostname observer.hostname Hostname extracted from the log message. Determined by the parser based on the process and other fields. Can be GENERIC_EVENT, NETWORK_CONNECTION, NETWORK_DHCP, or STATUS_UPDATE. Hardcoded to "VYOS".
msg metadata.description The original message from the log, or a portion of it, depending on the parsing logic. Set to "DHCP Event" if the process is "dhcpd". Hardcoded to "VYOS DHCP". Hardcoded to "VYOS".
network.dhcp.chaddr network.dhcp.chaddr Client MAC address extracted from DHCP messages.
network.dhcp.ciaddr network.dhcp.ciaddr Client IP address in a DHCPREQUEST message. DHCP message opcode. Set to "BOOTREQUEST" for DHCPREQUEST and DHCPINFORM, "BOOTREPLY" for DHCPACK and DHCPNAK. DHCP message type. Derived from eventType and can be REQUEST, ACK, INFORM, NAK, or OFFER.
network.dhcp.yiaddr network.dhcp.yiaddr Your (client) IP address in a DHCPACK or DHCPOFFER message. Set to "DHCP" if the process is "dhcpd".
pri_host principal.hostname Hostname associated with a client in DHCP messages.
rem_msg metadata.description Remaining part of the message after initial parsing, used for description in some cases.
src_ipaddress principal.ip Source IP address extracted from the log message.
timestamp event.timestamp The timestamp of the log entry.

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