docs: overhauled annotation docs and moved some of the data source specific annotation docs to the respective data source doc pages, closes #1111

2017-04-28 12:51:21 +02:00
parent c46b73538c
commit 4f9f186575
6 changed files with 64 additions and 36 deletions
@@ -89,7 +89,21 @@ The Elasticsearch datasource supports two types of queries you can use to fill t
 {"find": "fields", "type": "string", "query": <lucene query>}
 ```

-### Multi format / All format
-Use lucene format.
+<br>
+## Annotations
+
+[Annotations]({{< relref "reference/Annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
+queries via the Dashboard menu / Annotations view. Grafana can query any Elasticsearch index
+for annotation events.
+
+Name | Description
+------------ | -------------
+Query | You can leave the search query blank or specify a lucene query
+Time | The name of the time field, needs to be date field.
+Title | The name of field to use for the event title.
+Tags | Optional field name to use for event tags (can be array or csv string).
+Text | Optional field name to use event text body.
+
+


@@ -63,6 +63,10 @@ Some functions like aliasByNode support an optional second argument. To add this

 ![](/img/docs/animated_gifs/func_editor_optional_params.gif)

+### Nested Queries
+
+You can reference queries by the row “letter” that they’re on (similar to  Microsoft Excel). If you add a second query to graph, you can reference the first query simply by typing in #A. This provides an easy and convenient way to build compounded queries.
+
 ## Point consolidation

 All Graphite metrics are consolidated so that Graphite doesn't return more data points than there are pixels in the graph. By default
@@ -83,6 +87,12 @@ You can also create nested variables that use other variables in their definitio

 ![](/img/docs/v2/templated_variable_parameter.png)

+## Annotations
+
+[Annotations]({{< relref "reference/Annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
+queries via the Dashboard menu / Annotations view.
+
+Graphite supports two ways to query annotations. A regular metric query, for this you use the `Graphite query` textbox. A Graphite events query, use the `Graphite event tags` textbox,
+specify an tag or wildcard (leave empty should also work)
+

-## Query Reference
-You can reference queries by the row “letter” that they’re on (similar to  Microsoft Excel). If you add a second query to graph, you can reference the first query simply by typing in #A. This provides an easy and convenient way to build compounded queries.
@@ -121,7 +121,9 @@ SHOW TAG VALUES WITH KEY = "hostname"  WHERE region =~ /$region/
 ![](/img/docs/influxdb/templating_simple_ex1.png)

 ## Annotations
-Annotations allows you to overlay rich event information on top of graphs.
+
+[Annotations]({{< relref "reference/Annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
+queries via the Dashboard menu / Annotations view.

 An example query:

@@ -129,4 +131,8 @@ An example query:
 SELECT title, description from events WHERE $timeFilter order asc
 ```

+For InfluxDB you need to enter a query like in the above example. 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. The
+Tags field can be a comma seperated string.
+

@@ -81,3 +81,15 @@ When the `Include All` option or `Multi-Value` option is enabled, Grafana conver
 Which means you have to use `=~` instead of `=` in your Prometheus queries. For example `ALERTS{instance=~$instance}` instead of `ALERTS{instance=$instance}`.

 ![](/img/docs/v2/prometheus_templating.png)
+
+## Annotations
+
+[Annotations]({{< relref "reference/Annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation
+queries via the Dashboard menu / Annotations view.
+
+Prometheus supports two ways to query annotations.
+
+- A regular metric query
+- A Prometheus query for pending and firing alerts (for details see [Inspecting alerts during runtime](https://prometheus.io/docs/alerting/rules/#inspecting-alerts-during-runtime))
+
+The step option is useful to limit the number of events returned from your query.