Skip to content

Commit 1c19c68

Browse files
committed
created annotation page
1 parent eadab76 commit 1c19c68

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

docs/sources/annotations/_index.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Create annotations with Google Sheets data source plugin for Grafana
3+
menuTitle: Annotations
4+
description: Learn about annotations for the Google Sheets data source plugin for Grafana
5+
keywords:
6+
- data source
7+
- google sheets
8+
- spreadsheets
9+
- xls data
10+
- xlsx data
11+
- excel sheets
12+
- excel data
13+
- csv data
14+
labels:
15+
products:
16+
- oss
17+
- enterprise
18+
- cloud
19+
weight: 400
20+
---
21+
22+
# Create annotations with Google Sheets data source plugin for Grafana
23+
24+
[Annotations](https://grafana.com/docs/grafana/latest/dashboards/annotations) let you extract data from a data source and use it to annotate a dashboard.
25+
26+
To create annotations, you need to specify at least the following two fields:
27+
28+
- A String field for the annotation text
29+
- A Time field for the annotation time
30+
31+
Annotations overlay events on a graph.
32+
33+
![Annotations on a graph](/media/docs/grafana/data-sources/github/annotations.png)
34+
35+
With annotations, you can display the following GitHub resources on a graph:
36+
37+
- Commits
38+
- Issues
39+
- Pull requests
40+
- Releases
41+
- Tags
42+
43+
All annotations require that you select a field to display on the annotation, and a field that represents the time that the event occurred.
44+
45+
![Annotations editor](/media/docs/grafana/data-sources/github/annotations-editor.png)
46+
47+
If you want to add titles or tags to the annotations, you can add additional fields with the appropriate types.
48+
49+
For more information on how to configure a query, refer to [Built-in query editor](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/#built-in-query).
50+
51+
## Pull Requests and Issue times when creating annotations
52+
53+
While using annotations for pull request and issues, there two selection options. This is because as there are two times that affect an annotation:
54+
55+
- The time range of the dashboard or panel
56+
- The time that should be used to display the event on the graph
57+
58+
The first selection is used to filter the events that display on the graph.
59+
60+
For example, if you select "closed at", only events that were "closed" in your dashboard's time range will be displayed on the graph.
61+
62+
The second selection is used to determine where on the graph the event should be displayed.
63+
64+
Typically these will be the same, however there are some cases where you may want them to be different.

0 commit comments

Comments
 (0)