New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Annotations on a single panel #717

Open
feangulo opened this Issue Aug 22, 2014 · 40 comments

Comments

Projects
None yet
@feangulo

feangulo commented Aug 22, 2014

Currently we have the option to define annotations that will be applied to all panels in a dashboard. It would be convenient to also have the option to create an annotation that could be applied to only a single panel inside a dashboard.

It could be an additional option when the user enters "Edit" mode in a particular Graphite panel.

@sahilthapar

This comment has been minimized.

sahilthapar commented Aug 22, 2014

👍

1 similar comment
@acesaro

This comment has been minimized.

acesaro commented Aug 22, 2014

👍

@sethdmoore

This comment has been minimized.

sethdmoore commented Dec 2, 2014

👍
Or just add in drawAsInfinite() - I don't understand why this isn't part of Grafana already

@torkelo

This comment has been minimized.

Member

torkelo commented Dec 2, 2014

@sethdmoore drawAsInfinite is not supported in Grafana because the graphite json api does not support it (it is function that only has effect for the PNG rendering, like the the color function)

@languitar

This comment has been minimized.

Contributor

languitar commented Jul 9, 2015

👍

@faizandfurious

This comment has been minimized.

faizandfurious commented Aug 15, 2015

👍 our grafana dashboard has a timer panel tracking external calls to another service. Having the ability to track deploy annotations of that other service, on just that panel, would be amazing.

@Krinkle

This comment has been minimized.

Contributor

Krinkle commented Sep 22, 2015

Disabling annotations per-graph would be quite useful. Especially for dashboards that include a history graph that is e.g. pinned to "Last 6 months" (when the rest of the dashboard shows the last 24 hours or something like that). Otherwise this history graph is obscured with annotations.

@timgriffiths

This comment has been minimized.

timgriffiths commented Oct 12, 2015

+1

7 similar comments
@vinhlh

This comment has been minimized.

vinhlh commented Oct 16, 2015

👍

@krise3k

This comment has been minimized.

Contributor

krise3k commented Oct 16, 2015

+1

@pavleec

This comment has been minimized.

pavleec commented Oct 28, 2015

👍

@sckevmit

This comment has been minimized.

sckevmit commented Oct 31, 2015

👍

@addshore

This comment has been minimized.

Contributor

addshore commented Nov 18, 2015

+1

@mtanda

This comment has been minimized.

Collaborator

mtanda commented Jan 4, 2016

+1

@ygbr

This comment has been minimized.

ygbr commented Jan 26, 2016

+1

@sslupsky

This comment has been minimized.

sslupsky commented Feb 26, 2016

+1

1 similar comment
@rubycut

This comment has been minimized.

Contributor

rubycut commented Mar 4, 2016

+1

@mtanda

This comment has been minimized.

Collaborator

mtanda commented Mar 4, 2016

Supporting this is not so difficult.
I already sent PR #3976. (and close the PR to wait alert feature)
If anyone want to use this ASAP, import above PR and build Grafana locally.

@GrzegorzWild

This comment has been minimized.

GrzegorzWild commented Jun 10, 2016

+1

@torkelo torkelo referenced this issue Jul 2, 2016

Closed

enable/disable annotations per panel #5490

1 of 1 task complete
@petevk

This comment has been minimized.

petevk commented Jul 27, 2016

+1

@n0rad

This comment has been minimized.

n0rad commented Sep 6, 2016

+1

1 similar comment
@andyhollin

This comment has been minimized.

andyhollin commented Sep 30, 2016

+1

@pdf

This comment has been minimized.

pdf commented Sep 30, 2016

Please don't add +1 comments, just add a thumbs-up to the original issue description if you wish to express your support, otherwise you just spam everyone who is subscribed to the issue.

@kylebrandt

This comment has been minimized.

kylebrandt commented Oct 17, 2016

As noted in #6298 this will also fix the ability to have annotations show up on a panel that has been time-shifted.

@danievanzyl

This comment has been minimized.

danievanzyl commented Nov 22, 2016

when will this feature be available?

@torkelo

This comment has been minimized.

Member

torkelo commented Nov 22, 2016

when it's implemented :)

So no ETA at the moment :(

@cherweg

This comment has been minimized.

cherweg commented Feb 17, 2017

+1

2 similar comments
@robinong79

This comment has been minimized.

robinong79 commented Feb 20, 2017

+1

@dkruyt

This comment has been minimized.

dkruyt commented Mar 5, 2017

+1

@LeDistordu

This comment has been minimized.

LeDistordu commented Jun 26, 2017

+1

@bgruenefeld

This comment has been minimized.

bgruenefeld commented Aug 24, 2017

+1

1 similar comment
@zicklam

This comment has been minimized.

Contributor

zicklam commented Nov 15, 2017

+1

@Wyatts

This comment has been minimized.

Wyatts commented Dec 8, 2017

PR #3976 linked above has a comment that this feature needs to wait for alerting. (Why?) Is alerting in a state where this can be revisited, yet?

It's been over three years since this bug was opened and almost two years since that PR which apparently addressed the main issue. If it still applies and works, would it be possible to merge it as a stopgap?

@HerveMARTIN

This comment has been minimized.

HerveMARTIN commented Dec 11, 2017

We have the same request here, it seems the good way to use template variables in annotation queries.
In a dashboard approach, dealing with multiple values (concat all values in tags as mentioned by PR #9864) won't match some use cases like dashboard with repeating panel or rows.

@zer0master

This comment has been minimized.

zer0master commented Feb 19, 2018

I have a strong interest in seeing this realized, as well as being curious now that alerting is in place, why per-panel annotations are not.

Grafana: 4.6.3
InfluxDB: 1.3.6

Here's my use case: as part of a devops group, we maintain multiple virtual environments for development and QA activities. We're making progress with Grafana and InfluxDB in persisting various functional and end-to-end sanity test results to raise visibility on downtime, and ultimately to identify the causes for it.

We need the annotation range that Grafana's native annotations support to visually show duration of downtime to interested groups. Influx appears only capable of point-in-time annotations, which is fine for software drops, but not this particular type of information (in our opinion).

As part of making such updates as easy as possible, we're using a Hubot-based Slack integration to target specific sanity history panels with start/end, essentially a CRUD-based system. We cross-reference user-friendly environment names to the corresponding dashboard/panel IDs to make annotations appear in their associated graph.

What we're finding is that tag queries will let us have differing colors, ideally to distinguish between maintenance and outage windows, but at the expense of appearing on all such panels on the dashboard.

I'm also examining an alternative of embedding the history graphs from their own dashboards in this executive summary, but I seem to lose the per-panel behavior that the dashboard only query provides. We aren't using repeated panels much, though the history graph is currently defined that way; could that be contributing to the problem?

I suppose my questions are as follows:

  • have per-panel annotations been tabled indefinitely, and if so, why? based on the number of upvotes here, it seems many users want them, though perhaps for reasons different from my own
  • is there currently a way to get this effect of per-panel annotations and tag-query specific colors in one dashboard without the "one annotation for all" effect? if not, is there a viable alternative?
  • have I overlooked some obvious answer in my attempts? based on the fact that annotation settings appear to be a top-level menu choice, I have assumed to date that I have not

We are thrilled with Grafana for the most part, but this lack of configurabiltiy is becoming a pain point for our organization.

UPDATE: I have found a workaround, with the help of my boss who suggested trying it...

Using tag queries that employ multiple tags, where at least one is specific to annotation tags intended for a specific panel, gives us a form of control that we're looking for. In our case we are using tags that are assigned one per monitored environment (eg., XDEV1, XDEV2, etc.), while the others are event-specific (issue, rehydrate, etc.). We also disable the builtin annotation query on each affected dashboard.

By creating annotation tag queries with the 'environment' tag specific to the dashboard, and varying the event type (each with a distinct color), we can get the visual effect we're looking for.

This is at the expense of creating multiple dashboards that differ only in the metric query's use of the environment tag with an associated set of annotation queries. While potentially a lot of maintenance, we can conceivably create a mashup of these using iframe elements, and if necessary, calculate and set specific time ranges via a separate server-side page.

Hopefully this helps anyone else that finds a need for this sort of use case.

@jmarceli

This comment has been minimized.

jmarceli commented Mar 2, 2018

It seems to be supported but only for annotations created via API. See: http://docs.grafana.org/http_api/annotations/#create-annotation

{
  "dashboardId":468,
  "panelId":1,
  "time":1507037197339,
  "isRegion":true,
  "timeEnd":1507180805056,
  "tags":["tag1","tag2"],
  "text":"Annotation Description"
}

dashboardId and panelId params allows to specify exact panel where annotation will appear. It doesn't solve the issue if you want to use annotation query but it might be some kind of workaround.

While this workaround works it is limited as annotations are bound to the panel so once you delete the panel your annotations are gone.

@calebtote

This comment has been minimized.

Contributor

calebtote commented Apr 26, 2018

The above isn't exactly correct -- at least not when using annotation queries. For the example above, if you have an annotation query that looks for tag1, the panelId stored in the DB is disregarded, and the annotation for tag1 will be drawn on every panel on the dashboard.

@gauravk48

This comment has been minimized.

gauravk48 commented Sep 20, 2018

I have a similar need where I want to invoke a different annotation query for each panel in the dashboard. I don't see any way to do it. Can someone give some pointers?

How can we define multiple queries at the dashboard level and on/off them for each panel? Is there a way to get that working?

Thanks

@calebtote

This comment has been minimized.

Contributor

calebtote commented Sep 20, 2018

It's not currently a feature in native Grafana unforunately @gauravk48 -- our team (as in where I work, not Grafana) has an internal feature to add this support. If we finish before Grafana, I'll integrate it -- ETA for us though is still multiple months out.

@gauravk48

This comment has been minimized.

gauravk48 commented Sep 20, 2018

Thanks @calebtote for your reply.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment