Skip to content

Commit

Permalink
[v10.0.x] Docs: Added data source requirement for built-in annotation…
Browse files Browse the repository at this point in the history
… query (#79655)

Docs: Added data source requirement for built-in annotation query (#78860)

* Docs: Added data source requirement for built-in annotation query

* Fixed wording

* Added more detailed explanation per feedback

(cherry picked from commit 11b2f41)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
  • Loading branch information
grafana-delivery-bot[bot] and imatwawana committed Dec 18, 2023
1 parent 34ab8a3 commit f70b206
Showing 1 changed file with 2 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ To add a new annotation query to a dashboard, take the following steps:

After you add an annotation, they will 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, which are stored in Grafana, and show them on the panel where they were created. This includes alert state history annotations.

By default, the built-in annotation query uses the `-- Grafana --` special data source, and manual annotations are only supported using this data source. You can use another data source in the built-in annotation query, but you'll only be able to create automated annotations using the query editor for that data source.

To add annotations directly to the dashboard, this query must be enabled.

To confirm if the built-in query is enabled, take the following steps:
Expand Down

0 comments on commit f70b206

Please sign in to comment.