Telemetry/opt in welcome screen #42110

Bamieh · 2019-07-28T15:13:37Z

Summary

Add Telemetry Opt in card to welcome screen. Closes https://github.com/elastic/dev/issues/1075

The telemetry in opt in screen will be hidden in the following scenarios:

OSS Kibana, since telemetry currently lives in x-pack.
User already chose to opt-in or opt-out.
Kibana config xpack.telemetry.banner: false.
Kibana config: xpack.telemetry.enabled: false.

Scenarios:

The user clicks "No":
Opt in banner and this card will never be shown again. Telemetry is opted out.
The user clicks "Yes":
Opt in banner and this card will never be shown again. Telemetry is opted in.
The user does not get the welcome screen
Users who already have data on elasticsearch will not see the welcome screen, hence they will only see the opt in banner.

Step 1:

Step 2:

With example opened:

Dev Docs

Added Telemetry Opt in card to welcome screen. The aim is to increate increase opt in rate. Added tracking to measure the success of this change.

…_in_welcome_screen

elasticmachine · 2019-07-28T16:06:05Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-28T17:21:00Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…_in_welcome_screen

snide

I tried to get this running, but can't get the welcome screen to show. I still get the old banner. Tried clearing my local storage, sessions and cookies but I just get this.

elasticmachine · 2019-07-29T07:35:05Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-29T10:16:30Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-29T11:16:59Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

ryankeairns · 2019-07-29T14:21:59Z

Quick look at the screenshots in the description, it reads that Step 1 has the first dot (under the box) as gray when it should be blue. In other words, the active slide should be associated with a blue dot.

This may just be a mixup in the description, as I've not run this locally to confirm, but just pointing it out in the even it needs to change.

Looks good!

Bamieh · 2019-07-29T15:06:47Z

@ryankeairns Thanks for the review! I just set the disabled attribute to true to the current card, so the grey one is the current one as it is not clickable. I would take any recommendation to improving the experience! Happy to chat over zoom/slack as well

ryankeairns · 2019-07-29T15:33:18Z

@Bamieh for the active card, perhaps just use a regular EuiIcon (instead of EuiButtonIcon) and set the color to euiColorPrimary. For the other card (not currently visible), keep the EuiButtonIcon but set the color to disabled (don't actually set the button to disabled).

Unrelated, if the user clicks 'Try sample data' will they navigate away and potentially never reach the second card for telemetry?

src/legacy/core_plugins/kibana/public/home/kibana_services.js

tsullivan · 2019-08-21T18:36:33Z

x-pack/legacy/plugins/telemetry/public/services/telemetry_opt_in.ts

+ */
+
+// @ts-ignore
+export { TelemetryOptInProvider } from '../../../../../../src/legacy/core_plugins/kibana/public/home/telemetry_opt_in'; // eslint-disable-line


// eslint-disable-line is not necessary here

This include needs to be tested out with a packaged version of the Kibana code. When Kibana is built, the location of x-pack moves. Relative imports out of x-pack this way, do not work afaik

I'm disabling eslint as it spreads the export statement into 3 lines as the import string is long. Then the @ts-ignore does not ignore the right line. Moving the @ts-ignore line between those 3 lines of the export statement also makes the linter complain.

I did test this in a production build and it works fine; there are places in x-pack where its requiring code from src as well in a 100 different files (searched x-pack folder for ../src excluding test files)

x-pack/legacy/plugins/telemetry/public/services/telemetry_opt_in.test.mocks.js

tsullivan

I'm going to go ahead and request more changes and ask you to investigate the import made outside of x-pack to OSS code. While that obviously works when running from source, I want to make extra sure it won't break in a build

tsullivan · 2019-08-21T18:46:08Z

@Bamieh

The user does not get the welcome screen

How do we test that in this PR branch?

I can add a quick fix by setting a timeout so that it gets populated after the loading screen is covering the screen.

I am ++ for a quick fix of the flash of the upper banner. Would it be possible to tweak some timing around there?

…_in_welcome_screen

Bamieh · 2019-08-26T11:22:51Z

@tsullivan thanks for the review. To test this scenario:

The user does not get the welcome screen
Users who already have data on elasticsearch will not see the welcome screen, hence they will only see the opt in banner.

You can press esc to skip the welcome screen dialog without specifying opt in or opt out. You should see the opt in banner then.

Another way to test this is by having some data in ES, then the welcome screen will not show in the first place; leaving the users with the opt in banner to enable telemetry.

Bamieh · 2019-08-26T12:24:32Z

@tsullivan @alexfrancoeur For the banner timeout enhancement I will create a separate PR for it as it seems out of scope for this PR.

elasticmachine · 2019-08-26T12:25:11Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…kibana into telemetry/opt_in_welcome_screen

elasticmachine · 2019-08-26T16:46:07Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

tsullivan

LGTM!

Reviewed the code changes and tested in a local build

elasticmachine · 2019-08-26T18:56:14Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-08-26T23:57:39Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

* refactor opt_in_message * welcome optin card * finish optin in welcome screen * add steps * disable current step * remove checkbox option * add metrics * fix typescript checks * hide in oss * update snapshots * only require TelemetryOptInProvider if telemetry is enabled * pass telemetry description from service * remove x-pack import * remove x-pack import * update image * update per design feedback * update props * fix in oss * await before moving to next screen * utlize bannerId in telemtry provider * keep export in 1 line * ts-ignore banner import * add test * update tests * update translations * update home tests * remove extra license header * showTelemetryOptIn -> shouldShowTelemetryOptIn * remote extra EuiTexts * update jest snapshot * unencrypted telemetry example

elasticmachine · 2019-09-03T09:03:09Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

Bamieh added 9 commits July 23, 2019 17:03

refactor opt_in_message

8914b61

Merge branch 'master' of github.com:elastic/kibana into telemetry/opt…

cb0b2b5

…_in_welcome_screen

welcome optin card

0f2261b

Merge branch 'master' of github.com:elastic/kibana into telemetry/opt…

84737d0

…_in_welcome_screen

finish optin in welcome screen

d1e7794

add steps

d7f7a07

disable current step

25b4577

remove checkbox option

11d9e82

add metrics

a3338db

Bamieh added Feature:Telemetry release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. labels Jul 28, 2019

Bamieh requested a review from a team July 28, 2019 15:13

Bamieh requested a review from a team as a code owner July 28, 2019 15:13

fix typescript checks

2812b0f

Merge branch 'master' of github.com:elastic/kibana into telemetry/opt…

76b17dd

…_in_welcome_screen

snide reviewed Jul 29, 2019

View reviewed changes

hide in oss

5135a14

Bamieh added 4 commits July 29, 2019 10:56

update snapshots

d2bdffa

only require TelemetryOptInProvider if telemetry is enabled

d69c996

pass telemetry description from service

150e7f1

remove x-pack import

9a7808f

remove x-pack import

f9b3603

tsullivan reviewed Aug 21, 2019

View reviewed changes

src/legacy/core_plugins/kibana/public/home/kibana_services.js Outdated Show resolved Hide resolved

tsullivan reviewed Aug 21, 2019

View reviewed changes

x-pack/legacy/plugins/telemetry/public/services/telemetry_opt_in.test.mocks.js Show resolved Hide resolved

tsullivan requested changes Aug 21, 2019

View reviewed changes

Merge branch 'master' of github.com:elastic/kibana into telemetry/opt…

aa7adc1

…_in_welcome_screen

Bamieh added 3 commits August 26, 2019 16:46

showTelemetryOptIn -> shouldShowTelemetryOptIn

be9bd46

remote extra EuiTexts

81bb8b6

Merge branch 'telemetry/opt_in_welcome_screen' of github.com:elastic/…

645b86d

…kibana into telemetry/opt_in_welcome_screen

Bamieh requested a review from tsullivan August 26, 2019 14:34

Bamieh added v7.4.0 v7.5.0 v8.0.0 labels Aug 26, 2019

update jest snapshot

2bff852

tsullivan approved these changes Aug 26, 2019

View reviewed changes

unencrypted telemetry example

927c708

Bamieh merged commit 5917cd3 into master Aug 27, 2019

Bamieh deleted the telemetry/opt_in_welcome_screen branch August 27, 2019 10:35

Bamieh mentioned this pull request Aug 27, 2019

[7.x] Telemetry/opt in welcome screen (#42110) #44077

Merged

ryankeairns mentioned this pull request Oct 31, 2019

Improve First-Run Kibana Telemetry Opt In Page #49518

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Telemetry/opt in welcome screen #42110

Telemetry/opt in welcome screen #42110

Bamieh commented Jul 28, 2019 •

edited

Loading

elasticmachine commented Jul 28, 2019

elasticmachine commented Jul 28, 2019

snide left a comment

elasticmachine commented Jul 29, 2019

elasticmachine commented Jul 29, 2019

elasticmachine commented Jul 29, 2019

ryankeairns commented Jul 29, 2019

Bamieh commented Jul 29, 2019

ryankeairns commented Jul 29, 2019

tsullivan Aug 21, 2019 •

edited

Loading

Bamieh Aug 26, 2019

Bamieh Aug 26, 2019

tsullivan left a comment

tsullivan commented Aug 21, 2019

Bamieh commented Aug 26, 2019

Bamieh commented Aug 26, 2019

elasticmachine commented Aug 26, 2019

elasticmachine commented Aug 26, 2019

tsullivan left a comment

elasticmachine commented Aug 26, 2019

elasticmachine commented Aug 26, 2019

elasticmachine commented Sep 3, 2019

Telemetry/opt in welcome screen #42110

Telemetry/opt in welcome screen #42110

Conversation

Bamieh commented Jul 28, 2019 • edited Loading

Summary

Step 1:

Step 2:

With example opened:

Dev Docs

elasticmachine commented Jul 28, 2019

💔 Build Failed

elasticmachine commented Jul 28, 2019

💔 Build Failed

snide left a comment

Choose a reason for hiding this comment

elasticmachine commented Jul 29, 2019

💔 Build Failed

elasticmachine commented Jul 29, 2019

💔 Build Failed

elasticmachine commented Jul 29, 2019

💚 Build Succeeded

ryankeairns commented Jul 29, 2019

Bamieh commented Jul 29, 2019

ryankeairns commented Jul 29, 2019

tsullivan Aug 21, 2019 • edited Loading

Choose a reason for hiding this comment

Bamieh Aug 26, 2019

Choose a reason for hiding this comment

Bamieh Aug 26, 2019

Choose a reason for hiding this comment

tsullivan left a comment

Choose a reason for hiding this comment

tsullivan commented Aug 21, 2019

Bamieh commented Aug 26, 2019

Bamieh commented Aug 26, 2019

elasticmachine commented Aug 26, 2019

💚 Build Succeeded

elasticmachine commented Aug 26, 2019

💔 Build Failed

tsullivan left a comment

Choose a reason for hiding this comment

elasticmachine commented Aug 26, 2019

💔 Build Failed

elasticmachine commented Aug 26, 2019

💚 Build Succeeded

elasticmachine commented Sep 3, 2019

💚 Build Succeeded

Bamieh commented Jul 28, 2019 •

edited

Loading

tsullivan Aug 21, 2019 •

edited

Loading