Collect Citrix NetScaler logs

This document explains how to ingest Citrix NetScaler logs to Google Security Operations using Bindplane.

The parser extracts fields from Citrix NetScaler syslog and key-value formatted logs. It uses grok and/or kv to parse the log message and then maps these values to the Unified Data Model (UDM). It also sets default metadata values for the event source and type.

Before you begin

Make sure you have the following prerequisites:

• A Google SecOps instance
• Windows Server 2016 or later, or Linux host with systemd
• If running behind a proxy, ensure firewall ports are open per the Bindplane agent requirements
• Privileged access to the Citrix NetScaler web interface

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. 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 IDfrom the Organization Detailssection.

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 Promptor PowerShellas 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 Bindplane agent installation guide .

Configure 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/chronicle_w_labels 
   : 
    
   compression 
   : 
    
   gzip 
    
   creds_file_path 
   : 
    
   '/path/to/ingestion-authentication-file.json' 
    
   customer_id 
   : 
    
   'YOUR_CUSTOMER_ID' 
    
   endpoint 
   : 
    
   malachiteingestion-pa.googleapis.com 
    
   log_type 
   : 
    
   'CITRIX_NETSCALER' 
    
   raw_log_field 
   : 
    
   body 
    
   ingestion_labels 
   : 
   service 
   : 
    
   pipelines 
   : 
    
   logs/source0__chronicle_w_labels-0 
   : 
    
   receivers 
   : 
    
   - 
    
   udplog 
    
   exporters 
   : 
    
   - 
    
   chronicle/chronicle_w_labels 
   
  

Configuration parameters

• Replace the following placeholders:

  • Receiver configuration:

    • udplog : Use udplog for UDP syslog or tcplog for TCP syslog
    • 0.0.0.0 : IP address to listen on ( 0.0.0.0 to listen on all interfaces)
    • 514 : Port number to listen on (standard syslog port)

  • 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
    • YOUR_CUSTOMER_ID : Customer ID from the Get customer ID section
    • 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
    • log_type : Log type exactly as it appears in Chronicle ( CITRIX_NETSCALER )

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 forwarding on Citrix NetScaler

1. Sign in to the Citrix NetScalerweb interface (NSIP).
2. Go to System > Auditing > Syslog.
3. Click Serverstab.
4. Click Addto create a new syslog server.
5. Provide the following configuration details:
   • Name: Enter a descriptive name (for example, Google-SecOps-Bindplane ).
   • Server IP: Enter the IP address of the Bindplane agent host.
   • Port: Enter 514 .
   • Log Level: Select all applicable levels:
     • ALL(recommended for comprehensive logging)
   • Facility: Select LOCAL0(or your preferred facility).
   • Date Format: Select MMDDYYYY.
   • Time Zone: Select GMT_TIME(UTC recommended).
   • TCP Logging: Select NONE(for UDP).
   • Log Facility: Select LOCAL0.
6. Click Create.
7. Go to the Policiestab.
8. Click Addto create a new syslog audit policy.
9. Provide the following configuration details:
   • Name: Enter a descriptive name (for example, Google-SecOps-Policy ).
   • Server: Select the syslog server created earlier.
10. Click Create.
11. Bind the policy globally:
    1. Go to System > Auditing.
    2. Click Global Bindingsunder Syslog Audit Policies.
    3. Click Add Binding.
    4. Select the policy created earlier.
    5. Click Bind.
12. Verify syslog messages are being sent by checking the Bindplane agent logs.

Alternatively, configure via CLI:

 add audit syslogAction Google-SecOps-Bindplane BINDPLANE_IP -serverPort 514 -logLevel ALL -dateFormat MMDDYYYY -timeZone GMT_TIME
add audit syslogPolicy Google-SecOps-Policy ns_true Google-SecOps-Bindplane
bind audit syslogGlobal -policyName Google-SecOps-Policy -priority 100 

• Replace BINDPLANE_IP with the IP address of the Bindplane agent host.

UDM mapping table

UDM mapping delta reference

On February 3, 2026, Google SecOps released a new version of the NetScaler parser, which includes significant changes to the mapping of NetScaler log fields to UDM fields and changes to the mapping of event types.

Log-field mapping delta

The following table lists the mapping delta for NetScaler log-to-UDM fields exposed prior to February 3, 2026 and subsequently (listed in the Old mappingand Current mappingcolumns respectively):

Event-type mapping delta

The following table lists the delta for the handling of NetScaler event types prior to February 3, 2026 and subsequently (listed in the Old event_typeand Current event_typecolumns respectively):

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