Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
D
docs
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Administrator
docs
Commits
a6c5677e
Commit
a6c5677e
authored
Feb 09, 2015
by
Stuart Nelson
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
add annotations documentation.
parent
de7334c9
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
57 additions
and
1 deletion
+57
-1
.gitignore
.gitignore
+3
-0
promdash.md
content/docs/visualization/promdash.md
+54
-1
annotations_example.png
static/annotations_example.png
+0
-0
annotations_hover.png
static/annotations_hover.png
+0
-0
No files found.
.gitignore
View file @
a6c5677e
...
...
@@ -8,3 +8,6 @@ tmp/
# Crash Log
crash.log
# OS X file
static/.DS_Store
content/docs/visualization/promdash.md
View file @
a6c5677e
...
...
@@ -230,10 +230,63 @@ show `serverID` fields, and never `serverURL`, since any uploaded JSON
containing
`serverURL`
s is transformed immediately to
`serverID`
s before being
saved server-side.
### Annotation tags
Graph widgets have the ability to request annotations by
`tagname`
and then
render them on the graph. If you have a server running that stores events with
a timestamp, you can query it to render annotations on your widgets.
[
![Annotation screenshot
](
/assets/annotations_example.png
)
](/assets/annotations_example.png)
To enable, first select "Display annotation tags" via the global dashboard
setting. Each input can hold an arbitrary number of comma-separated tags that
will be used to query your designated annotations server. Once you have added
your tags you can hide the annotation list by un-checking annotations setting
in the global dashboard settings.
The URL for your annotations server is set via the
`ANNOTATIONS_URL`
environment variable when running PromDash.
When requesting annotations, the following query string parameters are sent to
the annotations server:
-
`until`
: This is the graph's endTime.
-
`range`
: This is the graph's range.
-
`tags[]`
: This is a list of the tags defined on your dashboard.
Each tag input on your dashboard represents a separate query. E.g., if you have
three tag inputs, three requests will be made to your annotations server, each
containing the tags from one input.
The
`until`
and
`range`
parameters define time window displayed by the graph.
Annotations that are returned to PromDash that do not fall within this window
will not be rendered.
The payload returned from the annotation server should conform to this schema:
```
javascript
{
posts
:
[
{
created_at
:
111232553
,
// UNIX timestamp
message
:
"
annotation message here
"
},
// ... more tags
]
}
```
All returned annotation tags will be rendered on every graph. There currently
is no support for rendering specific tags on only a subset of graphs.
Hovering over an annotation on a graph will display the annotation's message
(cf. schema above).
[
![Annotation global config screenshot
](
/assets/annotations_hover.png
)
](/assets/annotations_hover.png)
## TODOs
Add documention about:
*
annotation tags
*
`fullscreen`
/
`fullscreenTitle`
URL parameters
*
document the dashboard JSON format
static/annotations_example.png
0 → 100644
View file @
a6c5677e
26.3 KB
static/annotations_hover.png
0 → 100644
View file @
a6c5677e
21.5 KB
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment