Collect LinkShadow NDR logs
This document explains how to ingest LinkShadow NDR logs to Google Security Operations using the Bindplane agent.
LinkShadow NDR is an AI-powered network detection and response platform that analyzes network traffic to detect threats. It generates alerts for anomalous behavior, lateral movement, and data exfiltration. LinkShadow NDR outputs logs in CEF (Common Event Format), which includes fields such as device vendor, event class ID, severity, source/destination IPs and ports, user identifiers, and threat descriptions.
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 LinkShadow NDR
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Privileged access to the LinkShadow NDR management console with administrator permissions
Get Google SecOps ingestion authentication file
- Sign in to the Google SecOps console.
- Go to SIEM Settings > Collection Agents.
- Download the Ingestion Authentication File.
Save the file securely on the system where Bindplane will be installed.
Get Google SecOps customer ID
- Sign in to the Google SecOps console.
- Go to SIEM Settings > Profile.
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
- Open Command Prompt or PowerShell as an administrator.
Run the following command:
msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quietWait for the installation to complete.
Verify the installation by running:
sc query observiq-otel-collectorThe service should show as RUNNING.
Linux installation
- Open a terminal with root or sudo privileges.
Run the following command:
sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.shWait for the installation to complete.
Verify the installation by running:
sudo systemctl status observiq-otel-collectorThe 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.yamlWindows:
notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
Edit the configuration file
Replace the entire contents of
config.yamlwith the following configuration:receivers: tcplog: listen_address: "0.0.0.0:514" exporters: chronicle/linkshadow_ndr: compression: gzip creds_file_path: '/etc/bindplane-agent/ingestion-auth.json' customer_id: '<customer_id>' endpoint: malachiteingestion-pa.googleapis.com log_type: LINKSHADOW_NDR raw_log_field: body ingestion_labels: env: production service: pipelines: logs/linkshadow_to_chronicle: receivers: - tcplog exporters: - chronicle/linkshadow_ndr
Configuration parameters
Replace the following placeholders:
Receiver configuration:
tcplog: The receiver type based on protocol:udplogfor UDP syslogtcplogfor TCP syslog
0.0.0.0: IP address to listen on:0.0.0.0to listen on all interfaces (recommended)- Specific IP address to listen on one interface
514: Port number to listen on (for example,514,1514,6514)
Exporter configuration:
linkshadow_ndr: Descriptive name for the exportercreds_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
- Linux:
<customer_id>: Customer ID from the previous stependpoint: 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
- US:
LINKSHADOW_NDR: Log type exactly as it appears in Chronicleingestion_labels: Optional labels in YAML format (for example,env: production)
Pipeline configuration:
linkshadow_to_chronicle: Descriptive name for the pipeline
Save the configuration file
- After editing, save the file:
- Linux: Press
Ctrl+O, thenEnter, thenCtrl+X - Windows: Click File > Save
- Linux: Press
Restart the Bindplane agent to apply the changes
To restart the Bindplane agent in Linux, run the following command:
sudo systemctl restart observiq-otel-collectorVerify the service is running:
sudo systemctl status observiq-otel-collectorCheck 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-collectorServices console:
- Press
Win+R, typeservices.msc, and press Enter. - Locate observIQ OpenTelemetry Collector.
- Right-click and select Restart.
Verify the service is running:
sc query observiq-otel-collectorCheck logs for errors:
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
- Press
Configure LinkShadow NDR syslog forwarding
- Sign in to the LinkShadow NDR management console as an administrator.
- Navigate to Settings > SIEM Integration.
Under the syslog forwarding section, configure the following:
Setting Value Syslog Server IP Enter the IP address of the Bindplane agent host Syslog Port Enter the port matching the Bindplane agent receiver configuration (for example, 514)Protocol Select TCP or UDP to match the Bindplane receiver type Log Format Select CEF (Common Event Format) Select the event categories to forward, such as:
- Network anomaly alerts
- Lateral movement detections
- Data exfiltration alerts
- User behavior analytics events
Click Save or Apply to activate the syslog forwarding configuration.
Verify that logs are being received by checking the Bindplane agent logs.
UDM mapping table
| Log Field | UDM Mapping | Logic |
|---|---|---|
| fileHash | about.file.full_path | Set if does not match hash regex |
| fileHash | about.file.sha256 | Renamed if matches hash regex |
| cn1, cn1Label, cn2, cn2Label, cs3, cs3Label, cs4, cs4Label, cs5, cs5Label, cs6, cs6Label, cat, externalId, smac | additional.fields | Merged key-value pairs from cn/cnLabel etc., cat/externalId as labels, and smac as label if not valid MAC |
| dvc | intermediary.ip | Extracted as IP and merged |
| msg | metadata.description | Value copied directly |
| src, dst, suser, duser | metadata.event_type | Set to NETWORK_CONNECTION if has_principal and has_target true, else USER_UNCATEGORIZED if has_principal_user or has_target_user true, else STATUS_UPDATE if has_principal true, else GENERIC_EVENT |
| device_event_class_id, event_name | metadata.product_event_type | Concatenated as "[device_event_class_id] - event_name" if both present, else device_event_class_id if present, else event_name |
| device_version | metadata.product_version | Value copied directly |
| device_product | metadata.product_name | Value copied directly |
| device_vendor | metadata.vendor_name | Value copied directly |
| requestMethod | network.http.method | Value copied directly |
| src | principal.asset.ip | Extracted as IP and merged |
| src | principal.ip | Extracted as IP and merged |
| smac | principal.mac | Extracted as MAC and merged if valid |
| spt | principal.port | Converted to integer |
| suser | principal.user.userid | Value copied directly |
| reason | security_result.description | Value copied directly |
| severity | security_result.severity | Set to INFORMATIONAL if "0", LOW if "2", MEDIUM if "5", HIGH if "7", CRITICAL if "10" |
| severity | security_result.severity_details | Value copied directly |
| destinationDnsDomain | target.administrative_domain | Value copied directly |
| requestClientApplication | target.application | Value copied directly |
| dst | target.asset.ip | Parsed as JSON array, extracted IPs and merged |
| fname | target.file.full_path | Value copied directly |
| fileType | target.file.mime_type | Value copied directly |
| dst | target.ip | Parsed as JSON array, extracted IPs and merged |
| dpt | target.port | Converted to integer |
| request | target.url | Value copied directly |
| duser | target.user.userid | Value copied directly |
Need more help? Get answers from Community members and Google SecOps professionals.