How netskopeoss/netskope_log_analyzer works
Project Type and Purpose
• This is a Splunk “app” (an add-on) called Netskope Log Analyzer.
• Purpose: Ingest Netskope log bundles, parse and index them into dedicated Splunk indexes, then provide prebuilt dashboards (XML views) and visualizations to help support teams interpret client-side, JSON, publisher, and CSV logs.
File Structure Analysis
• Top-level:
• LICENSE, README.md
• local/ – Splunk app’s configuration directory:
– app.conf, alert_actions.conf – metadata about the app and any custom alert actions
– inputs.conf – defines file-monitoring inputs (/var/log/splunk/logs/*)
– props.conf, transforms.conf (if present) – field extractions and parsing rules
– indexes.conf – declares four dedicated indexes (netskope_client1, netskope_json1, etc.)
– data/ui/ – XML definitions for dashboards and views
• metadata/ – Splunk meta information (access controls)
• static/ – static assets (e.g., dashboard screenshots)
• No custom code beyond Splunk’s XML and configs; logic lives in Splunk’s search and report definitions.
Key Insights from README
• Splunk forwarder/monitor watches /var/log/splunk/logs for Netskope log folder.
• Four dedicated indexes are created on the Splunk server.
• After installation and restart, users select a log folder in the dashboard UI to drive searches.
Main Components
A. Data Source
• Netskope log bundle (client logs, JSON logs, publisher logs, CSV logs)
B. Splunk Universal Forwarder
• Monitors /var/log/splunk/logs/*
• Securely forwards raw events to the Splunk Indexer
C. Splunk Indexer
• Reads inputs.conf routes events into four indexes:
• netskope_client1
• netskope_json1
• netskope_publisher1
• netskope_csv1
• Applies parsing rules from props.conf and transforms.conf (field extraction)
D. Splunk Search Head & App
• Holds the Netskope Log Analyzer app under $SPLUNK_HOME/etc/apps/netskope_log_analyzer
• Uses XML dashboards (local/data/ui/views/*.xml) to run saved searches/visualizations
• app.conf and alert_actions.conf define custom settings and any custom alerts
E. User Interface
• Splunk Web UI at http://<splunk-server>:8000/en-GB/app/netskope_log_analyzer/
• Dashboard tabs for configuration overview, connection info, steering, etc.
Architectural Patterns and Design Principles
• Separation of concerns: ingestion (forwarder), storage/indexing, search & visualization
• Configuration-driven parsing (props/transforms) rather than code
• Modular UI: each XML view focuses on a particular aspect of logs (e.g., client version)
• Extensibility: new views can be dropped into local/data/ui/views
Technologies, Frameworks, Libraries
• Splunk Universal Forwarder & Enterprise (Indexer + Search Head)
• Splunk’s configuration files (inputs.conf, props.conf, indexes.conf, alert_actions.conf)
• Dashboards written in Splunk’s XML dashboard format