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

[UA] ES deprecation logs in its own page #118659

Merged
merged 9 commits into from
Nov 19, 2021
Merged

Conversation

sebelga
Copy link
Contributor

@sebelga sebelga commented Nov 16, 2021

The deprecation logs coming from ES have some UX flaws. Many of the deprecation logs (some noted as “Critical”) that we expose in Observability are coming from Kibana itself and the user can’t act on them. There isn’t really anything that they can do to solve those deprecations. Those logs create noise and could be a barrier to the upgrade process.

We want to reduce the visibility of the “use of deprecated API” section in Upgrade assistant (step 4 of the wizard) as we can’t confidently rely on them to help the user fix possible use of deprecated ES APIs.

In this PR we have removed the ES deprecation logs UI from the UA overview and moved it to its own page.

TODO

Screenshots

Screenshot 2021-11-16 at 16 17 34

Screenshot 2021-11-16 at 16 17 59

@sebelga sebelga changed the title Initial commit [UA] ES deprecation logs in its own page Nov 16, 2021
…_logs page (#118688)

* Remove step completion logic and move fix_deprecation_logs folder to
es_deprecation_logs

* commit using @elastic.co
@sebelga sebelga added Feature:Upgrade Assistant Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v7.16.0 v8.0.0 labels Nov 16, 2021
Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

Left a few suggestions.

@cjcenizal
Copy link
Contributor

👍 👍 👍 I haven't looked at the code, only tested locally. This UX feels so much better to me! The logs are accessible but not presented as blockers. Great work @sebelga and @sabarasaba. Let's wait a bit to ensure stakeholders are onboard with this change before merging.

@cjcenizal
Copy link
Contributor

@sebelga @sabarasaba We have approval to move forward with this change, so feel free to merge when ready.

@sebelga sebelga marked this pull request as ready for review November 17, 2021 23:05
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-stack-management (Team:Stack Management)

@sebelga sebelga added the release_note:skip Skip the PR/issue when compiling release notes label Nov 17, 2021
Copy link
Member

@sabarasaba sabarasaba left a comment

Choose a reason for hiding this comment

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

code changes lgtm, tested locally 🚀

@sebelga
Copy link
Contributor Author

sebelga commented Nov 18, 2021

Thanks for the review @sabarasaba ! Let's wait for @debadair input and then we'll merge it 👍

Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

Updated the suggestion, but LGTM either way.

sebelga and others added 2 commits November 18, 2021 18:16
Co-authored-by: debadair <debadair@elastic.co>
@sebelga
Copy link
Contributor Author

sebelga commented Nov 18, 2021

Thanks for the review @debadair ! 👍

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
upgradeAssistant 143 145 +2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
upgradeAssistant 137.1KB 138.7KB +1.5KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
core 308.2KB 308.2KB +61.0B
upgradeAssistant 18.0KB 18.3KB +311.0B
total +372.0B

History

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

@sebelga sebelga merged commit 0770911 into 7.16 Nov 19, 2021
@sebelga sebelga deleted the ua/deprecation_logs_improvements branch November 19, 2021 08:09
@cjcenizal
Copy link
Contributor

@sebelga I think we'll need to backport this to the 8.0 branch too.

@sebelga
Copy link
Contributor Author

sebelga commented Nov 22, 2021

I think we'll need to backport this to the 8.0 branch too.

Do we need to backport if UA is not enabled in 8.0?

@cjcenizal
Copy link
Contributor

@sebelga The only reason I can imagine we will need it is if there’s a security flaw in a common dependency that will require making changes throughout all plugins. In a situation like that, a backport would be painful if plugins are inconsistent between branches. The chance of that seems low so we could probably get away with not backporting it. OTOH the effort of a backport seems low. Do you see a downside to backporting?

@sebelga
Copy link
Contributor Author

sebelga commented Nov 22, 2021

#119134 was not a straightforward process so I was wondering why we'd need to backport on a branch where we'll only apply security patches or bug fixes. Security patches seem to be more likely to be done server side so would not affect the changes here on UA. The rest are tests and doc links.

@cjcenizal
Copy link
Contributor

Ah, thanks for explaining Seb! I didn't know that you encountered a large number of merge conflicts when you forwardported the change to main. I'll leave it to you to decide what's right. At this point I'm more curious about the cause of those merge conflicts. My guess is we missed some forwardports while #114966 was in flight. For example, it looks like #112907 didn't get forwardported.

@sebelga
Copy link
Contributor Author

sebelga commented Nov 22, 2021

With that said I did create the backport as indeed it is little effort and aligned branches are a very good thing to do for our future selves. 😊 (#119345)

The conflicts with the previous backport came mainly because of translation being updated for the 7.16 release. And I think translation go main > 7.16 while we go 7.16 > main. So a change of translation key while working on 7.16 creates conflicts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Upgrade Assistant release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v7.16.0 v8.0.0 v8.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants