Reference
This section provides detailed technical reference documentation for Butler SOS configuration, command line options, 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
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
- 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 |
| InfluxDB Metrics | Detailed InfluxDB measurement schemas |
| Prometheus Metrics | Prometheus metric names and labels |