Collect VMware Avi Load Balancer WAF logs
This document explains how to ingest VMware Avi Load Balancer WAF logs to Google Security Operations using the Bindplane agent.
VMware Avi Load Balancer (formerly Avi Networks) is an application delivery controller that generates syslog messages for WAF events, client connection logs, and virtual service activity. The parser extracts fields from syslog-formatted logs 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 AVI Controller
- If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
- Privileged access to VMware AVI Load Balancer
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: udplog: listen_address: "0.0.0.0:514" exporters: chronicle/vmware_avinetworks_iwaf: compression: gzip creds_file_path: '/etc/bindplane-agent/ingestion-auth.json' customer_id: '<customer_id>' endpoint: malachiteingestion-pa.googleapis.com log_type: VMWARE_AVINETWORKS_IWAF raw_log_field: body service: pipelines: logs/vmware_avinetworks_iwaf_to_chronicle: receivers: - udplog exporters: - chronicle/vmware_avinetworks_iwaf
Configuration parameters
Replace the following placeholders:
Receiver configuration:
listen_address: IP address and port to listen on:0.0.0.0to listen on all interfaces (recommended)- Port
514is the standard syslog port (requires root on Linux; use1514for 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
- Linux:
customer_id: Customer ID copied from the Google SecOps consoleendpoint: 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:
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 external logging for VMware AVI WAF
- Sign in to the AVI Controller web UI.
- Go to Templates > Profiles > Analytics.
- Create a new or select a pre-existing analytics profile to edit.
- In the Edit Analytics Profile screen, select the Client Log tab.
- Scroll to the External Logging section and select the Stream Logs to an External Server checkbox.
- Provide the following configuration details:
- Log Streaming Protocol: Select UDP.
- Default Port: Enter 514.
- Types of Logs to Stream: Select All Logs.
- Click the Add button under Servers.
- IP Address: Enter the Bindplane agent IP address.
- Port: Enter the Bindplane agent port number (for example,
514).
- Click Save.
- Apply the settings to the virtual services for which you want the log data to be streamed.
UDM mapping table
| Log Field | UDM Mapping | Logic |
|---|---|---|
server_name |
about.hostname |
Directly mapped |
_field |
additional.fields |
Merged |
additional_field_label |
additional.fields |
Merged |
cacheable_label |
additional.fields |
Merged |
compression_label |
additional.fields |
Merged |
host_label |
additional.fields |
Merged |
http_version_label |
additional.fields |
Merged |
is_internal_label |
additional.fields |
Merged |
key |
additional.fields |
Mapped: `"all_request_headers_pragma", "all_request_headers_accept", "all_request_headers_co... |
match_element_label |
additional.fields |
Merged |
match_value_label |
additional.fields |
Merged |
persistent_session_id_label |
additional.fields |
Merged |
request_headers_label |
additional.fields |
Merged |
request_id_label |
additional.fields |
Merged |
response_content_type_label |
additional.fields |
Merged |
response_headers_label |
additional.fields |
Merged |
response_time_first_byte_label |
additional.fields |
Merged |
response_time_last_byte_label |
additional.fields |
Merged |
rule_log_msg_label |
additional.fields |
Merged |
rule_log_phase_label |
additional.fields |
Merged |
rule_log_rule_group_label |
additional.fields |
Merged |
rule_log_rule_id_label |
additional.fields |
Merged |
rule_log_rule_name_label |
additional.fields |
Merged |
server_connection_reused_label |
additional.fields |
Merged |
server_response_code_label |
additional.fields |
Merged |
server_response_length_label |
additional.fields |
Merged |
server_response_time_first_byte_label |
additional.fields |
Merged |
server_response_time_last_byte_label |
additional.fields |
Merged |
server_rtt_label |
additional.fields |
Merged |
server_side_redirect_uri_label |
additional.fields |
Merged |
server_ssl_session_id_label |
additional.fields |
Merged |
servers_tried_label |
additional.fields |
Merged |
ssl_cipher_label |
additional.fields |
Merged |
ssl_session_id_label |
additional.fields |
Merged |
ssl_version_label |
additional.fields |
Merged |
tag_label |
additional.fields |
Merged |
value_label |
additional.fields |
Merged |
waf_log.latency_request_header_phase_label |
additional.fields |
Merged |
waf_log_latency_request_body_phase_label |
additional.fields |
Merged |
waf_log_latency_response_body_phase_label |
additional.fields |
Merged |
waf_log_latency_response_header_phase_label |
additional.fields |
Merged |
waf_log_rules_configured_label |
additional.fields |
Merged |
waf_log_rules_executed_label |
additional.fields |
Merged |
service_engine |
intermediary.hostname |
Directly mapped |
intermediary_ip |
intermediary.ip |
Merged |
server_src_port |
intermediary.port |
Directly mapped |
report_timestamp |
metadata.event_timestamp |
Parsed as ISO8601 |
timestamp |
metadata.event_timestamp |
Parsed as ISO8601 |
has_principal |
metadata.event_type |
Mapped: true → NETWORK_HTTP, true → NETWORK_CONNECTION, true → STATUS_UPDATE |
log_id |
metadata.product_log_id |
Directly mapped |
log_id_syslog |
metadata.product_log_id |
Directly mapped |
http_method |
network.http.method |
Directly mapped |
method |
network.http.method |
Directly mapped |
http_user_agent |
network.http.parsed_user_agent |
Directly mapped |
http_referer |
network.http.referral_url |
Directly mapped |
referer |
network.http.referral_url |
Directly mapped |
http_status |
network.http.response_code |
Directly mapped |
response_code |
network.http.response_code |
Directly mapped |
http_user_agent |
network.http.user_agent |
Directly mapped |
user_agent |
network.http.user_agent |
Directly mapped |
http_bytes_received |
network.received_bytes |
Directly mapped |
response_length |
network.received_bytes |
Directly mapped |
http_bytes_sent |
network.sent_bytes |
Directly mapped |
request_length |
network.sent_bytes |
Directly mapped |
client_rtt |
network.session_duration.seconds |
Directly mapped |
duration |
network.session_duration.seconds |
Directly mapped |
server_conn_src_ip |
observer.ip |
Merged |
client_ip |
principal.asset.ip |
Merged |
source_ip |
principal.asset.ip |
Mapped: client_ip → source_ip |
src_ip |
principal.asset.ip |
Merged |
client_ip |
principal.ip |
Merged |
source_ip |
principal.ip |
Mapped: client_ip → source_ip |
src_ip |
principal.ip |
Merged |
client_src_port |
principal.port |
Directly mapped |
user |
principal.user.userid |
Directly mapped |
request_state |
security_result.description |
Directly mapped |
_field |
security_result.detection_fields |
Merged |
waf_status_label |
security_result.detection_fields |
Merged |
dest_ip |
target.asset.ip |
Merged |
server_ip |
target.asset.ip |
Merged |
vs_ip |
target.asset.ip |
Merged |
vs_name_syslog |
target.hostname |
Directly mapped |
dest_ip |
target.ip |
Merged |
server_ip |
target.ip |
Merged |
vs_ip |
target.ip |
Merged |
client_dest_port |
target.port |
Renamed/mapped |
port |
target.port |
Directly mapped |
server_dest_port |
target.port |
Renamed/mapped |
pool_label |
target.resource.attribute.labels |
Merged |
pool_name_label |
target.resource.attribute.labels |
Merged |
virtualservice_label |
target.resource.attribute.labels |
Merged |
redirected_uri |
target.url |
Directly mapped |
uri_query |
target.url |
Directly mapped |
url |
target.url |
Directly mapped |
| N/A | metadata.event_type |
Constant: NETWORK_HTTP |
| N/A | metadata.product_name |
Constant: AVI Load Balancer |
| N/A | metadata.vendor_name |
Constant: Vmware |
| N/A | network.direction |
Constant: INBOUND |
| N/A | network.http.parsed_user_agent |
Constant: parseduseragent |
Need more help? Get answers from Community members and Google SecOps professionals.