Explorar o código

docs: initial docs for new annotation features, #9483

Torkel Ödegaard %!s(int64=8) %!d(string=hai) anos
pai
achega
05fbed4a36
Modificáronse 1 ficheiros con 32 adicións e 2 borrados
  1. 32 2
      docs/sources/reference/annotations.md

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

@@ -11,11 +11,41 @@ weight = 2
 # 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.
+you can get event description and event tags. The text field can include links to other systems with more detail.
 
 ![](/img/docs/annotations/toggles.png)
 
-## Queries
+## Native annotations
+
+Grafana v4.6+ comes with a native annotation store and the ability to add annotation events directly from the graph panel or via the [HTTP API]({{< relref "http_api/annotations.md" >}})
+
+## Adding annotations
+
+by holding down CTRL/CMD + mouse click. Add tags to the annotation will make it searchable from other dashboards.
+
+<!-- adding annoation gif animation -->
+
+### Adding regions events
+
+You can also hold down CTRL/CMD and select region to create a region annotation.
+
+<!-- region image/gif animation -->
+
+### Built in query
+
+After you added an an annotation they will be still be visible. This is due to the built in annotation query that exists on all dashboards. This annotation query will
+fetch all annotation events that originate from the current dashboard and show them on the panel where they where created. This includes alert state history annotations. You can
+stop annotations from being fetched & drawn by opening the **Annotations** settings (via Dashboard cogs menu) and modifying the query named `Annotations & Alerts (Built-in)`.
+
+<!-- image of built in query -->
+
+### Query by tag
+
+You can create new annotation queries that fetch annotations from the native annotation store via the `-- Grafana --` data source and by setting *Filter by* to `Tags`. Specify at least
+one tag. For example create an annotation query name `outages` and specify a tag named `outage`. This query will show all annotations you create (from any dashboard or via API) that
+have the `outage` tag.
+
+## Querying other data sources
 
 Annotation events are fetched via annotation queries. To add a new annotation query to a dashboard
 open the dashboard settings menu, then select `Annotations`. This will open the dashboard annotations