2.0 KiB
| page_title | page_description | page_keywords |
|---|---|---|
| Annotations | Annotations user guide | grafana, annotations, guide, documentation |
Annotations
Annotations provide a way to mark points on the graph with rich events. When you hover over an annotation you can get title, tags, and text information for the event.
To enable annotations open dashboard settings and the controls tab. Under feature toggles you will find the checkbox for annotations.
When enabled they will appear in the sub menu controls area.
Click the cog wheel to open the dialog where you can add & edit annotations.
Datasources
Grafana supports many data sources for annotation.
- Graphite metrics
- Graphite events
- InfluxDB query
- Elasticsearch query
InfluxDB Annotations
For InfluxDB you need to enter a query like in the above screenshot. You need to have the where $timeFilter part.
If you only select one column you will not need to enter anything in the column mapping fields.
If you have multiple columns you need to specify which column should be treated as title, tags and text column.
Elasticsearch Annotations
You can use the same data source as you specified in config.js for storing grafana dashboards or you can specify another one. The annotation definition contains an index name that will override the index name specified in config.js. The index name can be the name of an alias or an index wildcard pattern. You can leave the search query blank or specify a lucene query.
If your elasticsearch document has a timestamp field other than @timestamp you will need to specify that. As well
as the name for the fields that should be used for the annotation title, tags and text. Tags and text are optional.
The annotation timestamp field in elasticsearch need to be in UTC format