Skip to content
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

[Logs] Provide help for migrating Logs UI settings #189646

Merged
merged 13 commits into from
Aug 14, 2024

Conversation

Kerry350
Copy link
Contributor

@Kerry350 Kerry350 commented Jul 31, 2024

Summary

This implements #186824.

A new API has been added so that automated corrective actions can be applied.

UI / UX

migration

@obltmachine
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@Kerry350 Kerry350 self-assigned this Jul 31, 2024
@Kerry350 Kerry350 added release_note:skip Skip the PR/issue when compiling release notes Team:obs-ux-logs Observability Logs User Experience Team labels Jul 31, 2024
@Kerry350 Kerry350 force-pushed the 186824-logs-ui-settings-migration-help branch from 0d6c498 to 564309f Compare August 7, 2024 09:50
@Kerry350 Kerry350 force-pushed the 186824-logs-ui-settings-migration-help branch from 564309f to b1adcd2 Compare August 7, 2024 12:35
@Kerry350
Copy link
Contributor Author

Kerry350 commented Aug 7, 2024

/ci

@Kerry350 Kerry350 marked this pull request as ready for review August 7, 2024 15:03
@Kerry350 Kerry350 requested review from a team as code owners August 7, 2024 15:03
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-logs-team (Team:obs-ux-logs)

@botelastic botelastic bot added the ci:project-deploy-observability Create an Observability project label Aug 7, 2024
@Kerry350 Kerry350 removed the request for review from a team August 7, 2024 15:08
@Kerry350
Copy link
Contributor Author

@elasticmachine merge upstream

@weltenwort weltenwort self-requested a review August 12, 2024 11:32
Copy link
Member

@weltenwort weltenwort left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to work well 👍

Do you know what the expectations around spaces and the upgrade assistant are? Should it enumerate the deprecations for all spaces? Or is the user expected to visit it once in every space?

@Kerry350
Copy link
Contributor Author

Kerry350 commented Aug 13, 2024

@weltenwort Thanks for the review.

Do you know what the expectations around spaces and the upgrade assistant are? Should it enumerate the deprecations for all spaces? Or is the user expected to visit it once in every space?

I couldn't find any explicit documentation over spaces and migrations. However, when I looked at other migrations that interacted with Saved Objects they seemed to also be done in this manner (once per space). My assumption was also that we probably don't want to land one big migration across spaces given how users use it for segmentation and configuration, it could be surprising. Potentially one space is ready for migration, one isn't yet etc.

@weltenwort
Copy link
Member

My assumption was also that we probably don't want to land one big migration across spaces

Good point. Ideally the upgrade assistant would list a separate problem for each space. I just wondered if that needs to be included in the deprecation factory or outside of it by the assistant itself.

@Kerry350
Copy link
Contributor Author

Summary after speaking to some core folks / investigating:

It doesn't look like a "migrate all spaces" approach will be possible with the functionality we have available at the moment.

  • We can gather all spaces via the spaces plugin (or even via saved objects).
  • We can then update all log view saved objects using those space names via the namespace property.
  • We can't update the advanced setting for all the spaces. The UI Settings client doesn't provide an equivalent namespace option. We could potentially manually update the saved objects that back the settings, but it seems very risky looking at the protections in the write method of the UI Settings client.

We'll keep the "once per space" approach for now, and we can amend things if platform guidance changes.

@Kerry350
Copy link
Contributor Author

@elasticmachine merge upstream

Copy link
Member

@weltenwort weltenwort left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for the thoroughness

@kibana-ci
Copy link
Collaborator

kibana-ci commented Aug 14, 2024

💛 Build succeeded, but was flaky

  • Buildkite Build
  • Commit: ad6fbb7
  • Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-189646-ad6fbb770712

Failed CI Steps

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @Kerry350

@Kerry350 Kerry350 merged commit fc12e58 into elastic:main Aug 14, 2024
23 checks passed
@kibanamachine kibanamachine added v8.16.0 backport:skip This commit does not require backporting labels Aug 14, 2024
wayneseymour added a commit to wayneseymour/kibana that referenced this pull request Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:obs-ux-logs Observability Logs User Experience Team v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants