Reference
This section provides detailed technical reference documentation for Butler SOS configuration, HTTP and UDP interfaces, and available metrics.
Configuration
- Command Line Options - All available CLI flags and options for running Butler SOS
- Config File Format - Comprehensive documentation of the YAML configuration file
Protocols And APIs
- Audit Events API - HTTP endpoints, status codes, authentication rules, and retry behavior for Audit.qs ingestion
- Audit Events Rate Limiting - Per-IP request limits,
429handling, and rate-limit headers - Audit.qs Version Compatibility - Version matrix,
X-Audit-QS-Version, and compatibility-driven behavior - Audit Event Destinations - Destination overview and current behavior for InfluxDB, JSON, Parquet, PNG, and QVD audit outputs
- UDP Payload Format - Detailed reference for Butler SOS UDP message formats
TIP
Different event types use different destination configs:
- User events:
Butler-SOS.userEvents.sendToInfluxdb.*andButler-SOS.userEvents.sendToNewRelic.* - Log events:
Butler-SOS.logEvents.sendToInfluxdb.*andButler-SOS.logEvents.sendToNewRelic.*
These are separate from the metrics destination configs such as Butler-SOS.influxdbConfig.
Available Metrics
Butler SOS collects metrics from Qlik Sense and can store them in various destinations. Each destination has its own metric structure:
- InfluxDB Metrics - Complete reference of InfluxDB measurements, tags, and fields
- Failed Poll Metrics - InfluxDB error events generated when Qlik Sense polling fails
- Prometheus Metrics - Prometheus endpoint metrics and labels
- New Relic - New Relic integration overview
Quick Links
| Topic | Description |
|---|---|
| Config File | Full configuration file reference with all parameters |
| CLI Options | Command line arguments and their usage |
| Audit Events API | HTTP contract for Audit.qs event ingestion |
| Audit Events Rate Limiting | Per-IP limits and 429 response handling |
| Audit.qs Version Compatibility | Compatibility checks between Butler SOS and Audit.qs |
| Audit Event Destinations | Destination overview for audit metadata and artifacts |
| JSON Object Data | Dedicated JSON output for visualization object data |
| Screenshot Downloads | Screenshot auth, redirects, and allowed hosts |
| InfluxDB Metrics | Detailed InfluxDB measurement schemas |
| Prometheus Metrics | Prometheus metric names and labels |