Added component screenshots in README
This commit is contained in:
parent
a148f4250d
commit
ebf7f3b0be
23
README.md
23
README.md
|
@ -41,6 +41,7 @@ Using Sampler is basically a 3-step process:
|
|||
|
||||
### Components
|
||||
#### Runchart
|
||||
![runchart](https://user-images.githubusercontent.com/6069066/59168666-aff96d00-8b04-11e9-99b6-34d8bae37bd2.png)
|
||||
```yml
|
||||
runcharts:
|
||||
- title: Search engine response time
|
||||
|
@ -59,14 +60,20 @@ runcharts:
|
|||
sample: curl -o /dev/null -s -w '%{time_total}' https://www.bing.com
|
||||
```
|
||||
#### 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
|
||||
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](https://user-images.githubusercontent.com/6069066/59167751-de754900-8b00-11e9-8d01-efd04ae1eec6.png)
|
||||
```yml
|
||||
barcharts:
|
||||
- title: Local network activity
|
||||
|
@ -83,20 +90,29 @@ barcharts:
|
|||
sample: nettop -J bytes_out -l 1 -m tcp | awk '{sum += $4} END {print sum}'
|
||||
```
|
||||
#### Gauge
|
||||
![gauge](https://user-images.githubusercontent.com/6069066/59168667-b0920380-8b04-11e9-852b-5e7810fab640.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](https://user-images.githubusercontent.com/6069066/59167747-de754900-8b00-11e9-887b-a9fce57d9a72.png)
|
||||
```yml
|
||||
textboxes:
|
||||
- title: Local weather
|
||||
|
@ -109,6 +125,7 @@ textboxes:
|
|||
sample: docker stats --no-stream --format "table {{.Name}}\t{{.CPUPerc}}\t{{.MemUsage}}\t{{.PIDs}}"
|
||||
```
|
||||
#### Asciibox
|
||||
![asciibox](https://user-images.githubusercontent.com/6069066/59167749-de754900-8b00-11e9-9157-cc9809fbc622.png)
|
||||
```yml
|
||||
asciiboxes:
|
||||
- title: UTC time
|
||||
|
|
Loading…
Reference in New Issue