Commit f7b4f331 by Torkel Ödegaard

Updating docs

parent c01efad9
...@@ -10,38 +10,31 @@ page_keywords: grafana, annotations, guide, documentation ...@@ -10,38 +10,31 @@ page_keywords: grafana, annotations, guide, documentation
Annotations provide a way to mark points on the graph with rich events. When you hover over an annotation 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. you can get title, tags, and text information for the event.
To enable annotations open dashboard settings and the controls tab. To add an annotation query click dashboard settings icon in top menu and select `Annotations` from the
Under feature toggles you will find the checkbox for annotations. dropdown. This will open the `Annotations` edit view. Click the `Add` tab to add a new annotation query.
When enabled they will appear in the sub menu controls area. ### Graphite annotations
![](/img/v1/annotations_submenu1.png)
Click the cog wheel to open the dialog where you can add & edit annotations. Graphite supports two ways to query annotations.
![](/img/v1/annotations_dialog1.png)
## Datasources - A regular metric query, use the `Graphite target expression` text input for this
Grafana supports many data sources for annotation. - Graphite events query, use the `Graphite event tags` text input, especify an tag or wildcard (leave empty should also work)
- Graphite metrics ## Elasticsearch annoations
- Graphite events ![](/img/v2/annotations_es.png)
- InfluxDB query
- Elasticsearch query Grafana can query any Elasticsearch index for annotation events. 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.
> **Note** The annotation timestamp field in elasticsearch need to be in UTC format.
## InfluxDB Annotations ## InfluxDB Annotations
![](/img/influxdb/influxdb_annotation.png) ![](/img/v2/annotations_influxdb.png)
For InfluxDB you need to enter a query like in the above screenshot. You need to have the ```where $timeFilter``` part. 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 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. If you have multiple columns you need to specify which column should be treated as title, tags and text column.
## Elasticsearch Annotations
![](/img/v1/elasticsearch_annotations_edit.png)
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**
...@@ -6,4 +6,10 @@ page_keywords: grafana, singlestat, panel, documentation ...@@ -6,4 +6,10 @@ page_keywords: grafana, singlestat, panel, documentation
# Singlestat Panel # Singlestat Panel
![](/img/v1/singlestat_panel2.png)
The singlestat panel allows you to show the one main summery stat of a single series (like max, min, avg, sum). It also
provides thresholds to color that singlestat metric or the panel background.
## Options
- TODO
package api package api
import ( import (
"errors"
"fmt"
"strconv" "strconv"
"github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/bus"
"github.com/grafana/grafana/pkg/log"
"github.com/grafana/grafana/pkg/middleware" "github.com/grafana/grafana/pkg/middleware"
m "github.com/grafana/grafana/pkg/models" m "github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/plugins" "github.com/grafana/grafana/pkg/plugins"
...@@ -45,7 +44,8 @@ func getFrontendSettingsMap(c *middleware.Context) (map[string]interface{}, erro ...@@ -45,7 +44,8 @@ func getFrontendSettingsMap(c *middleware.Context) (map[string]interface{}, erro
meta, exists := plugins.DataSources[ds.Type] meta, exists := plugins.DataSources[ds.Type]
if !exists { if !exists {
return nil, errors.New(fmt.Sprintf("Could not find plugin definition for data source: %v", ds.Type)) log.Error(3, "Could not find plugin definition for data source: %v", ds.Type)
continue
} }
dsMap["meta"] = meta dsMap["meta"] = meta
......
...@@ -161,8 +161,8 @@ ...@@ -161,8 +161,8 @@
@dropdownLinkColorHover: @white; @dropdownLinkColorHover: @white;
@dropdownLinkColorActive: @white; @dropdownLinkColorActive: @white;
@dropdownLinkBackgroundActive: @blue; @dropdownLinkBackgroundActive: @blueDark;
@dropdownLinkBackgroundHover: @blue; @dropdownLinkBackgroundHover: @blueDark;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment