Send annotations to Grafana
Project description
grafannotate
A CLI tool to send Grafana annotations to various destinations.
Installation
pip install grafannotate
Usage
grafannotate --help
Usage: grafannotate [OPTIONS]
Send Grafana annotations
Options:
-u, --uri TEXT URI to send annotation to. Default:
"http://localhost:3000/api/annotations".
-T, --title TEXT Event title. Default: "event".
-t, --tag TEXT Event tags (can be used multiple times).
-d, --description TEXT Event description body. Optional.
-s, --start INTEGER Start timestamp (unix secs). Default: current
timestamp.
-e, --end INTEGER End timestamp (unix secs). Optional.
--help Show this message and exit.
Examples
- Send an annotation to Grafana API for current time
grafannotate --uri http://user:password@grafana:3000/api/annotations --tag my_tag --title "Event Title"
- Send an annotation to Grafana API for a time region
grafannotate --uri http://user:password@grafana:3000/api/annotations --tag my_tag --title "Event Title" --start 1557222057 --end 1557222259
- Send an annotation to Grafana API with an extended description
grafannotate --uri http://user:password@grafana:3000/api/annotations --tag my_tag --title "Event Title" --description 'Some longer description\nwith newlines\n<a href="https://something.com/">hyperlinks</a>'
- Pipe output to an annotation description
START_TIME=`date +%s`
long_running_command | grafannotate --uri http://user:password@grafana:3000/api/annotations --tag my_tag --title "Event Title" --start $START_TIME --end `date +%s`
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
grafannotate-0.0.8.tar.gz
(3.8 kB
view hashes)
Built Distribution
Close
Hashes for grafannotate-0.0.8-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1cbe9d2ebd30a7a06172f90110aa060e88324ddbb4110c3fe648ffab67d03147 |
|
MD5 | 29ff8a433be4b78fcf782af4ba8e16e1 |
|
BLAKE2b-256 | 8ee510473ae6c0b352852250575cc7f19d3429bfa25e6f0b2ce6d62ab5f6bad3 |