Dashboard favorites telemetry by Dosant · Pull Request #190706 · elastic/kibana

Dosant · 2024-08-19T14:23:59Z

Summary

Add telemetry to favorites feature #189285

Adds UI usage counter telemetry, increase the counter when favorite / unfavorite is clicked
Add snapshot telemetry:
- total "favorite" object in the deployment
- total users+spaces count combination who have used the favorites feature
- avg per user per space (only counts those users who favorited at least once)
- max favorites objects per user per space

Unfortunately, for snapshot telemetry, I had to add fields to kibana mapping. We didn't need them for a feature, but I didn't realize that will have to add them to a mapping. Not sure if there is a better way

…fix'

…kibana into d/2024-08-14-favorites-telemetry

…vorites-telemetry

Dosant · 2024-08-21T11:45:39Z

packages/content-management/favorites/favorites_server/src/favorites_saved_object.ts

  mappings: {
    dynamic: false,
-    properties: {},
+    properties: {


We didn't need these mappings for the feature, but, unfortunately, I didn't know that we would need them for the snapshot telemetry. I am not sure if there is another better way

the object schema stays the same, but we add existing fields to the mapping

It's been my experience as well that it's sometimes necessary to add mappings just for the sake of being able to collect snapshot telemetry.

Dosant · 2024-08-21T11:51:29Z

packages/content-management/favorites/favorites_server/src/favorites_usage_collection.ts

+            number_of_favorites: {
+              type: 'long',
+              script: {
+                source: "emit(doc['favorites.favoriteIds'].length)",


Not sure if this is the best way, but I like how clean it is to get sum, avg, max.

I've also tried value_count aggregation which works well for total, but haven't figure how it can be used for avg and max

If you need other alternatives to consider, there is also the stats aggregation.

Running the aggregation on a runtime field seems like a perfect idea for this.

Thanks, I updated to stats

…te --fix'

…kibana into d/2024-08-14-favorites-telemetry

Dosant · 2024-08-21T15:18:03Z

/ci

elasticmachine · 2024-08-22T08:37:55Z

Pinging @elastic/appex-sharedux (Team:SharedUX)

afharo

Core changes LGTM

afharo · 2024-08-22T13:11:53Z

src/plugins/telemetry/tsconfig.json

    "../../../typings/**/*",
    "schema/oss_plugins.json",
    "schema/oss_root.json",
+    "schema/kbn_packages.json"


😮 Thanks!

…vorites-telemetry

Dosant · 2024-08-28T12:59:19Z

@elasticmachine merge upstream

Heenawter

Code review + quick local test to ensure the telemetry is collected as expected. LGTM 👍

Saved object telemetry	UI Counters

tsullivan · 2024-08-28T21:11:27Z

packages/content-management/favorites/favorites_server/src/favorites_usage_collection.ts

+            type: 'long',
+            _meta: {
+              description:
+                'Total unique users+spaces that have favorited an object of this type in this deployment',


I don't follow what users+spaces means. Does it mean users per space?

I'll adjust!

tsullivan · 2024-08-28T21:15:23Z

packages/content-management/favorites/favorites_server/src/favorites_usage_collection.ts

+
+export function registerFavoritesUsageCollection({
+  core,
+  logger,


Should logger be used for anything?

cleaned it up

tsullivan

LGTM

Added a few conversational comments

…vorites-telemetry # Conflicts: # src/plugins/content_management/tsconfig.json

kibana-ci · 2024-08-29T14:32:40Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: e5165bb

Failed CI Steps

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/content-management-favorites-public`	38	44	+6
`@kbn/content-management-favorites-server`	6	7	+1
total			+7

Async chunks

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

id	before	after	diff
`dashboard`	547.3KB	547.7KB	+430.0B
`eventAnnotationListing`	312.9KB	313.0KB	+86.0B
`filesManagement`	120.5KB	120.6KB	+86.0B
`graph`	413.1KB	413.2KB	+86.0B
`maps`	3.0MB	3.0MB	+86.0B
`visualizations`	302.1KB	302.2KB	+86.0B
total			+860.0B

Saved Objects .kibana field count

Every field in each saved object type adds overhead to Elasticsearch. Kibana needs to keep the total field count below Elasticsearch's default limit of 1000 fields. Only specify field mappings for the fields you wish to search on or query. See https://www.elastic.co/guide/en/kibana/master/saved-objects-service.html#_mappings

id	before	after	diff
`favorites`	-	4	+4

Unknown metric groups

API count

id	before	after	diff
`@kbn/content-management-favorites-public`	39	45	+6
`@kbn/content-management-favorites-server`	6	7	+1
total			+7

ESLint disabled line counts

id	before	after	diff
`contentManagement`	7	6	-1

Total ESLint disabled count

id	before	after	diff
`contentManagement`	7	6	-1

History

💛 Build #230421 was flaky 8ab2d24
💛 Build #229750 was flaky d820392
💛 Build #229058 was flaky db55912
💛 Build #228908 was flaky db55912
💔 Build #228872 failed eda9054
💔 Build #228852 failed c75f060

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

Dosant and others added 8 commits August 19, 2024 16:23

favorites telemetry

b90194d

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

2933d91

…fix'

wip

fb9f149

Merge branch 'd/2024-08-14-favorites-telemetry' of github.com:Dosant/…

289bcfd

…kibana into d/2024-08-14-favorites-telemetry

Merge branch 'main' of github.com:elastic/kibana into d/2024-08-14-fa…

a215da3

…vorites-telemetry

update telemetry mapping

2408e74

Merge branch 'main' of github.com:elastic/kibana into d/2024-08-14-fa…

e01c97e

…vorites-telemetry

wip

bfb2959

Dosant commented Aug 21, 2024

View reviewed changes

Dosant and others added 5 commits August 21, 2024 14:18

wip

30a527e

[CI] Auto-commit changed files from 'node scripts/check_mappings_upda…

c75f060

…te --fix'

fix ts

159f689

Merge branch 'd/2024-08-14-favorites-telemetry' of github.com:Dosant/…

eda9054

…kibana into d/2024-08-14-favorites-telemetry

fix types

db55912

Dosant changed the title ~~favorites telemetry~~ Dashboard favorites telemetry Aug 22, 2024

Dosant added release_note:skip Skip the PR/issue when compiling release notes Team:SharedUX Platform AppEx-SharedUX (formerly Global Experience) t// labels Aug 22, 2024

Dosant marked this pull request as ready for review August 22, 2024 08:37

Dosant requested review from a team as code owners August 22, 2024 08:37

Dosant requested a review from afharo August 22, 2024 08:38

afharo approved these changes Aug 22, 2024

View reviewed changes

Dosant added 2 commits August 26, 2024 13:42

Merge branch 'main' of github.com:elastic/kibana into d/2024-08-14-fa…

5b7e326

…vorites-telemetry

add total_users_spaces

d820392

Dosant requested review from Heenawter and tsullivan August 26, 2024 12:20

Merge branch 'main' into d/2024-08-14-favorites-telemetry

8ab2d24

Heenawter approved these changes Aug 28, 2024

View reviewed changes

tsullivan reviewed Aug 28, 2024

View reviewed changes

tsullivan approved these changes Aug 28, 2024

View reviewed changes

Dosant and others added 3 commits August 29, 2024 14:37

review improvements

b1a24e9

Merge branch 'main' of github.com:elastic/kibana into d/2024-08-14-fa…

3d266af

…vorites-telemetry # Conflicts: # src/plugins/content_management/tsconfig.json

[CI] Auto-commit changed files from 'node scripts/notice'

e5165bb

Dosant merged commit ec0230b into elastic:main Aug 29, 2024

kibanamachine added v8.16.0 backport:skip This PR does not require backporting labels Aug 29, 2024

Conversation

Dosant commented Aug 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tsullivan Aug 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dosant commented Aug 21, 2024

Uh oh!

elasticmachine commented Aug 22, 2024

Uh oh!

afharo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dosant commented Aug 28, 2024

Uh oh!

Heenawter left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tsullivan left a comment

Choose a reason for hiding this comment

Uh oh!

kibana-ci commented Aug 29, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Public APIs missing comments

Async chunks

Saved Objects .kibana field count

API count

ESLint disabled line counts

Total ESLint disabled count

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Dosant commented Aug 19, 2024 •

edited

Loading

tsullivan Aug 28, 2024 •

edited

Loading

Heenawter left a comment •

edited

Loading