devopsmakers / python-grafannotate

A CLI tool to add annotations to Grafana

grafannotate

A CLI tool to send Grafana annotations to various destinations.

Installation

pip install grafannotate

Usage

grafannotate --help
Usage: grafannotate [OPTIONS]

  Send Grafana annotations to various endpoints

Options:
  -u, --uri TEXT          URI to send annotation to. Default:
                          "http://localhost:3000/api/annotations".
  -k, --api-key TEXT      Grafana API key to pass in Authorisation header
  -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<br />with newlines<br />and <a href=\"https://something.com/\">links</a>"

• Pipe output to an annotation description

START_TIME=`date +%s`
command_with_output | grafannotate --uri http://user:password@grafana:3000/api/annotations --tag my_tag --title "Event Title" --start $START_TIME

• Send an annotation to Grafana API using Authorization header

GRAFANA_API_TOKEN="some_generated_api_token"
grafannotate --uri http://grafana:3000/api/annotations --tag my_tag --title "Event Title" --api-key $GRAFANA_API_TOKEN

python-grafannotate's Issues

Add examples of using in code

I've designed the code to allow for usage in other code (that's how the cli works).

Add an example of doing that. Change the code if it makes it easier to explain and use.

Feature request: Support for API Token via Authorization header?

Hello,
Have you considered implementing support for API Token authentication via the Authorization header?

What about panels and dashboards?

This looks like a VERY nice API, but I would also like to be able to send the panelID and/or the dashboardID too?
Would you be open for adding two more parameters?