DashboardList: Enable templating on search tag input #31460

delta50 · 2021-02-25T03:12:32Z

What this PR does / why we need it:

Now it is possible to pass variables to the search tag input field of the dashlist config. This is useful when you have a generic dashboard and would like to use the templating feature for showing only the relevant dashboards in the list depending on a variable value.

Which issue(s) this PR fixes:

Fixes: #29028
Relates #18113 #18167

Special notes for your reviewer:
This is an updated version of this outdated PR #18167

CLAassistant · 2021-02-25T03:12:35Z

All committers have signed the CLA.

dprokop

@delta50 thanks for the contribution. I've tested it and it seems like it works as expected.

Few things before we can merge this.

Docs needs to be updated (

grafana/docs/sources/panels/visualizations/dashboard-list-panel.md

Line 20 in abee02d

### Options

)
Would be awesome if you could implement tests for this newly added feature
Your co-committer needs to sign CLA agreement (andrew.riedel@deepintent.com - I assume it's you) :)

Additionally- since the change does not seem to be a big one - could you also add the variables interpolation to the search query input?

delta50 · 2021-03-02T01:26:22Z

@dprokop I have added the variable interpolation to the query field, added documentation, and fixed the commit author.

I'm not sure where the tests for this would live, or what kind of tests you had in mind. Could you provide more info on what this would look like?

achatterjee-grafana

Added some copy edit suggestions, code changes will need a review from engineers.

docs/sources/panels/visualizations/dashboard-list-panel.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

torkelo · 2021-03-03T09:03:24Z

public/app/plugins/panel/dashlist/DashList.tsx

    const params = {
      limit: options.maxItems,
-      query: options.query,
+      query: /^\$.+/.test(options.query) ? replaceVars(options.query, {}, 'text') : options.query,


always pass it through replaceVars, there are multiple syntaxes so testing if the string contains variables is not needed

This is done and the documentation has been updated.

oddlittlebird · 2021-03-04T21:39:29Z

This needs a milestone. Is it slated for 7.5?

delta50 · 2021-03-08T14:57:06Z

I would very much appreciate if this was able to go out in 7.5 as it is will help simplify our grafana setup significantly. If there is anything left to do let me know and I can knock it out ASAP.

achatterjee-grafana

One minor copy-edit suggestion. Otherwise doc content looks Ok.

docs/sources/panels/visualizations/dashboard-list-panel.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

delta50 · 2021-03-17T12:54:59Z

Hey @torkelo, is this good to go or are there more changes required?

hugohaggmark · 2021-03-18T07:03:13Z

Hey @torkelo, is this good to go or are there more changes required?

Hi @delta50 I think you need to fix the build errors, seems to be prettier errors.

delta50 · 2021-03-18T16:04:17Z

Hey @torkelo, is this good to go or are there more changes required?

Hi @delta50 I think you need to fix the build errors, seems to be prettier errors.

This is fixed, my yarn setup was not correct, so I was assuming these errors were due to something outside my PR.

docs/sources/panels/visualizations/dashboard-list-panel.md

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>

* master: (168 commits) Fix loading timezone info on windows (grafana#32029) Remove datalink template suggestions for accessing specific fields when there are multiple dataframes. (grafana#32057) AlertingNG: Refactor notifier to support config reloads (grafana#32099) Chore: Replace Command dispatches by explicit calls (grafana#32131) MixedDataSource: Name is updated when data source variable changes (grafana#32090) Plugin: PanelRenderer and simplified QueryRunner to be used from plugins. (grafana#31901) DashboardList: Enable templating on search tag input (grafana#31460) release notes v7.3.10 and v7.4.5 (grafana#32135) Alerting: Add database table for persisting alerting configuration (grafana#32042) latest updated to 7.4.5 (grafana#32132) changelog v7.4.5 (grafana#32110) Chore: Tidy up Go deps (grafana#32127) Explore: Support full inspect drawer (grafana#32005) GraphNG: make sure dataset and config are in sync when initializing and re-initializing uPlot (grafana#32106) Login: Replace command dispatch by explicit call (grafana#32088) Loki: Label browser UI updates (grafana#31737) AlertingNG: Notification channel for emails (grafana#31768) Alerting: Enable Alert rule `severity` tag to override VictorOps Severity setting (grafana#29392) Docs: updates developer guide with useful resources for windows setup (grafana#32075) SQLStore: Close session in withDbSession (grafana#31775) ...

* Add variable interpolation for dashlist panel. * Update docs/sources/panels/visualizations/dashboard-list-panel.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Fix variable interpolation for dashlist panel to work with all syntax. * Update docs/sources/panels/visualizations/dashboard-list-panel.md Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> * Fix prettier issues. * Fix prettier issues. * Update docs/sources/panels/visualizations/dashboard-list-panel.md Co-authored-by: Torkel Ödegaard <torkel@grafana.com> Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> Co-authored-by: Torkel Ödegaard <torkel@grafana.com>

delta50 requested review from a team, thisisobate and torkelo and removed request for a team February 25, 2021 03:12

delta50 mentioned this pull request Feb 25, 2021

DashboardList - Enables templating on search tag input #18167

Closed

hugohaggmark added the pr/external This PR is from external contributor label Feb 25, 2021

hugohaggmark self-requested a review February 25, 2021 04:58

hugohaggmark added the area/panel/dashboard-list label Feb 25, 2021

dprokop requested changes Feb 25, 2021

View reviewed changes

dprokop added this to the 7.5.0 milestone Feb 25, 2021

delta50 force-pushed the add-dashlist-vars branch from 959756d to 4cf782a Compare March 2, 2021 01:22

delta50 requested a review from a team as a code owner March 2, 2021 01:22

delta50 requested review from achatterjee-grafana, oddlittlebird and osg-grafana and removed request for a team March 2, 2021 01:22

Add variable interpolation for dashlist panel.

b4be2ce

delta50 force-pushed the add-dashlist-vars branch from 4cf782a to b4be2ce Compare March 2, 2021 01:27

Merge branch 'master' into add-dashlist-vars

617e6f1

delta50 requested a review from dprokop March 2, 2021 03:26

achatterjee-grafana suggested changes Mar 2, 2021

View reviewed changes

docs/sources/panels/visualizations/dashboard-list-panel.md Outdated Show resolved Hide resolved

Update docs/sources/panels/visualizations/dashboard-list-panel.md

5d440cc

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

torkelo requested changes Mar 3, 2021

View reviewed changes

wbrowne changed the title ~~DashboardList: Enables templating on search tag input~~ DashboardList: Enable templating on search tag input Mar 3, 2021

wbrowne added the add to changelog label Mar 3, 2021

torkelo removed this from the 7.5.0-beta1 milestone Mar 3, 2021

Fix variable interpolation for dashlist panel to work with all syntax.

b990b53

delta50 requested a review from torkelo March 4, 2021 17:10

delta50 requested a review from achatterjee-grafana March 4, 2021 17:10

Merge branch 'master' into add-dashlist-vars

93a0aa0

achatterjee-grafana reviewed Mar 8, 2021

View reviewed changes

docs/sources/panels/visualizations/dashboard-list-panel.md Outdated Show resolved Hide resolved

achatterjee-grafana approved these changes Mar 8, 2021

View reviewed changes

Update docs/sources/panels/visualizations/dashboard-list-panel.md

c5737b5

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

Fix prettier issues.

dd93a7f

grafanabot added area/frontend type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project labels Mar 18, 2021

Fix prettier issues.

cf2590e

torkelo approved these changes Mar 18, 2021

View reviewed changes

torkelo reviewed Mar 18, 2021

View reviewed changes

docs/sources/panels/visualizations/dashboard-list-panel.md Outdated Show resolved Hide resolved

Update docs/sources/panels/visualizations/dashboard-list-panel.md

a7006d0

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>

torkelo approved these changes Mar 18, 2021

View reviewed changes

torkelo merged commit 30e5afa into grafana:master Mar 18, 2021

torkelo added this to the 8.0.0 milestone Mar 18, 2021

DashboardList: Enable templating on search tag input #31460

DashboardList: Enable templating on search tag input #31460

Uh oh!

Conversation

delta50 commented Feb 25, 2021

Uh oh!

CLAassistant commented Feb 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dprokop left a comment

Choose a reason for hiding this comment

Uh oh!

delta50 commented Mar 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

achatterjee-grafana left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

torkelo Mar 3, 2021

Choose a reason for hiding this comment

Uh oh!

delta50 Mar 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oddlittlebird commented Mar 4, 2021

Uh oh!

delta50 commented Mar 8, 2021

Uh oh!

achatterjee-grafana left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

delta50 commented Mar 17, 2021

Uh oh!

hugohaggmark commented Mar 18, 2021

Uh oh!

delta50 commented Mar 18, 2021

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

CLAassistant commented Feb 25, 2021 •

edited

Loading

delta50 commented Mar 2, 2021 •

edited

Loading

delta50 Mar 4, 2021 •

edited

Loading