Skip to content
This repository has been archived by the owner on Jul 3, 2021. It is now read-only.

Commit

Permalink
add screenshot. close #17.
Browse files Browse the repository at this point in the history
  • Loading branch information
jorinvo committed Feb 11, 2017
1 parent d2c93df commit 834e7cb
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@

`promplot` is an opinionated tool to create plots from your [Prometheus](https://prometheus.io/) metrics and automatically sends them to you.


**Slack example:**

``` sh
promplot -title "Open File Descriptors" -query "process_open_fds" -range "7d" -url $promurl -slack $slacktoken -channel stats
```

![Demo Screenshot](screenshot.png)

Currently the only implemented transport is [Slack](https://slack.com/).
But feel free to [add a new one](#development)!

Expand Down Expand Up @@ -82,8 +91,6 @@ promplot $common \
-query "process_open_fds"
```

And with a scheduler like [sleepto](https://qvl.io/sleepto) you can easily automate this script to run every day or once a week.


### Mailing results

Expand Down Expand Up @@ -111,6 +118,9 @@ echo "Your daily report is here." | mail \
```


And with a scheduler like [sleepto](https://qvl.io/sleepto) you can easily automate this script to run every day or once a week.


## Development

Make sure to use `gofmt` and create a [Pull Request](https://github.com/qvl/promplot/pulls).
Expand All @@ -127,9 +137,9 @@ Push a new Git tag and [GoReleaser](https://github.com/goreleaser/releaser) will

to these helpful open source projects promplot is built on top of:

- [Gonum Plot](https://github.com/gonum/plot)
- [Prometheus Golang client](https://github.com/prometheus/client_golang)
- [Slack API package](https://github.com/nlopes/slack)
- [Gonum Plot](https://github.com/gonum/plot)


## License
Expand Down
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 834e7cb

Please sign in to comment.