Annotations: Support filtering the target panels #66325

ryantxu · 2023-04-11T21:40:06Z

Fixes #717

This PR updates the annotations system to support filtering which panels should get the data:

From the annotations editor you can now select where to show the annotations:

Then annotations are only sent to the selected panels:

TODO:

this PR also includes changes to the testdata annotations... that could be moved to its own PR -> TestData Annotation changes PR (Testdata: Update testdata annotations editor #66620) ✅
this also tries to use the schema defined from cue -- also could be its own PR 🤷‍♂️
improve editor UI ✅

github-actions · 2023-04-12T00:31:58Z

⚠️ Possible breaking changes

(Open the links below in a new tab to go to the correct steps)

grafana-data has possible breaking changes (more info)
grafana-schema has possible breaking changes (more info)

Console output
Read our guideline

ryantxu · 2023-04-12T18:15:27Z

kinds/dashboard/dashboard_kind.cue

-				annotations?: {
+
+				// TODO -- should not be a public interface on its own, but required for Veneer
+				#AnnotationContainer: {


@sdboyer -- thoughts on how to best handle this? a nested type AnnotationQuery.target needs a Veneer... but that sets off a cascade of all the parents needing one also

the cascade being this change, for example? https://github.com/grafana/grafana/pull/66325/files#diff-932ad9420b4f3774837637528ee5bfe0ac3581cca3c5fdad61beb944aedbc45aR33

nope, no current or planned way around that. Would require the sort of generics support in cuetsy that i haven't yet seen what i consider to be a feasible proposal

not a huge deal -- just checking that I am not missing anything.

ryantxu · 2023-04-12T18:16:49Z

kinds/dashboard/dashboard_kind.cue

+
+					// unless datasources have migrated to the target+mapping,
+					// thhey just spread their query into the base object :(
+					...


@sdboyer is this the accepted choice for "or anything else" here?

Yep, if we have to accept unknown fields being spilled in here as valid, this is how to mark it.

It may be possible to not do this if it's possible for us to know at schema-time whether the datasource plugin in question has done the "target+mapping migration" you mention in the comment (idk what that is). That would be analogous to how if we encounter a panel that's from a plugin for which we have no composable kind, we let the options field be anything/unrestricted

sdboyer · 2023-04-13T10:24:18Z

kinds/dashboard/dashboard_kind.cue

 				#AnnotationTarget: {
-					limit:    int64
+					// Only required/valid for the grafana datasource... 


we could potentially model this special case directly, here in schema - but it would be preferable to refactor the grafana datasource to avoid such hacks

torkelo · 2023-04-14T05:24:32Z

public/app/features/dashboard/components/AnnotationSettings/AnnotationSettingsEdit.tsx

+  const panels: Array<SelectableValue<number>> = useMemo(
+    () =>
+      dashboard?.panels
+        .map((panel) => ({
+          value: panel.id,
+          label: panel.title ?? `Panel ${panel.id}`,
+          description: panel.description,
+          imgUrl: config.panels[panel.type].info.logos.small,
+        }))
+        .sort((a, b) => (a.label > b.label ? 1 : -1)) ?? [],
+    [dashboard]
+  );


a way to move this to DashboardModel and maybe we can reuse this in the Shared dashboard query editor?

It looks a bit different, hm..

…#66671) remove localStorage mock which doesn't work in node v18.16.0

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>

* clean up navmodel interface * remove concept of sections from NavModel interface * clean up applinks

…#66281) * TimePicker: Fixes issues with "Recently used absolute ranges" section Squashed commit of the following: commit 99d5076 Author: Joao Silva <joao.silva@grafana.com> Date: Tue Apr 11 14:06:27 2023 +0100 user essentials mob! :trident: lastFile:public/app/core/components/TimePicker/TimePickerWithHistory.tsx commit cad0201 Author: eledobleefe <laura.fernandez@grafana.com> Date: Tue Apr 11 11:44:34 2023 +0200 user essentials mob! :trident: lastFile:public/app/core/components/TimePicker/TimePickerWithHistory.tsx Co-authored-by: eledobleefe <laura.fernandez@grafana.com> * TimePicker: Add correct date format * Add convertRawToRange tests * Rename test variables * RTL tests * Proper RTL tests * Apply suggestions from code review Co-authored-by: Joao Silva <100691367+JoaoSilvaGrafana@users.noreply.github.com> * Remove commented line * Fix linting --------- Co-authored-by: eledobleefe <laura.fernandez@grafana.com> Co-authored-by: Tobias Skarhed <tobias.skarhed@gmail.com> Co-authored-by: Tobias Skarhed <1438972+tskarhed@users.noreply.github.com>

Squashed commit of the following: commit 421bd0b Author: Joao Silva <joao.silva@grafana.com> Date: Tue Apr 4 10:48:04 2023 +0100 user essentials mob! :trident: lastFile:public/app/plugins/panel/annolist/AnnoListPanel.tsx commit 862846a Author: joshhunt <josh@trtr.co> Date: Tue Apr 4 10:35:35 2023 +0100 user essentials mob! :trident: commit 4ddc7fe Author: Tobias Skarhed <tobias.skarhed@gmail.com> Date: Tue Apr 4 11:20:08 2023 +0200 mob next [ci-skip] [ci skip] [skip ci] lastFile:public/app/plugins/panel/annolist/AnnoListPanel.tsx Co-authored-by: joshhunt <josh@trtr.co> Co-authored-by: Tobias Skarhed <tobias.skarhed@gmail.com>

* try a different way to run integration tests * fix formatting * clean test cache again * use previous command * playing around with random commands * dont run tests in parallel yet * use parallel option instead of gomaxprocs * use same package set for redis/memcached; use p=1

This commit adds support for limits and filters to the Prometheus Rules API. Limits: It adds a number of limits to the Grafana flavour of the Prometheus Rules API: - `limit` limits the maximum number of Rule Groups returned - `limit_rules` limits the maximum number of rules per Rule Group - `limit_alerts` limits the maximum number of alerts per rule It sorts Rule Groups and rules within Rule Groups such that data in the response is stable across requests. It also returns summaries (totals) for all Rule Groups, individual Rule Groups and rules. Filters: Alerts can be filtered by state with the `state` query string. An example of an HTTP request asking for just firing alerts might be `/api/prometheus/grafana/api/v1/rules?state=alerting`. A request can filter by two or more states by adding additional `state` query strings to the URL. For example `?state=alerting&state=normal`. Like the alert list panel, the `firing`, `pending` and `normal` state are first compared against the state of each alert rule. All other states are ignored. If the alert rule matches then its alert instances are filtered against states once more. Alerts can also be filtered by labels using the `matcher` query string. Like `state`, multiple matchers can be provided by adding additional `matcher` query strings to the URL. The match expression should be parsed using existing regular expression and sent to the API as URL-encoded JSON in the format: { "name": "test", "value": "value1", "isRegex": false, "isEqual": true } The `isRegex` and `isEqual` options work as follows: | IsEqual | IsRegex | Operator | | ------- | -------- | -------- | | true | false | = | | true | true | =~ | | false | true | !~ | | false | false | != |

nmarrs

LGTM; a few nits but overall this is looking great!

e2e/various-suite/filter-annotations.spec.ts

public/app/features/dashboard/components/AnnotationSettings/AnnotationSettingsEdit.tsx

…6702) Co-authored-by: Leon Sorokin <leeoniya@gmail.com>

Co-authored-by: Leon Sorokin <leeoniya@gmail.com>

Co-authored-by: Ryan McKinley <ryantxu@gmail.com>

ryantxu added 2 commits April 11, 2023 13:33

test data annotations

6f07db2

testdata more annotations

2bb63ac

ryantxu added area/annotations no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes labels Apr 11, 2023

ryantxu added this to the 10.0.0 milestone Apr 11, 2023

ryantxu requested a review from adela-almasan April 11, 2023 21:40

grafanabot added the area/frontend label Apr 11, 2023

ryantxu added 3 commits April 11, 2023 15:23

Merge remote-tracking branch 'origin/main' into filter-annotations

41331ff

set the number of lines

3763ed0

update schemas to add filtering

b3ec15e

grafanabot added area/backend type/docs labels Apr 12, 2023

grafanabot added the levitate breaking change A label indicating a breaking change and assigned by Levitate. label Apr 12, 2023

ryantxu added 2 commits April 11, 2023 18:30

add filtering

2f0d54e

fix backend

45a48ba

ryantxu changed the title ~~TestData: Support more annotation options~~ Annotations: Support filtering the target panels Apr 12, 2023

add devenv dashboard

864964f

ryantxu commented Apr 12, 2023

View reviewed changes

ryantxu and others added 4 commits April 12, 2023 11:58

add devenv dashboar

c943603

Merge branch 'main' into filter-annotations

75b7bd2

strip nulls

b00ce2c

add multi select

9e99ac9

sdboyer reviewed Apr 13, 2023

View reviewed changes

adela-almasan and others added 2 commits April 13, 2023 12:50

Merge branch 'main' into filter-annotations

3692757

update cue types

2c08c51

torkelo requested a review from Ijin08 April 14, 2023 05:23

torkelo reviewed Apr 14, 2023

View reviewed changes

ashharrison90 and others added 8 commits April 17, 2023 15:33

Chore: remove localStorage mock which doesn't work in node v18.16.0 (…

b7222bd

…#66671) remove localStorage mock which doesn't work in node v18.16.0

Alerting: Split silences view expired/not-expired (#66562)

ccf3ac9

Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>

Chore: Clean up NavModel interface (#66548)

c24be71

* clean up navmodel interface * remove concept of sections from NavModel interface * clean up applinks

Merge branch 'main' into filter-annotations

49e95b1

adela-almasan requested a review from grafanabot as a code owner April 17, 2023 20:54

Fix up spelling in dashboard_kinda cue file

aa827d8

nmarrs approved these changes Apr 18, 2023

View reviewed changes

nmarrs and others added 11 commits April 17, 2023 20:09

Fix annotation settings unit test

9b271d6

Fix remaining annotation settings unit test

d8a1a53

Fix another unit test

59dc805

FieldValues: Use simple array in transformations and grafana/data (#6…

8c72905

…6702) Co-authored-by: Leon Sorokin <leeoniya@gmail.com>

FieldValues: Use simple array in panel visualizations (#66706)

a5135e6

Co-authored-by: Leon Sorokin <leeoniya@gmail.com>

Testdata: Update testdata annotations editor (#66620)

00b9ae6

Co-authored-by: Ryan McKinley <ryantxu@gmail.com>

Merge branch 'main' into filter-annotations

d11c507

fix tests

3b9c3f8

updated e2e test

8a1de75

Merge branch 'main' into filter-annotations

ffa645e

updated description

07a46df

adela-almasan approved these changes Apr 18, 2023

View reviewed changes

run make gen-cue command to fix schema build step

4dc2ae3

adela-almasan merged commit 9452c0d into main Apr 18, 2023
15 of 16 checks passed

adela-almasan deleted the filter-annotations branch April 18, 2023 20:39

zerok modified the milestones: 10.0.0, 10.0.0-preview May 31, 2023

fetzerch mentioned this pull request Aug 26, 2023

Sunrise and sunset per panel option fetzerch/grafana-sunandmoon-datasource#57

Closed

leeoniya mentioned this pull request Nov 18, 2023

Allow annotations per panel #78366

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Annotations: Support filtering the target panels #66325

Annotations: Support filtering the target panels #66325

ryantxu commented Apr 11, 2023 •

edited by nmarrs

github-actions bot commented Apr 12, 2023 •

edited

ryantxu Apr 12, 2023

sdboyer Apr 13, 2023

ryantxu Apr 13, 2023

ryantxu Apr 12, 2023

sdboyer Apr 13, 2023

sdboyer Apr 13, 2023

torkelo Apr 14, 2023

torkelo Apr 14, 2023

nmarrs left a comment

Annotations: Support filtering the target panels #66325

Annotations: Support filtering the target panels #66325

Conversation

ryantxu commented Apr 11, 2023 • edited by nmarrs

github-actions bot commented Apr 12, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nmarrs left a comment

Choose a reason for hiding this comment

ryantxu commented Apr 11, 2023 •

edited by nmarrs

github-actions bot commented Apr 12, 2023 •

edited