Annotations and Events API
Contents
Hosted Graphite supports Annotations and Graphite Events. The Annotations feature is designed as a simpler interface to create events with tags.
An annotation relates your metrics to intermittent events for example when you deploy code, run some tests (hopefully successfully), or a long-running job completes.
This snippet of code will create an annotation with the tags “deployment” and “feature”, titled “New Super-duper Feature”. It’ll be timestamped at the time the event is received.
curl -X POST https://YOU[email protected]/api/v1/annotations/events/ -d \
"&title=New Super-duper Feature\
&tag=deployment\
&tag=feature"
Annotations have the following properties:
- title - (required) A short summary of the annotation.
super-duper feature updated to v0.0.12
- description - A more in-depth description of the annotation.
Slow rollout of new super-duper feature: 9b562b2. Relies on old version: 4ec124b4.
Enables the new super-duper feature in production.
- tags - A single word or multiple short strings (all case-insensitive) to organize different types of events. e.g. ‘deployments’, ‘feature’, ‘test’ etc.
- start_time - Unix timestamp describing when the event occurred. If this is not specified, the time of event creation is used.
- end_time - Optional timestamp describing when the event completed. Note: We currently don’t support region events. As a result, end_time has no actual use in annotations.
There’s no restriction on having annotations with the same time stamps, but the combination of start time and title must be unique.
The API uses basic HTTP authorization. An example using curl:
curl -X POST https://[email protected]/api/v1/annotations/events/
or
curl -u 'YOUR-API-KEY:' -X POST https://api.hostedgraphite.com/api/v1/annotations/events/
Deleting an annotation via the API is as simple as this:
curl -X DELETE https://[email protected]/api/v1/annotations/events/ \
-d '{"title": "New Super-duper Feature", "timestamp": 1431607046}'
Events as per the Graphite project are fully supported. Insertion and rendering of Graphite Events work the same as the annotations endpoint, though the Graphite events API takes a JSON formatted data structure.
curl -X POST https://[email protected]/api/v1/graphite/events/ \
-d '{"what": "New Super-duper Feature", "when":1431607046, "tags":"deployment feature"}
To support the display of Annotations, there is a function annotations() available in graphite to query and display the events. There are two options:
annotations("*")
This first option with a wildcard queries all available annotations for the time period selected
annotations("restart", "deployment")
This version queries all annotations with the tags “restart” and “deployment” for the time period selected
The graphite events function events() is also available:
drawAsInfinite(events("*")
drawAsInfinite(events("restart", "deployment")
The dashboard annotations feature works exactly as specified in the annotation documentation. It can be used to query by tags (not graphite targets).
- To open the annotations panel, click the settings icon in the top bar and select Annotations.
- Set the datasource to ‘hostedgraphite’ and use the ‘Graphite event tags’ input box to filter by tags.
- Individual wildcards also work to display all events.
Last modified 1mo ago