Collect Digi Modems logs

Supported in:

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

Digi Modems are industrial cellular modems that generate syslog messages for login events, authentication attempts, and network connections. The parser extracts fields 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 Digi modem
  • If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
  • Privileged access to Digi Remote Manager or local Digi Modem web UI

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

service:
    pipelines:
        logs/digi_modems_to_chronicle:
            receivers:
                - udplog
            exporters:
                - chronicle/digi_modems

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 the syslog server on Digi Modem

  1. Sign in to the Digi Remote Manager, or the local Digi Modem web UI.
  2. Access the device configuration with Remote Manager:
    • Locate the device you want to configure syslog for.
    • Click Device ID > Settings > Config.
  3. Access the device configuration with local Digi Modem web UI:
    • Click System > Configuration > Device Configuration.
  4. Go to System > Log.
  5. Click to expand Server list.
  6. Click Add Server +.
  7. Provide the following configuration details:
    • Server: Enter the Bindplane agent IP address.
    • Select the event categories that will be sent to the server (all event categories are enabled by default).
    • Syslog egress Port: Enter the Bindplane agent port number (default is 514).
    • Protocol: Select UDP.
  8. Click Apply.

Supported Digi modems sample logs

  • SYSLOG

    {
  "priority": 14,
  "timestamp": "Dec 28 17:27:45",
  "hostname": "host-device.router",
  "tag": "Eventlog",
  "message": "17:27:33, 28 Dec 2006,Login failure by Host: 10.0.0.25:23: CMD,Telnet"
}

  • SYSLOG

    {
  "priority": 14,
  "timestamp": "May 25 11:03:55",
  "hostname": "internal-srv-01",
  "tag": "Eventlog",
  "message": "11:03:55, 25 May 2023,Login failure by sanitized_user: WEB"
}

  • SYSLOG

    {
  "priority": 14,
  "timestamp": "Jun 11 23:58:26",
  "hostname": "internal-srv-01",
  "tag": "Eventlog",
  "message": "23:58:26, 11 Jun 2023,Login failure by GET /masked_path HTTP/1.0: CMD,Telnet"
}

  • SYSLOG

    {
  "priority": 14,
  "timestamp": "Jun 19 19:52:19",
  "hostname": "gateway-device-02",
  "tag": "Eventlog",
  "message": "19:52:18, 19 Jun 2023,WEB Login OK by internal_admin lvl 0"
}

UDM mapping table

Log field UDM mapping Logic
content security_result.description Directly mapped from the content field after initial grok parsing.
http_method network.http.method Extracted from the content field using a grok pattern.
http_version network.application_protocol_version Extracted from the content field using a grok pattern.
hostname principal.hostname Extracted from the log message using a grok pattern.
ip target.ip Extracted from the content field using a grok pattern.
port target.port Extracted from the content field using a grok pattern and converted to an integer.
proto network.application_protocol Extracted from the content field using a grok pattern.
ts metadata.event_timestamp Extracted from the log message using a grok pattern and converted to a timestamp.
type login_type_label.value Extracted from the content field using a grok pattern.
extensions.auth.type Set to MACHINE by parser logic.
login_type_label.key Set to Login type by parser logic.
metadata.event_type Determined by the presence of specific fields like ip or user and set accordingly to NETWORK_CONNECTION or USER_LOGIN.
metadata.log_type Set to DIGI_MODEMS by parser logic.
metadata.product_event_type Extracted from the product_type field in the log message.
metadata.product_name Set to DIGI_MODEMS by parser logic.
metadata.vendor_name Set to DIGI_MODEMS by parser logic.
security_result.action Determined by the presence of Login OK or Login failure in the message and set to ALLOW or BLOCK respectively.
user target.user.userid Extracted from the content field using a grok pattern.

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