sqshq/sampler
Sampler
Sampler is a shell command monitoring tool and terminal-based metrics dashboard. It functions as a YAML-configured shell orchestrator that executes commands at set intervals to collect data and monitor system metrics.
The tool distinguishes itself by rendering real-time shell output as terminal widgets, such as sparklines, gauges, bar charts, and run charts. It also includes a conditional alerting system that triggers audio notifications, visual alerts, or secondary shell commands when sampled output matches predefined data conditions.
The project covers broad capability areas including shell metric collection, session management for persistent interactive shells, and configuration parameterization via environment variables and startup flags. It supports containerized deployment to ensure consistent monitoring behavior across different environments.
Features
- Real-Time Metric Visualization - Renders real-time data from shell commands as runcharts, sparklines, barcharts, and gauges.
- Shell-Based Monitoring - Regularly polls shell scripts to collect system data and triggers automated alerts based on thresholds.
- Metric Triggers - Executes predefined triggers, such as audio alerts, when specific sampled metric conditions are met.
- Shell Orchestrators - Manages repeated shell executions and persistent sessions using a declarative YAML configuration file.
- Terminal Widget Toolkits - Renders raw shell command output as visual terminal widgets including sparklines, gauges, and bar charts.
- Metric Widgets - Renders system metrics using terminal widgets including bar charts, gauges, sparklines, and run charts.
- Action Triggers - Provides a system to execute shell commands, visual alerts, or sound notifications when specific data conditions are met.
- Metric Condition Evaluators - Evaluates sampled shell output against thresholds to trigger automated notifications and secondary commands.
- YAML Configuration Files - Uses a declarative YAML configuration file to define sampling intervals, command patterns, and alert triggers.
- Alerting Systems - Implements an alerting system that triggers notifications based on specific system metric conditions.
- Alerting Systems - Automatically executes shell scripts, visual notifications, or sound alerts based on sampled system metrics.
- Metric Collection - Executes configured shell commands at set intervals to gather quantitative performance data for monitoring.
- Terminal-Based Dashboards - Renders real-time shell output as sparklines, gauges, and bar charts within a terminal-based dashboard.
- Terminal Data Visualizations - Visualizes system performance by rendering shell command output as real-time charts and gauges in a terminal.
- Shell Session Initializers - Supports the maintenance of active shell sessions using specific initialization commands to reduce reconnection overhead.
- Shell Session Persistence - Executes repeated commands within a single persistent interactive session to avoid initialization overhead.
- Environment Variable Injection - Merges system environment variables and startup flags into shell command templates at runtime.
- Configuration Variables - Provides the ability to inject custom values into scripts via configuration files, flags, and environment variables.
- Persistent Shell Sessions - Maintains active shell processes to execute repeated commands without the overhead of recurring session initialization.
- System Monitoring - Provides a portable system monitoring tool packaged as a container image for consistent environment deployment.
- System Monitors - Shell command execution and visualization tool.
