Преглед на файлове

docs: document annotations for postgres/mysql

Daniel Lee преди 8 години
родител
ревизия
fc76530577

+ 2 - 1
docs/sources/features/datasources/index.md

@@ -28,8 +28,9 @@ The following datasources are officially supported:
 * [InfluxDB]({{< relref "influxdb.md" >}})
 * [InfluxDB]({{< relref "influxdb.md" >}})
 * [OpenTSDB]({{< relref "opentsdb.md" >}})
 * [OpenTSDB]({{< relref "opentsdb.md" >}})
 * [Prometheus]({{< relref "prometheus.md" >}})
 * [Prometheus]({{< relref "prometheus.md" >}})
+* [MySQL]({{< relref "mysql.md" >}})
+* [Postgres]({{< relref "postgres.md" >}})
 
 
 ## Data source plugins
 ## Data source plugins
 
 
 Since grafana 3.0 you can install data sources as plugins. Checkout [Grafana.net](https://grafana.com/plugins) for more data sources.
 Since grafana 3.0 you can install data sources as plugins. Checkout [Grafana.net](https://grafana.com/plugins) for more data sources.
-

+ 1 - 3
docs/sources/features/datasources/influxdb.md

@@ -173,6 +173,4 @@ 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```
 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
 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.
-
-
+Tags field can be a comma separated string.

+ 23 - 2
docs/sources/features/datasources/mysql.md

@@ -174,7 +174,28 @@ WHERE $__timeFilter(atimestamp) and hostname in([[hostname]])
 ORDER BY atimestamp ASC
 ORDER BY atimestamp ASC
 ```
 ```
 
 
+## 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.
+
+An example query:
+
+```sql
+SELECT
+  UNIX_TIMESTAMP(atimestamp) as time_sec,
+  value as text,
+  CONCAT(tag1, ',', tag2) as tags
+FROM my_table
+WHERE $__timeFilter(atimestamp)
+ORDER BY atimestamp ASC
+```
+
+Name | Description
+------------ | -------------
+time_sec | The name of the date/time field.
+text | Event description field.
+tags | Optional field name to use for event tags as a comma separated string.
+
 ## Alerting
 ## Alerting
 
 
-Time series queries should work in alerting conditions. Table formatted queries is not yet supported in alert rule
-conditions.
+Time series queries should work in alerting conditions. Table formatted queries is not yet supported in alert rule conditions.

+ 23 - 0
docs/sources/features/datasources/postgres.md

@@ -184,6 +184,29 @@ WHERE $__timeFilter(atimestamp) and hostname in([[hostname]])
 ORDER BY atimestamp ASC
 ORDER BY atimestamp ASC
 ```
 ```
 
 
+## 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.
+
+An example query:
+
+```sql
+SELECT
+  extract(epoch from time_date_time) AS time,
+ metric1 as text,
+  concat_ws(', ', metric1::text, metric2::text) as tags
+FROM
+  public.test_data
+WHERE
+  $__timeFilter(time_date_time)
+```
+
+Name | Description
+------------ | -------------
+time | The name of the date/time field.
+text | Event description field.
+tags | Optional field name to use for event tags as a comma separated string.
+
 ## Alerting
 ## Alerting
 
 
 Time series queries should work in alerting conditions. Table formatted queries is not yet supported in alert rule
 Time series queries should work in alerting conditions. Table formatted queries is not yet supported in alert rule

+ 2 - 2
docs/sources/reference/annotations.md

@@ -69,5 +69,5 @@ The annotation query options are different for each data source.
 - [Elasticsearch annotation queries]({{< relref "features/datasources/elasticsearch.md#annotations" >}})
 - [Elasticsearch annotation queries]({{< relref "features/datasources/elasticsearch.md#annotations" >}})
 - [InfluxDB annotation queries]({{< relref "features/datasources/influxdb.md#annotations" >}})
 - [InfluxDB annotation queries]({{< relref "features/datasources/influxdb.md#annotations" >}})
 - [Prometheus annotation queries]({{< relref "features/datasources/prometheus.md#annotations" >}})
 - [Prometheus annotation queries]({{< relref "features/datasources/prometheus.md#annotations" >}})
-
-
+- [MySQL annotation queries]({{< relref "features/datasources/mysql.md#annotations" >}})
+- [Postgres annotation queries]({{< relref "features/datasources/postgres.md#annotations" >}})