Dokumen ini menjelaskan cara menyerap log VyOS ke Google Security Operations menggunakan Bindplane. Parser mengekstrak kolom dari pesan syslog, terutama berfokus pada peristiwa DHCP. Proses ini menggunakan pola grok untuk mengidentifikasi dan mengategorikan pesan berdasarkan proses (dhcpd, kernel, dll.), lalu memetakan informasi yang relevan ke kolom UDM, menangani permintaan DHCP, konfirmasi, penawaran, dan jenis peristiwa lainnya secara berbeda. Selain itu, kolom ini juga mengisi detail peristiwa umum untuk log non-DHCP dan memetakan informasi koneksi jaringan jika tersedia.
Sebelum memulai
Pastikan Anda memenuhi prasyarat berikut:
Instance Google SecOps
Windows 2016 atau yang lebih baru atau host Linux dengan systemd
Jika berjalan di belakang proxy, pastikan port firewall terbuka
Akses istimewa ke VyOS
Mendapatkan file autentikasi penyerapan Google SecOps
Login ke konsol Google SecOps.
Buka Setelan SIEM > Agen Pengumpulan.
Download File Autentikasi Penyerapan. Simpan file dengan aman di sistem tempat BindPlane akan diinstal.
Mendapatkan ID pelanggan Google SecOps
Login ke konsol Google SecOps.
Buka Setelan SIEM > Profil.
Salin dan simpan ID Pelanggan dari bagian Detail Organisasi.
Menginstal agen Bindplane
Instal agen Bindplane di sistem operasi Windows atau Linux Anda sesuai
dengan petunjuk berikut.
Penginstalan Windows
Buka Command Prompt atau PowerShell sebagai administrator.
Mengonfigurasi agen BindPlane untuk menyerap Syslog dan mengirimkannya ke Google SecOps
Akses file konfigurasi:
Cari file config.yaml. Biasanya, file ini berada di direktori /etc/bindplane-agent/ di Linux atau di direktori penginstalan di Windows.
Buka file menggunakan editor teks (misalnya, nano, vi, atau Notepad).
Edit file config.yaml sebagai berikut:
receivers:udplog:# Replace the port and IP address as requiredlisten_address:"0.0.0.0:514"exporters:chronicle/chronicle_w_labels:compression:gzip# Adjust the path to the credentials file you downloaded in Step 1creds_file_path:'/path/to/ingestion-authentication-file.json'# Replace with your actual customer ID from Step 2customer_id:<customer_id>
endpoint:malachiteingestion-pa.googleapis.com# Add optional ingestion labels for better organizationlog_type:'VYOS'raw_log_field:bodyingestion_labels:service:pipelines:logs/source0__chronicle_w_labels-0:receivers:-udplogexporters:-chronicle/chronicle_w_labels
Ganti port dan alamat IP sesuai kebutuhan di infrastruktur Anda.
Ganti <customer_id> dengan ID pelanggan yang sebenarnya.
Pastikan untuk mengganti kolom berikut dengan detail Anda:
<bindplane-address>: Masukkan alamat IP agen Bindplane.
<bindolane-port>: Masukkan nomor port agen Bindplane (misalnya, 514).
<udp-or-tcp>: Masukkan UDP atau TCP, bergantung pada konfigurasi Bindplane Anda (misalnya, UDP).
Tabel Pemetaan UDM
Kolom Log
Pemetaan UDM
Logika
clientIp
principal.ip
Alamat IP klien yang diekstrak dari pesan DHCP.
clientMac
principal.mac
Alamat MAC klien diekstrak dari pesan DHCP.
datetime
metadata.event_timestamp
Stempel waktu yang diekstrak dari pesan log.
dst_ipaddress
target.ip
Alamat IP tujuan diekstrak dari pesan log.
hostname
observer.hostname
Nama host diekstrak dari pesan log. Ditentukan oleh parser berdasarkan process dan kolom lainnya. Dapat berupa GENERIC_EVENT, NETWORK_CONNECTION, NETWORK_DHCP, atau STATUS_UPDATE. Dikodekan secara permanen ke "VYOS".
msg
metadata.description
Pesan asli dari log, atau sebagiannya, bergantung pada logika parsing. Disetel ke "DHCP Event" jika process adalah "dhcpd". Dikodekan secara permanen ke "VYOS DHCP". Dikodekan secara permanen ke "VYOS".
network.dhcp.chaddr
network.dhcp.chaddr
Alamat MAC klien diekstrak dari pesan DHCP.
network.dhcp.ciaddr
network.dhcp.ciaddr
Alamat IP klien dalam pesan DHCPREQUEST. Opcode pesan DHCP. Disetel ke "BOOTREQUEST" untuk DHCPREQUEST dan DHCPINFORM, "BOOTREPLY" untuk DHCPACK dan DHCPNAK. Jenis pesan DHCP. Diperoleh dari eventType dan dapat berupa REQUEST, ACK, INFORM, NAK, atau OFFER.
network.dhcp.yiaddr
network.dhcp.yiaddr
Alamat IP Anda (klien) dalam pesan DHCPACK atau DHCPOFFER. Tetapkan ke "DHCP" jika process adalah "dhcpd".
pri_host
principal.hostname
Nama host yang terkait dengan klien dalam pesan DHCP.
rem_msg
metadata.description
Bagian pesan yang tersisa setelah penguraian awal, digunakan untuk deskripsi dalam beberapa kasus.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-09-04 UTC."],[],[],null,["# Collect VyOS logs\n=================\n\nSupported in: \nGoogle secops [SIEM](/chronicle/docs/secops/google-secops-siem-toc)\n| **Note:** This feature is covered by [Pre-GA Offerings Terms](https://chronicle.security/legal/service-terms/) of the Google Security Operations Service Specific Terms. Pre-GA features might have limited support, and changes to pre-GA features might not be compatible with other pre-GA versions. For more information, see the [Google SecOps Technical Support Service guidelines](https://chronicle.security/legal/technical-support-services-guidelines/) and the [Google SecOps Service Specific Terms](https://chronicle.security/legal/service-terms/).\n\nThis document explains how to ingest VyOS logs to Google Security Operations using Bindplane. The parser extracts fields from the syslog messages, primarily focusing on DHCP events. It uses grok patterns to identify and categorize messages based on the process (dhcpd, kernel, etc.), then maps relevant information to UDM fields, handling DHCP requests, acknowledgments, offers, and other event types differently. It also populates generic event details for non-DHCP logs and maps network connection information when available.\n\nBefore you begin\n----------------\n\nMake sure you have the following prerequisites:\n\n- Google SecOps instance\n- Windows 2016 or later or a Linux host with `systemd`\n- If running behind a proxy, ensure firewall [ports](/chronicle/docs/ingestion/use-bindplane-agent#verify_the_firewall_configuration) are open\n- Privileged access to VyOS\n\nGet Google SecOps ingestion authentication file\n-----------------------------------------------\n\n1. Sign in to the Google SecOps console.\n2. Go to **SIEM Settings \\\u003e Collection Agents**.\n3. Download the **Ingestion Authentication File**. Save the file securely on the system where Bindplane will be installed.\n\nGet Google SecOps customer ID\n-----------------------------\n\n1. Sign in to the Google SecOps console.\n2. Go to **SIEM Settings \\\u003e Profile**.\n3. Copy and save the **Customer ID** from the **Organization Details** section.\n\nInstall the Bindplane agent\n---------------------------\n\nInstall the Bindplane agent on your Windows or Linux operating system according\nto the following instructions.\n\n### Windows installation\n\n1. Open the **Command Prompt** or **PowerShell** as an administrator.\n2. Run the following command:\n\n msiexec /i \"https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi\" /quiet\n\n### Linux installation\n\n1. Open a terminal with root or sudo privileges.\n2. Run the following command:\n\n sudo sh -c \"$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)\" install_unix.sh\n\n### Additional installation resources\n\nFor additional installation options, consult the [installation guide](/chronicle/docs/ingestion/use-bindplane-agent#install_the_bindplane_agent).\n\nConfigure the Bindplane agent to ingest Syslog and send to Google SecOps\n------------------------------------------------------------------------\n\n1. Access the configuration file:\n - Locate the `config.yaml` file. Typically, it's in the `/etc/bindplane-agent/` directory on Linux or in the installation directory on Windows.\n - Open the file using a text editor (for example, `nano`, `vi`, or Notepad).\n2. Edit the `config.yaml` file as follows:\n\n receivers:\n udplog:\n # Replace the port and IP address as required\n listen_address: \"0.0.0.0:514\"\n\n exporters:\n chronicle/chronicle_w_labels:\n compression: gzip\n # Adjust the path to the credentials file you downloaded in Step 1\n creds_file_path: '/path/to/ingestion-authentication-file.json'\n # Replace with your actual customer ID from Step 2\n customer_id: \u003ccustomer_id\u003e\n endpoint: malachiteingestion-pa.googleapis.com\n # Add optional ingestion labels for better organization\n log_type: 'VYOS'\n raw_log_field: body\n ingestion_labels:\n\n service:\n pipelines:\n logs/source0__chronicle_w_labels-0:\n receivers:\n - udplog\n exporters:\n - chronicle/chronicle_w_labels\n\n - Replace the port and IP address as required in your infrastructure.\n - Replace `\u003ccustomer_id\u003e` with the actual customer ID.\n - Update `/path/to/ingestion-authentication-file.json` to the path where the authentication file was saved in the [Get Google SecOps ingestion authentication file](/chronicle/docs/ingestion/default-parsers/vyos#get-auth-file) section.\n\nRestart the Bindplane agent to apply the changes\n------------------------------------------------\n\n- To restart the Bindplane agent in **Linux**, run the following command:\n\n sudo systemctl restart bindplane-agent\n\n- To restart the Bindplane agent in **Windows** , you can either use the\n **Services** console or enter the following command:\n\n net stop BindPlaneAgent && net start BindPlaneAgent\n\nConfigure Syslog on VyOS\n------------------------\n\n1. Sign in to the VyOS router using CLI.\n2. Enter the following commands:\n\n set system syslog marker interval 1200\n set system syslog remote \u003cbindplane-address\u003e facility local0 level info port \u003cbindolane-port\u003e protocol \u003cudp-or-tcp\u003e format include-timezone\n\n3. Make sure to replace the following fields with your details:\n\n - `\u003cbindplane-address\u003e`: Enter the Bindplane agent IP address.\n - `\u003cbindolane-port\u003e`: Enter the Bindplane agent port number (for example, `514`).\n - `\u003cudp-or-tcp\u003e`: Enter either UDP or TCP, depending on your Bindplane configuration (for example, `UDP`).\n\nUDM Mapping Table\n-----------------\n\n**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/google-security-operations-2)"]]
