[Upgrade Assistant] Add deprecation logging as step on overview page #126277

alisonelizabeth · 2022-02-23T18:13:43Z

This PR makes the deprecation logging feature more prominent in Upgrade Assistant by adding it as its own separate step on the Overview page.

Screenshots

// Deprecation logging enabled

// Deprecation logging disabled

// Error state

// Missing privileges

// New test coverage

…ecation_logging

elasticmachine · 2022-02-24T15:33:05Z

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

cjcenizal · 2022-02-24T18:58:32Z

x-pack/plugins/upgrade_assistant/public/application/components/overview/logs_step/logs_step.tsx

+      setIsComplete(false);
+    }
+
+    setIsComplete(logsCount?.count === 0);


I love that we're bubbling this state up to the steps UI. If this step is marked as incomplete, does it block the user from upgrading? If so, then I'm concerned about users being blocked from upgrading in the event an Elastic-triggered log shows up and they have no way to fix it. Maybe I'm just being paranoid, but given the trouble we had with these logs originally I think we might want to err on the side of caution.

Ah, good catch! I didn't realize we were blocking the upgrade on cloud, but now I see that we are. I will remove this.

Actually, on further review, I see that we are calling the status route to determine whether or not the upgrade button is disabled. This takes into account any critical deprecations from ES or Kibana, and whether the system indices migration is needed. It does not check deprecation logs.

With that said, I think the current approach is OK to leave as-is.

👍 Thanks for looking into it. Just wanted to make sure the actual button in UA that takes you to Cloud isn't disabled by the incomplete state of the step. ~~But I believe that button is enabled/disabled based on the Status API, right?~~ That's literally what you wrote. 🤦 Thanks!

alisonelizabeth · 2022-02-28T13:50:33Z

@elasticmachine merge upstream

sabarasaba

Thanks for making these changes @alisonelizabeth! code lgtm, tested locally. Left one small question 🚀

sabarasaba · 2022-03-01T10:11:50Z

x-pack/plugins/upgrade_assistant/public/application/components/overview/logs_step/logs_step.tsx

+
+        <EuiSpacer />
+
+        <EuiButton onClick={navigateToEsDeprecationLogs} data-test-subj="viewLogsLink">


if a user doesn't have index privileges, the only thing they can do in the es deprecation logs page is enable/disable log collection right? Wondering if it's worthy to still show this CTA in that case 🤔

That's correct. I was on the fence for this as well. I'm going to go ahead and remove it.

I looked back at the previous code when it was part of the deprecations step, and I see we weren't showing the sentence/link to the deprecation logs when a user did not have privileges.

sebelga · 2022-03-01T11:22:01Z

I am wondering if the title of the step shouldn't be simply "Address Elasticsearch deprecations" or "Address API deprecations"
The facts that the deprecation are surfaced in the logs is an implementation information. They could be shown in a table 😊 WDYT?

alisonelizabeth · 2022-03-01T14:12:02Z

I am wondering if the title of the step shouldn't be simply "Address Elasticsearch deprecations" or "Address API deprecations"
The facts that the deprecation are surfaced in the logs is an implementation information. They could be shown in a table 😊 WDYT?

Thanks for the feedback @sebelga! That's a good point.

@jrodewig would you mind weighing in here on the copy?

jrodewig

Thanks for the ping. This looks good overall, but I think the missing privileges error needs some work.

I also left some other non-blocking suggestions.

jrodewig · 2022-03-01T21:11:25Z

x-pack/plugins/upgrade_assistant/public/application/components/overview/logs_step/logs_step.tsx

+
+const i18nTexts = {
+  logsStepTitle: i18n.translate('xpack.upgradeAssistant.overview.logsStep.title', {
+    defaultMessage: 'Address deprecation logs',


I don't feel strongly about it, but I like @sabarasaba's suggestion here.

Suggested change

defaultMessage: 'Address deprecation logs',

defaultMessage: 'Address API deprecations',

jrodewig · 2022-03-01T21:12:23Z

x-pack/plugins/upgrade_assistant/public/application/components/overview/logs_step/logs_step.tsx

+  }),
+  logsStepDescription: i18n.translate('xpack.upgradeAssistant.overview.logsStep.description', {
+    defaultMessage:
+      'Review the Elasticsearch deprecation logs to make sure you are not using deprecated APIs.',


Minor wording nit.

Suggested change

'Review the Elasticsearch deprecation logs to make sure you are not using deprecated APIs.',

'Review the Elasticsearch deprecation logs to ensure you're not using deprecated APIs.',

jrodewig · 2022-03-01T21:13:49Z

x-pack/plugins/upgrade_assistant/public/application/components/overview/logs_step/logs_step.tsx

+  enableLogsButtonLabel: i18n.translate(
+    'xpack.upgradeAssistant.overview.logsStep.enableLogsButtonLabel',
+    {
+      defaultMessage: 'Enable logs',


"Enabled logging" sounds a bit more natural to me.

Suggested change

defaultMessage: 'Enable logs',

defaultMessage: 'Enable logging',

jrodewig · 2022-03-01T21:29:05Z

x-pack/plugins/upgrade_assistant/public/application/components/overview/logs_step/logs_step.tsx

+    }
+  ),
+  loadingError: i18n.translate('xpack.upgradeAssistant.overview.logsStep.loadingError', {
+    defaultMessage: 'An error occurred while retrieving the count of deprecation logs',


Suggested change

defaultMessage: 'An error occurred while retrieving the count of deprecation logs',

defaultMessage: 'An error occurred while retrieving the deprecation log count',

jrodewig · 2022-03-01T21:29:15Z

x-pack/plugins/upgrade_assistant/public/application/components/overview/logs_step/logs_step.tsx

+  missingPrivilegesTitle: i18n.translate(
+    'xpack.upgradeAssistant.overview.logsStep.missingPrivilegesTitle',
+    {
+      defaultMessage: 'You require index privileges to analyze the deprecation logs',


This wording is a little awkward to me, and I don't think it stands on its own.

Can we add a description that includes the required index privileges and the indices you need them on?

…ecation_logging

alisonelizabeth · 2022-03-02T14:18:31Z

Thanks for the review @jrodewig! I addressed your feedback in bf592ed.

jrodewig

Copy changes LGTM. Thanks @alisonelizabeth.

kibana-ci · 2022-03-02T15:49:01Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`upgradeAssistant`	209	211	+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`	182.1KB	185.5KB	+3.4KB

History

💚 Build #26834 succeeded 2515167
💔 Build #26817 failed ca24cc5
💚 Build #26533 succeeded fae7214
💚 Build #26194 succeeded 54eccf4
💔 Build #25994 failed 68a2c0f

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

…lastic#126277)

alisonelizabeth added 2 commits February 23, 2022 09:46

add logs step to overview page

d96654d

add jest tests

18a25c8

alisonelizabeth added release_note:fix Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more Feature:Upgrade Assistant v7.17.1 labels Feb 23, 2022

alisonelizabeth added 4 commits February 23, 2022 13:21

remove logs link from fix_issues step

fc39829

fix completedStepsMap initial state

68a2c0f

update functional and a11y tests

e283773

Merge branch '7.17' of https://github.com/elastic/kibana into ua/depr…

54eccf4

…ecation_logging

alisonelizabeth marked this pull request as ready for review February 24, 2022 15:33

alisonelizabeth requested a review from sebelga February 24, 2022 15:33

cjcenizal reviewed Feb 24, 2022

View reviewed changes

Merge branch '7.17' into ua/deprecation_logging

fae7214

alisonelizabeth requested review from sabarasaba and removed request for sebelga February 28, 2022 14:12

alisonelizabeth added v7.17.2 and removed v7.17.1 labels Feb 28, 2022

sabarasaba approved these changes Mar 1, 2022

View reviewed changes

alisonelizabeth added 3 commits March 1, 2022 09:34

remove CTA when user is missing privileges

3646ed6

remove extra spacing

ca24cc5

update tests

2515167

jrodewig added the ui-copy Review of UI copy with docs team is recommended label Mar 1, 2022

jrodewig reviewed Mar 1, 2022

View reviewed changes

alisonelizabeth added 2 commits March 2, 2022 09:16

address copy feedback

bf592ed

Merge branch '7.17' of https://github.com/elastic/kibana into ua/depr…

8e00993

…ecation_logging

jrodewig approved these changes Mar 2, 2022

View reviewed changes

alisonelizabeth merged commit 2f4480c into elastic:7.17 Mar 2, 2022

alisonelizabeth deleted the ua/deprecation_logging branch March 2, 2022 15:50

alisonelizabeth mentioned this pull request Mar 2, 2022

Increase prominence of deprecation logs in Upgrade Assistant #125842

Closed

alisonelizabeth added a commit to alisonelizabeth/kibana that referenced this pull request Mar 2, 2022

[Upgrade Assistant] Add deprecation logging as step on overview page (e…

e43d345

…lastic#126277)

alisonelizabeth mentioned this pull request Mar 2, 2022

[Upgrade Assistant] Add deprecation logging as step on overview page #126693

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Upgrade Assistant] Add deprecation logging as step on overview page #126277

[Upgrade Assistant] Add deprecation logging as step on overview page #126277

alisonelizabeth commented Feb 23, 2022 •

edited

Loading

elasticmachine commented Feb 24, 2022

cjcenizal Feb 24, 2022

alisonelizabeth Feb 24, 2022

alisonelizabeth Feb 24, 2022 •

edited

Loading

cjcenizal Feb 25, 2022 •

edited

Loading

alisonelizabeth commented Feb 28, 2022

sabarasaba left a comment

sabarasaba Mar 1, 2022

alisonelizabeth Mar 1, 2022

alisonelizabeth Mar 1, 2022

sebelga commented Mar 1, 2022

alisonelizabeth commented Mar 1, 2022

jrodewig left a comment

jrodewig Mar 1, 2022

jrodewig Mar 1, 2022

jrodewig Mar 1, 2022

jrodewig Mar 1, 2022

jrodewig Mar 1, 2022 •

edited

Loading

alisonelizabeth Mar 2, 2022

alisonelizabeth commented Mar 2, 2022 •

edited

Loading

jrodewig left a comment

kibana-ci commented Mar 2, 2022


		<EuiSpacer />

		<EuiButton onClick={navigateToEsDeprecationLogs} data-test-subj="viewLogsLink">

	defaultMessage: 'Address deprecation logs',
	defaultMessage: 'Address API deprecations',

	'Review the Elasticsearch deprecation logs to make sure you are not using deprecated APIs.',
	'Review the Elasticsearch deprecation logs to ensure you're not using deprecated APIs.',

	defaultMessage: 'Enable logs',
	defaultMessage: 'Enable logging',

	defaultMessage: 'An error occurred while retrieving the count of deprecation logs',
	defaultMessage: 'An error occurred while retrieving the deprecation log count',

[Upgrade Assistant] Add deprecation logging as step on overview page #126277

[Upgrade Assistant] Add deprecation logging as step on overview page #126277

Conversation

alisonelizabeth commented Feb 23, 2022 • edited Loading

Screenshots

elasticmachine commented Feb 24, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alisonelizabeth Feb 24, 2022 • edited Loading

Choose a reason for hiding this comment

cjcenizal Feb 25, 2022 • edited Loading

Choose a reason for hiding this comment

alisonelizabeth commented Feb 28, 2022

sabarasaba left a 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

sebelga commented Mar 1, 2022

alisonelizabeth commented Mar 1, 2022

jrodewig left a 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

jrodewig Mar 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alisonelizabeth commented Mar 2, 2022 • edited Loading

jrodewig left a comment

Choose a reason for hiding this comment

kibana-ci commented Mar 2, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

alisonelizabeth commented Feb 23, 2022 •

edited

Loading

alisonelizabeth Feb 24, 2022 •

edited

Loading

cjcenizal Feb 25, 2022 •

edited

Loading

jrodewig Mar 1, 2022 •

edited

Loading

alisonelizabeth commented Mar 2, 2022 •

edited

Loading