diff --git a/README.md b/README.md index 97bd1d9..a1b0b7a 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Using Sampler is basically a 3-step process: - Run `sampler -c config.yml` - Adjust components size and location on UI -## Configuration +## Contents - [Components](#components) - [Runchart](#runchart) @@ -34,13 +34,16 @@ Using Sampler is basically a 3-step process: - [Asciibox](#asciibox) - [Bells and whistles](#bells-and-whistles) - [Triggers (conditional actions)](#triggers) - - [Interactive shell (for database interaction, remote server access, etc)](#interactive-shell-support) + - [Interactive shell (database interaction, remote server access, etc)](#interactive-shell-support) - [Variables](#variables) - [Color theme](#color-theme) - [Real-world examples (contributions welcome)](#real-world-examples) -### Components -#### Runchart +## Components +The following is a list of configuration examples for each component type, with macOS compatible sample scripts. + +### Runchart +![runchart](https://user-images.githubusercontent.com/6069066/59168666-aff96d00-8b04-11e9-99b6-34d8bae37bd2.png) ```yml runcharts: - title: Search engine response time @@ -56,17 +59,23 @@ runcharts: - label: YAHOO sample: curl -o /dev/null -s -w '%{time_total}' https://search.yahoo.com - label: BING - sample: curl -o /dev/null -s -w '%{time_total}' https://www.bing.com + sample: curl -o /dev/null -s -w '%{time_total}' https://www.bing.com ``` -#### Sparkline +### Sparkline +![sparkline](https://user-images.githubusercontent.com/6069066/59167746-de754900-8b00-11e9-9305-c9a4176634d2.png) ```yml sparklines: -- title: CPU usage - rate-ms: 200 # sampling rate, default = 1000 - scale: 0 # number of digits after sample decimal point, default = 1 - sample: ps -A -o %cpu | awk '{s+=$1} END {print s}' + - title: CPU usage + rate-ms: 200 + scale: 0 + sample: ps -A -o %cpu | awk '{s+=$1} END {print s}' + - title: Free memory pages + rate-ms: 200 + scale: 0 + sample: memory_pressure | grep 'Pages free' | awk '{print $3}' ``` -#### Barchart +### Barchart +![barchart](https://user-images.githubusercontent.com/6069066/59167751-de754900-8b00-11e9-8d01-efd04ae1eec6.png) ```yml barcharts: - title: Local network activity @@ -82,21 +91,30 @@ barcharts: - label: TCP bytes out sample: nettop -J bytes_out -l 1 -m tcp | awk '{sum += $4} END {print sum}' ``` -#### Gauge +### Gauge +![gauge](https://user-images.githubusercontent.com/6069066/59318799-4c06ae00-8c96-11e9-868a-7fef803f3739.png) ```yml gauges: - title: Minute progress rate-ms: 500 # sampling rate, default = 1000 scale: 2 # number of digits after sample decimal point, default = 1 - color: 39 # 8-bit color number, default one is chosen from a pre-defined palette + color: 178 # 8-bit color number, default one is chosen from a pre-defined palette cur: sample: date +%S # sample script for current value max: sample: echo 60 # sample script for max value min: sample: echo 0 # sample script for min value + - title: Year progress + cur: + sample: date +%j + max: + sample: echo 365 + min: + sample: echo 0 ``` -#### Textbox +### Textbox +![textbox](https://user-images.githubusercontent.com/6069066/59168949-192db000-8b06-11e9-900b-0e92ff494f62.png) ```yml textboxes: - title: Local weather @@ -108,30 +126,32 @@ textboxes: rate-ms: 500 sample: docker stats --no-stream --format "table {{.Name}}\t{{.CPUPerc}}\t{{.MemUsage}}\t{{.PIDs}}" ``` -#### Asciibox +### Asciibox +![asciibox](https://user-images.githubusercontent.com/6069066/59169283-aa515680-8b07-11e9-8beb-716a387aed1b.png) ```yml asciiboxes: - title: UTC time rate-ms: 500 # sampling rate, default = 1000 font: 3d # font type, default = 2d - color: 178 # 8-bit color number, default is white + border: false # border around the item, default = true + color: 43 # 8-bit color number, default is white sample: env TZ=UTC date +%r ``` -### Bells and whistles +## Bells and whistles -#### Triggers +### Triggers Triggers allow to perform conditional actions, like visual/sound alerts or an arbitrary shell command. -#### Interactive shell support +### Interactive shell support In addition to the `sample` command, one can specify `init` command (executed only once before sampling) and `transform` command (to post-process `sample` command output). That covers interactive shell use case, e.g. to establish connection to a database only once, and then perform polling within interactive shell session. MongoDB example: ... -#### Variables +### Variables If the configuration file contains repeated patterns, they can be extracted into the `variables` section. Also variables can be specified using `-v`/`--variable` flag on startup, and any system environment variables will also be available in the scripts. -#### Color theme +### Color theme ... -### Real-world examples +## Real-world examples ...