[Usage Collection] Home Page UI Metrics #81827

cqliu1 · 2020-10-27T18:04:31Z

Summary

UI Metrics added:

App: Kibana_home

Type	Name	Description
`click`	`solution_panel_${solutionId}`	when a user clicks on one of the solutions
`click`	`ingest_data_card_${featureId}`	when a user clicks on one of the options in the "Ingest data" section
`click`	`manage_data_card_${featureId}`	when a user clicks on one of the options in the "Manage data" section
`click`	`set_home_as_default_route`	when a user clicks the `Make this my landing page` button and sets the home page as their `defaultRoute` in advanced settings
`click`	`change_to_different_default_route`	when a user clicks the `Display a different page on log in` button indicating intent to change their landing page

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2020-10-28T18:47:45Z

Pinging @elastic/kibana-core-ui (Team:Core UI)

elasticmachine · 2020-10-28T18:47:46Z

Pinging @elastic/kibana-telemetry (Team:KibanaTelemetry)

alexfrancoeur

Metrics look good to me, when we can parse ui_metrics differently in the upcoming release (cc: @TinaHeiligers). Confirming that they answer the original questions. Thanks Catherine!

TinaHeiligers

Code reviewed and verified everything works as expected by running the PR locally.
LGTM for ui_metrics implementation.

We're capturing quite a few additional objects in the ui_metrics.Kibana_home key:

`ui_metrics.Kibana_home`

"ui_metric": {
  "Kibana_home": [
    {
      "key": "sampleDataDecline",
      "value": 1
    },
    {
      "key": "welcomeScreenMount",
      "value": 1
    },
    {
      "key": "manage_data_card_console",
      "value": 1
    },
    {
      "key": "set_home_as_default_route",
      "value": 3
    },
    {
      "key": "solution_panel_observability",
      "value": 1
    },
    {
      "key": "solution_panel_enterpriseSearch",
      "value": 1
    },
    {
      "key": "ingest_data_card_ingestManager",
      "value": 1
    },
    {
      "key": "ingest_data_card_home_tutorial_directory",
      "value": 1
    },
    {
      "key": "solution_panel_securitySolution",
      "value": 1
    },
    {
      "key": "ingest_data_card_ml_file_data_visualizer",
      "value": 1
    },
    {
      "key": "manage_data_card_snapshot_restore",
      "value": 1
    },
    {
      "key": "manage_data_card_monitoring",
      "value": 1
    },
    {
      "key": "solution_panel_kibana",
      "value": 5
    },
    {
      "key": "manage_data_card_security",
      "value": 1
    },
    {
      "key": "change_to_different_default_route",
      "value": 3
    },
    {
      "key": "manage_data_card_index_lifecycle_management",
      "value": 1
    }
  ]
}

TinaHeiligers · 2020-10-29T22:45:31Z

when we can parse ui_metrics differently in the upcoming release
@alexfrancoeur I'll respond in #74428 so as not to clutter this PR.

Bamieh

LGTM

Bamieh · 2020-11-02T11:23:50Z

@elasticmachine merge upstream

ryankeairns · 2020-11-02T14:15:30Z

@myasonik can you take a look at this one on behalf of Core UI? Thanks!

myasonik

Just a small change for how we collect the metrics, otherwise GTG!

myasonik · 2020-11-02T14:39:52Z

src/plugins/home/public/application/components/add_data/add_data.tsx

+                createAppNavigationHandler(feature.path)(event);
+                trackUiMetric(METRIC_TYPE.CLICK, `ingest_data_card_${feature.id}`);


I wonder if we want to swap these two lines?

createAppNavigationHandler bails if someone goes to open the link in a new tab but we could still collect that metric.

myasonik · 2020-11-02T14:41:12Z

src/plugins/home/public/application/components/manage_data/manage_data.tsx

+                    createAppNavigationHandler(feature.path)(event);
+                    trackUiMetric(METRIC_TYPE.CLICK, `manage_data_card_${feature.id}`);


Same as above, swap?

myasonik · 2020-11-02T14:41:45Z

src/plugins/home/public/application/components/solutions_section/solution_panel.tsx

+          createAppNavigationHandler(solution.path)(event);
+          trackUiMetric(METRIC_TYPE.CLICK, `solution_panel_${solution.id}`);


Last instance, swap?

kibanamachine · 2020-11-02T22:44:35Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 6aac860

Metrics [docs]

async chunks size

id	before	after	diff
`home`	347.6KB	348.4KB	+835.0B

page load bundle size

id	before	after	diff
`kibanaReact`	131.5KB	131.7KB	+230.0B

History

💚 Build #85102 succeeded 5202400
💚 Build #84358 succeeded 2122b89
💔 Build #84062 failed ee818456d570d6f77bf62e728efde929b3f59d47

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

* Added telemetry for the home page * Added check for click handlers in overview page footer * Fixed ts error * Updated snapshots * Applied feedback Co-authored-by: Kibana Machine <[email protected]>

* Added telemetry for the home page * Added check for click handlers in overview page footer * Fixed ts error * Updated snapshots * Applied feedback Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kibana Machine <[email protected]>

cqliu1 added 4 commits October 28, 2020 09:53

Added telemetry for the home page

b89130c

Added check for click handlers in overview page footer

b634530

Fixed ts error

b068689

Updated snapshots

2122b89

cqliu1 force-pushed the telemetry/home-page branch from ee81845 to 2122b89 Compare October 28, 2020 17:03

cqliu1 mentioned this pull request Oct 28, 2020

[Usage Collection] Kibana Overview Page UI Metrics #81937

Merged

1 task

cqliu1 added Feature:Telemetry release_note:skip Skip the PR/issue when compiling release notes REASSIGN from Team:Core UI Deprecated label for old Core UI team Team:KibanaTelemetry v7.11.0 v8.0.0 labels Oct 28, 2020

cqliu1 marked this pull request as ready for review October 28, 2020 18:47

cqliu1 requested a review from a team as a code owner October 28, 2020 18:47

cqliu1 requested review from a team and alexfrancoeur October 28, 2020 18:48

alexfrancoeur approved these changes Oct 29, 2020

View reviewed changes

TinaHeiligers approved these changes Oct 29, 2020

View reviewed changes

TinaHeiligers mentioned this pull request Oct 29, 2020

Elastic homepage analytics #74428

Closed

Bamieh approved these changes Nov 2, 2020

View reviewed changes

Merge branch 'master' into telemetry/home-page

5202400

kibanamachine requested a review from a team November 2, 2020 11:24

myasonik approved these changes Nov 2, 2020

View reviewed changes

cqliu1 added 2 commits November 2, 2020 13:59

Applied feedback

8a65deb

Merge branch 'master' into telemetry/home-page

6aac860

cqliu1 merged commit d9eef77 into elastic:master Nov 2, 2020

cqliu1 deleted the telemetry/home-page branch November 2, 2020 23:32

cqliu1 mentioned this pull request Nov 3, 2020

[7.x] [Usage Collection] Home Page UI Metrics (#81827) #82456

Merged

lukeelmers added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc and removed Team:KibanaTelemetry labels Oct 1, 2021

cqliu1 restored the telemetry/home-page branch June 8, 2022 14:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Usage Collection] Home Page UI Metrics #81827

[Usage Collection] Home Page UI Metrics #81827

cqliu1 commented Oct 27, 2020 •

edited

Loading

elasticmachine commented Oct 28, 2020

elasticmachine commented Oct 28, 2020

alexfrancoeur left a comment

TinaHeiligers left a comment •

edited

Loading

TinaHeiligers commented Oct 29, 2020

Bamieh left a comment

Bamieh commented Nov 2, 2020

ryankeairns commented Nov 2, 2020

myasonik left a comment

myasonik Nov 2, 2020

myasonik Nov 2, 2020

myasonik Nov 2, 2020

kibanamachine commented Nov 2, 2020

		createAppNavigationHandler(feature.path)(event);
		trackUiMetric(METRIC_TYPE.CLICK, `ingest_data_card_${feature.id}`);

		createAppNavigationHandler(feature.path)(event);
		trackUiMetric(METRIC_TYPE.CLICK, `manage_data_card_${feature.id}`);

		createAppNavigationHandler(solution.path)(event);
		trackUiMetric(METRIC_TYPE.CLICK, `solution_panel_${solution.id}`);

[Usage Collection] Home Page UI Metrics #81827

[Usage Collection] Home Page UI Metrics #81827

Conversation

cqliu1 commented Oct 27, 2020 • edited Loading

Summary

UI Metrics added:

For maintainers

elasticmachine commented Oct 28, 2020

elasticmachine commented Oct 28, 2020

alexfrancoeur left a comment

Choose a reason for hiding this comment

TinaHeiligers left a comment • edited Loading

Choose a reason for hiding this comment

TinaHeiligers commented Oct 29, 2020

Bamieh left a comment

Choose a reason for hiding this comment

Bamieh commented Nov 2, 2020

ryankeairns commented Nov 2, 2020

myasonik left a comment

Choose a reason for hiding this comment

myasonik Nov 2, 2020

Choose a reason for hiding this comment

myasonik Nov 2, 2020

Choose a reason for hiding this comment

myasonik Nov 2, 2020

Choose a reason for hiding this comment

kibanamachine commented Nov 2, 2020

💚 Build Succeeded

Metrics [docs]

async chunks size

page load bundle size

History

cqliu1 commented Oct 27, 2020 •

edited

Loading

TinaHeiligers left a comment •

edited

Loading