[Dashboard] Inject / extract tag references by nickpeihl · Pull Request #214788 · elastic/kibana

nickpeihl · 2025-03-17T14:26:31Z

Summary

Provides a tags array on the request and response bodies of dashboards.

This allows consumers of the Dashboards HTTP API and internal RPC API to add an array of tag names to the attributes in the body of create and update endpoints. The dashboard server will be responsible for converting the tag names into references in the saved object.

If, during creation or update, a tag name does not have a matching tag saved object, a new tag saved object will be created. If the user lacks permissions to manage tags, then an error will be logged in the server and the tag will not be added to the dashboard.

The server also injects the tag references as an array of tag names in the attributes of the response body of get and search endpoints of the HTTP and RPC APIs.

For backwards compatibility in create and update endpoints, tags can alternatively be specified in the references array in the options instead of (or in addition to) the attributes.tags in the request body. Similarly, for backwards compatibility, tag references are returned in the references of the response body of get and search endpoints.

Client-side tag handling is out of scope for this PR. Dashboards listing page and dashboard settings continue to use the tag references and do not use the tags attribute in the response.

For example:

Here's how we currently create a dashboard with tag references.

## Creating a dashboard with tag references
POST kbn:/api/dashboards/dashboard
{
  "attributes": {
    "title": "my tagged dashboard"
  },
  "references": [
    {
      "type": "tag",
      "id": "37aab5de-a34d-47cb-9aa5-9375d5db595f",
      "name": "tag-ref-37aab5de-a34d-47cb-9aa5-9375d5db595f"
    },
    {
      "type": "tag",
      "id": "5ed29bba-c14d-4302-9a8c-9602e40dbc2a",
      "name": "tag-ref-5ed29bba-c14d-4302-9a8c-9602e40dbc2a"
    },
    {
      "type": "tag",
      "id": "fc7890e8-c00f-44a1-88a2-250e4d27e61d",
      "name": "tag-ref-fc7890e8-c00f-44a1-88a2-250e4d27e61d"
    }
  ]
}

With this PR, creating a dashboard with tags is much simpler.

## Creating a dashboard with tag names
POST kbn:/api/dashboards/dashboard
{
  "attributes": {
    "title": "my tagged dashboard",
    "tags": [
      "boo",
      "foo",
      "bingo",
      "bongo"
    ]
  }
}

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

Unit or functional tests were updated or added to match the most common scenarios
The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

If there are more than one tag saved objects with the same name, only one of the tag references will be added to the saved object when creating a dashboard. Creating tags with duplicate names are not permitted via the UI. But there is no such restrictions when creating tags from imported saved objects. Having multiple tags with the same name is an edge case that Kibana guards against with reasonable restrictions, so I think we should not be too concerned about it.
...

…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/streams --include-path /api/fleet --include-path /api/dashboards --update'

…ling-tags

TinaHeiligers

Core-related changes (test fixtures) LGTM.

elasticmachine · 2025-03-25T14:56:42Z

Pinging @elastic/kibana-presentation (Team:Presentation)

ThomThomson

Great work! Tested this locally in chrome by creating and updating a Dashboard SO via the API through devtools. Also tested that tags generated this way were treated the same + looked the same in the SO Management page as tags created via the UI.

Looked through the code and left a few questions, but otherwise everything looks pretty straightforward. Lots of test coverage added, which is very nice!

ThomThomson · 2025-03-26T18:22:19Z

src/platform/plugins/shared/dashboard/public/dashboard_api/get_serialized_state.ts

    { embeddablePersistableStateService: embeddableService }
  );

+  // TODO Provide tags as an array of tag names in the attribute. In that case, tag references


Do we have a followup issue for this?

ThomThomson · 2025-03-26T18:33:51Z

src/platform/plugins/shared/dashboard/server/content_management/v2/cm_services.ts

      data: {
        schema: dashboardAttributesSchema,
-        up: (data: DashboardCrudTypes['CreateIn']['data']) => attributesTov3(data),
+        up: (data: DashboardCrudTypes['CreateIn']['data']) => attributesTov3(data, [], () => []),


Why do we pass a blank references array here?

Ah, those are now optional parameters. The content management up transforms do not supply references so we only transform the attributes. Fixed in ff8e17a.

ThomThomson · 2025-03-26T18:39:13Z

src/platform/test/api_integration/apis/dashboards/create_dashboard/main.ts

      expect(response.body.item.attributes.panels).to.be.an('array');
    });

+    describe('create a dashboard with tags', () => {


Great to see a new API Integration test added!

This allows saved object migrations to continue to use the synchronous itemAttrsToSavedObject function since they don't have a need for tag creation.

dominiqueclarke · 2025-03-28T18:05:29Z

Will this require updating to a new version of the content management api? We're currently using version 3.

elasticmachine · 2025-03-31T14:53:04Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: c4362c3

Failed CI Steps

Jest Tests #4

Test Failures

[job] [logs] Jest Tests #4 / TemplatesList renders template details correctly

Metrics [docs]

✅ unchanged

History

💔 Build #288298 failed fc9e0e7
💔 Build #288225 failed aee4199
💔 Build #288201 failed b1645c7
💔 Build #288167 failed ff8e17a
💔 Build #286710 failed bfe95bd
💔 Build #286283 failed 3095adb

Fixes elastic#210619 ## Summary Provides a tags array on the request and response bodies of dashboards. This allows consumers of the Dashboards HTTP API and internal RPC API to add an array of tag names to the attributes in the body of create and update endpoints. The dashboard server will be responsible for converting the tag names into references in the saved object. If, during creation or update, a tag name does not have a matching tag saved object, a new tag saved object will be created. If the user lacks permissions to manage tags, then an error will be logged in the server and the tag will not be added to the dashboard. The server also injects the tag references as an array of tag names in the attributes of the response body of get and search endpoints of the HTTP and RPC APIs. For backwards compatibility in create and update endpoints, tags can alternatively be specified in the `references` array in the options instead of (or in addition to) the `attributes.tags` in the request body. Similarly, for backwards compatibility, tag references are returned in the `references` of the response body of get and search endpoints. Client-side tag handling is out of scope for this PR. Dashboards listing page and dashboard settings continue to use the tag references and do not use the `tags` attribute in the response. For example: Here's how we currently create a dashboard with tag references. ``` ## Creating a dashboard with tag references POST kbn:/api/dashboards/dashboard { "attributes": { "title": "my tagged dashboard" }, "references": [ { "type": "tag", "id": "37aab5de-a34d-47cb-9aa5-9375d5db595f", "name": "tag-ref-37aab5de-a34d-47cb-9aa5-9375d5db595f" }, { "type": "tag", "id": "5ed29bba-c14d-4302-9a8c-9602e40dbc2a", "name": "tag-ref-5ed29bba-c14d-4302-9a8c-9602e40dbc2a" }, { "type": "tag", "id": "fc7890e8-c00f-44a1-88a2-250e4d27e61d", "name": "tag-ref-fc7890e8-c00f-44a1-88a2-250e4d27e61d" } ] } ``` With this PR, creating a dashboard with tags is much simpler. ``` ## Creating a dashboard with tag names POST kbn:/api/dashboards/dashboard { "attributes": { "title": "my tagged dashboard", "tags": [ "boo", "foo", "bingo", "bongo" ] } } ``` ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] If there are more than one tag saved objects with the same name, only one of the tag references will be added to the saved object when creating a dashboard. Creating tags with duplicate names are not permitted via the UI. But there is no such restrictions when creating tags from imported saved objects. Having multiple tags with the same name is an edge case that Kibana guards against with reasonable restrictions, so I think we should not be too concerned about it. - [ ] ... --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2025-04-08T12:34:00Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/14333621427

kibanamachine · 2025-04-08T12:34:06Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/14333621459

kibanamachine · 2025-04-08T12:39:52Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts You might need to backport the following PRs to 8.x: - [Dashboard] Remove mSearch from content management (#210709) - [Dashboards] Provide a method for fetching dashboards on the Dashboard server plugin contract (#209678)

Manual backport

To create the backport manually run:

node scripts/backport --pr 214788

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2025-04-08T13:14:17Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts You might need to backport the following PRs to 8.x: - [Dashboard] Remove mSearch from content management (#210709) - [Dashboards] Provide a method for fetching dashboards on the Dashboard server plugin contract (#209678)

Manual backport

To create the backport manually run:

node scripts/backport --pr 214788

Questions ?

Please refer to the Backport tool documentation

Fixes elastic#210619 ## Summary Provides a tags array on the request and response bodies of dashboards. This allows consumers of the Dashboards HTTP API and internal RPC API to add an array of tag names to the attributes in the body of create and update endpoints. The dashboard server will be responsible for converting the tag names into references in the saved object. If, during creation or update, a tag name does not have a matching tag saved object, a new tag saved object will be created. If the user lacks permissions to manage tags, then an error will be logged in the server and the tag will not be added to the dashboard. The server also injects the tag references as an array of tag names in the attributes of the response body of get and search endpoints of the HTTP and RPC APIs. For backwards compatibility in create and update endpoints, tags can alternatively be specified in the `references` array in the options instead of (or in addition to) the `attributes.tags` in the request body. Similarly, for backwards compatibility, tag references are returned in the `references` of the response body of get and search endpoints. Client-side tag handling is out of scope for this PR. Dashboards listing page and dashboard settings continue to use the tag references and do not use the `tags` attribute in the response. For example: Here's how we currently create a dashboard with tag references. ``` ## Creating a dashboard with tag references POST kbn:/api/dashboards/dashboard { "attributes": { "title": "my tagged dashboard" }, "references": [ { "type": "tag", "id": "37aab5de-a34d-47cb-9aa5-9375d5db595f", "name": "tag-ref-37aab5de-a34d-47cb-9aa5-9375d5db595f" }, { "type": "tag", "id": "5ed29bba-c14d-4302-9a8c-9602e40dbc2a", "name": "tag-ref-5ed29bba-c14d-4302-9a8c-9602e40dbc2a" }, { "type": "tag", "id": "fc7890e8-c00f-44a1-88a2-250e4d27e61d", "name": "tag-ref-fc7890e8-c00f-44a1-88a2-250e4d27e61d" } ] } ``` With this PR, creating a dashboard with tags is much simpler. ``` ## Creating a dashboard with tag names POST kbn:/api/dashboards/dashboard { "attributes": { "title": "my tagged dashboard", "tags": [ "boo", "foo", "bingo", "bongo" ] } } ``` ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] If there are more than one tag saved objects with the same name, only one of the tag references will be added to the saved object when creating a dashboard. Creating tags with duplicate names are not permitted via the UI. But there is no such restrictions when creating tags from imported saved objects. Having multiple tags with the same name is an edge case that Kibana guards against with reasonable restrictions, so I think we should not be too concerned about it. - [ ] ... --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit c4f7c64) # Conflicts: # src/platform/plugins/shared/dashboard/server/content_management/dashboard_storage.ts # src/platform/plugins/shared/dashboard/server/plugin.ts

nickpeihl · 2025-04-08T20:48:24Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine · 2025-04-09T12:49:56Z

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

# Backport This will backport the following commits from `main` to `8.x`: - [[Dashboard] Inject / extract tag references (#214788)](#214788)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

…Start server api (#217586) ## Summary Changes the DashboardStart server api to provide a getContentClient function. In #214788, we set the `contentClient` returned from the content management register method after start lifecycle of all plugins. This means the `contentClient` returned from the `DashboardStart` contract was undefined. This PR changes the start contract to provide a getContentClient function instead. Only one consumer was using the contentClient from DashboardStart and this PR also updates that consumer.

…Start server api (elastic#217586) ## Summary Changes the DashboardStart server api to provide a getContentClient function. In elastic#214788, we set the `contentClient` returned from the content management register method after start lifecycle of all plugins. This means the `contentClient` returned from the `DashboardStart` contract was undefined. This PR changes the start contract to provide a getContentClient function instead. Only one consumer was using the contentClient from DashboardStart and this PR also updates that consumer. (cherry picked from commit 72d18d8) # Conflicts: # x-pack/solutions/observability/plugins/observability/server/routes/alerts/route.ts

…hboardStart server api (#217586) (#217989) # Backport This will backport the following commits from `main` to `8.x`: - [[Dashboards] Replace contentClient with getContentClient on DashboardStart server api (#217586)](#217586)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

…n array of tag saved object ids (#233541) Part of #216346 #214788 updated dashboard CRUD API read `attributes.tags` as an array of tag names and write `attributes.tags` as an array of tag names. Returning `attributes.tags` as an array of tag names breaks the link between the tag saved object. Instead, `attributes.tags` should be an array of tag ids. #214788 updated dashboard CRUD API with a side effect where if a tag saved object did not exist for a tag name, then a tag saved object would be created for the tag name. APIs should not have side effects like this. This PR updates dashboard CRUD API read `attributes.tags` as an array of tag ids and write `attributes.tags` as an array of tag ids to avoid breaking the link between tag saved objects. The PR also removes the ability for the dashboard CRUD APIs to create tag saved objects. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

…n array of tag saved object ids (elastic#233541) Part of elastic#216346 elastic#214788 updated dashboard CRUD API read `attributes.tags` as an array of tag names and write `attributes.tags` as an array of tag names. Returning `attributes.tags` as an array of tag names breaks the link between the tag saved object. Instead, `attributes.tags` should be an array of tag ids. elastic#214788 updated dashboard CRUD API with a side effect where if a tag saved object did not exist for a tag name, then a tag saved object would be created for the tag name. APIs should not have side effects like this. This PR updates dashboard CRUD API read `attributes.tags` as an array of tag ids and write `attributes.tags` as an array of tag ids to avoid breaking the link between tag saved objects. The PR also removes the ability for the dashboard CRUD APIs to create tag saved objects. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

…n array of tag saved object ids (#233541) Part of #216346 #214788 updated dashboard CRUD API read `attributes.tags` as an array of tag names and write `attributes.tags` as an array of tag names. Returning `attributes.tags` as an array of tag names breaks the link between the tag saved object. Instead, `attributes.tags` should be an array of tag ids. #214788 updated dashboard CRUD API with a side effect where if a tag saved object did not exist for a tag name, then a tag saved object would be created for the tag name. APIs should not have side effects like this. This PR updates dashboard CRUD API read `attributes.tags` as an array of tag ids and write `attributes.tags` as an array of tag ids to avoid breaking the link between tag saved objects. The PR also removes the ability for the dashboard CRUD APIs to create tag saved objects. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

…n array of tag saved object ids (elastic#233541) Part of elastic#216346 elastic#214788 updated dashboard CRUD API read `attributes.tags` as an array of tag names and write `attributes.tags` as an array of tag names. Returning `attributes.tags` as an array of tag names breaks the link between the tag saved object. Instead, `attributes.tags` should be an array of tag ids. elastic#214788 updated dashboard CRUD API with a side effect where if a tag saved object did not exist for a tag name, then a tag saved object would be created for the tag name. APIs should not have side effects like this. This PR updates dashboard CRUD API read `attributes.tags` as an array of tag ids and write `attributes.tags` as an array of tag ids to avoid breaking the link between tag saved objects. The PR also removes the ability for the dashboard CRUD APIs to create tag saved objects. --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

Inject / extract tag references

b02570f

nickpeihl mentioned this pull request Mar 17, 2025

[Dashboards] Inject/extract references on server #206654

Draft

15 tasks

nickpeihl and others added 7 commits March 18, 2025 16:27

Fixes

16e760e

[CI] Auto-commit changed files from 'node scripts/notice'

4ffe843

[CI] Auto-commit changed files from 'make api-docs'

bac5e56

Merge branch 'main' into refHandling-tags

8c95da2

Add api integration tests with tags

dac9d75

Create tag if saved object matching tag name not found

3095adb

TinaHeiligers self-requested a review March 24, 2025 14:46

nickpeihl marked this pull request as ready for review March 24, 2025 15:14

nickpeihl requested review from a team as code owners March 24, 2025 15:14

Merge branch 'main' of https://github.com/elastic/kibana into refHand…

bfe95bd

…ling-tags

TinaHeiligers approved these changes Mar 24, 2025

View reviewed changes

nickpeihl added the Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas t// label Mar 25, 2025

nickpeihl added backport:skip This PR does not require backporting release_note:enhancement labels Mar 25, 2025

pmuellr mentioned this pull request Mar 26, 2025

[ResponseOps][Alerting] investigate turning rule tags into SO tags #215984

Open

ThomThomson self-requested a review March 26, 2025 17:57

ThomThomson approved these changes Mar 26, 2025

View reviewed changes

nickpeihl mentioned this pull request Mar 28, 2025

Create dashboards and visualizations with code #205705

Open

nickpeihl added 3 commits March 28, 2025 12:13

Fix unit test

64071bb

Move tag creation to wrapper function

e1b2121

This allows saved object migrations to continue to use the synchronous itemAttrsToSavedObject function since they don't have a need for tag creation.

Remove optional params from up transform

ff8e17a

nickpeihl mentioned this pull request Mar 28, 2025

[Dashboards as code] Dashboard client should send tags as array rather than extracting references #216346

Closed

nickpeihl added 2 commits March 28, 2025 13:21

Merge branch 'main' into refHandling-tags

1be9e31

Fix lint error

b1645c7

nickpeihl merged commit c4f7c64 into elastic:main Mar 31, 2025
10 checks passed

kibanamachine added the v9.1.0 label Mar 31, 2025

nickpeihl mentioned this pull request Apr 1, 2025

[SO Tagging] Deleted tags (deletion from saved object table) needs a refresh before they are gone from dashboard or visualize listing table #86707

Open

nickpeihl added backport:version Backport to applied version labels v8.19.0 and removed backport:skip This PR does not require backporting labels Apr 8, 2025

nickpeihl mentioned this pull request Apr 8, 2025

[Dashboards] Replace contentClient with getContentClient on DashboardStart server api #217586

Merged

nickpeihl mentioned this pull request Apr 8, 2025

[8.x] [Dashboard] Inject / extract tag references (#214788) #217590

Merged

cnasikas mentioned this pull request Apr 9, 2025

[Cases] Kibana tags #117639

Open

kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Apr 9, 2025

kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Apr 9, 2025

nickpeihl mentioned this pull request Jul 22, 2025

[dashboards as code] move links reference handling to server #228511

Merged

nreese mentioned this pull request Aug 29, 2025

[dashboard] update dashboard CRUD APIs to accept and return tags as an array of tag saved object ids #233541

Merged

Conversation

nickpeihl commented Mar 17, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Identify risks

Uh oh!

TinaHeiligers left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Mar 25, 2025

Uh oh!

ThomThomson left a comment

Choose a reason for hiding this comment

Uh oh!

ThomThomson Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

nickpeihl Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

ThomThomson Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

nickpeihl Mar 28, 2025

Choose a reason for hiding this comment

Uh oh!

ThomThomson Mar 26, 2025

Choose a reason for hiding this comment

Uh oh!

dominiqueclarke commented Mar 28, 2025

Uh oh!

Uh oh!

elasticmachine commented Mar 31, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

History

Uh oh!

kibanamachine commented Apr 8, 2025

Uh oh!

kibanamachine commented Apr 8, 2025

Uh oh!

kibanamachine commented Apr 8, 2025

💔 All backports failed

Manual backport

Questions ?

Uh oh!

kibanamachine commented Apr 8, 2025

💔 All backports failed

Manual backport

Questions ?

Uh oh!

nickpeihl commented Apr 8, 2025

💚 All backports created successfully

Questions ?

Uh oh!

kibanamachine commented Apr 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

nickpeihl commented Mar 17, 2025 •

edited by kibanamachine

Loading