Create `@elastic/analytics` package #128407

afharo · 2022-03-23T17:56:08Z

Summary

This PR creates the new @elastic/analytics package and all the tasks involved in this process:

Resolves #121995.

Checklist

Delete any items that are not applicable to this PR.

Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

…uild_manifest'

…aro/kibana into ebt/create-elastic-analytics-package

…tic-analytics-package

afharo · 2022-03-30T20:24:52Z

@elasticmachine merge upstream

pgayvallet

Found some other minor NITS, but overall LGTM!

We may want a second review from another team member though, to make sure we didn't miss anything.

pgayvallet · 2022-03-31T06:28:18Z

packages/elastic-analytics/src/analytics_client/opt_in_config.ts

+   * @param eventType the event type to check for the shipper
+   */
+  public isShipperOptedIn(shipperName: ShipperName, eventType?: EventType): boolean {
+    const isGlobalOptedIn = this.isOptedIn();


NIT: I would exit fast here, instead of keeping this value and executing the following logic when unnecessary

if(!this.isOptedIn()) { return false; }

Same for isEventTypeOptedIn

Can also do the same with isShipperGloballyOptedIn

Makes sense! Updated!

pgayvallet · 2022-03-31T06:34:30Z

packages/elastic-analytics/src/events/types.ts

+  /**
+   * Who emitted the event? It can be "client" or the name of the shipper.
+   */
+  source: 'client' | ShipperName;


NIT: given client is a special value here, I wonder if we should be forbidding to register a shipper with the client name.

pgayvallet · 2022-03-31T06:36:03Z

packages/elastic-analytics/src/events/types.ts

+   * Code to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError
+   */
+  code: string;


Can we somehow come with a defined list of values for this code? I'm guessing not given it can be specified by the shipper when encountering an error, but still asking.

I'd leave it open for now to allow shippers to provide context about their failures. But yeah... we could potentially limit this in the future.

pgayvallet · 2022-03-31T06:39:05Z

src/core/public/analytics/analytics_service.ts

+      // TODO: We need to be able to edit sendTo once we resolve the telemetry config.
+      //  For now, we are relying on whether it's a distributable or running from source.
+      sendTo: core.env.packageInfo.dist ? 'production' : 'staging',


Can definitely be done in a follow-up, but thinking out loud, I wonder how we will be able to access the telemetry config from core. Should we expose an API for another actor to call it with the config? Should core access the telemetry config directly (it's hacky and a bad isolation of concern, but technically core can access any plugin's config...)

Yeah! I'm still wrapping my head about the best way to spread the config given the architecture of Kibana.

I've created #129014 to discuss and find out our preferred approach.

afharo · 2022-03-31T06:46:59Z

Just for traceability:

The scaffolding for the dedicated FTR test suite is great, but I wonder if that's the most efficient tooling we can provide to teams to test their events. I would expect a way/tool for them to run any FTR functional suite (e.g displaying a dashboard, creating an ML rule), and then being able to retrieve the events that were sent during the scenario to check them. Do you think that make sense?

I wish we could offer a simple helper. However, the way this client works requires a plugin to register the FTR-helper shipper. If folks want to use them in their suites, they can change their config to import the plugin and the FTR helper. That was my intention with the last line of the README in that directory. WDYT?

pgayvallet · 2022-03-31T08:01:28Z

I wish we could offer a simple helper. However, the way this client works requires a plugin to register the FTR-helper shipper. If folks want to use them in their suites, they can change their config to import the plugin and the FTR helper. That was my intention with the last line of the README in that directory. WDYT?

Yea, I'm not sure we can really do better than. Was just mentioning it because it would have been great, but if we can't, what you did in this PR is good.

afharo · 2022-03-31T08:59:54Z

Changing the label from v8.2.0 to v8.3.0 because there's no need to actually backport these changes to 8.2 as it currently has no users.

Bamieh

LGTM 1 question about an @deprecated comment

Bamieh · 2022-03-31T13:27:14Z

packages/elastic-analytics/src/analytics_client/types.ts

+export interface RegisterShipperOpts {
+  /**
+   * List of event types that will be received only by this shipper.
+   * @deprecated


It's explained in the following line:

Set as internal and deprecated until we come up with the best design for this. Not in the scope of the initial MVP.

At the moment we don't have a @beta-please-do-not-use tag.

…tic-analytics-package

afharo · 2022-04-05T13:55:12Z

Agreed on Slack: as we are reaching the end of our sprint, I'll go ahead and merge this PR. Any comments from @lukeelmers will be addressed in future PRs.

kibana-ci · 2022-04-05T15:21:57Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`core`	335	346	+11

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
`@elastic/analytics`	-	11	+11

Any counts in public APIs

Total count of every any typed public API. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats any for more detailed information.

id	before	after	diff
`@elastic/analytics`	-	1	+1

Async chunks

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

id	before	after	diff
`core`	132.3KB	132.3KB	+27.0B

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`kibana`	310	323	+13

Page load bundle

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

id	before	after	diff
`core`	309.4KB	318.7KB	+9.2KB

Unknown metric groups

API count

id	before	after	diff
`@elastic/analytics`	-	82	+82
`core`	2381	2497	+116
total			+198

ESLint disabled line counts

id	before	after	diff
`@elastic/analytics`	-	16	+16
`core`	49	56	+7
total			+23

Total ESLint disabled count

id	before	after	diff
`@elastic/analytics`	-	16	+16
`core`	59	66	+7
total			+23

History

💚 Build #35140 succeeded e87b474
💚 Build #35026 succeeded 2095bc3
💔 Build #34993 failed 2556812
💔 Build #34968 failed ca6f5f7
💚 Build #34218 succeeded d0f3568
💚 Build #34138 succeeded 267cdd7

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

Create @elastic/analytics package

e0b7cf3

afharo added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting v8.2.0 labels Mar 23, 2022

Export mocks from the client

867b983

afharo force-pushed the ebt/create-elastic-analytics-package branch from de2dbe8 to 867b983 Compare March 23, 2022 18:10

kibanamachine and others added 7 commits March 23, 2022 18:17

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

1d6b58a

…uild_manifest'

Add CODEOWNERS

b88de5f

Add eslint-disable for max-classes-per-file limit

f9342ef

Merge branch 'ebt/create-elastic-analytics-package' of github.com:afh…

47519a7

…aro/kibana into ebt/create-elastic-analytics-package

Merge branch 'main' of github.com:elastic/kibana into ebt/create-elas…

58289cd

…tic-analytics-package

Add server/core.analytics service

8fbd699

Add server FTRs

dcd11c5

afharo force-pushed the ebt/create-elastic-analytics-package branch from 7e3f267 to dcd11c5 Compare March 24, 2022 20:05

afharo added 16 commits March 24, 2022 21:16

Merge branch 'main' of github.com:elastic/kibana into ebt/create-elas…

1009b16

…tic-analytics-package

AcceptDocChanges

1bca34b

Add public/core.analytics

8372429

Fix core_system tests

125a3f6

Merge branch 'main' of github.com:elastic/kibana into ebt/create-elas…

2c35ab0

…tic-analytics-package

[FTR] Create new "analytics" suite

0a35695

Fix test types

34fc3ce

Fix public core mocks

0451fcb

Fix paths after move

3dc1352

Add public FTR tests

1844bcf

Fix Fleet's Storybook context

9c32555

Build analytics test bundle

485c2d8

Merge branch 'main' of github.com:elastic/kibana into ebt/create-elas…

d32a246

…tic-analytics-package

Build analytics test bundle

267cdd7

Add FTR helpers

037bde7

Add readme to the FTR tests

b6d1562

spalger approved these changes Mar 29, 2022

View reviewed changes

afharo added 9 commits March 30, 2022 14:04

Move this.telemetryCounter$ declaration to the top

89fbc41

Feedback on the README

bd9bbf8

PR feedback about mocks and setup vs. start contracts

44b7f13

Remove duplicated types from the usage_collection plugin

37778cb

Export TelemetryCountersType as enum

fdbb58a

Missing type nit

ca6f5f7

FTRs import `TelemetryCounterType from the package

2556812

Simplify AnalyticsClient by moving the OptInConfig logic to a service

e012c07

Context Provider has a name and is not removed after completion

5cba9a8

Merge branch 'main' into ebt/create-elastic-analytics-package

2095bc3

pgayvallet approved these changes Mar 31, 2022

View reviewed changes

afharo mentioned this pull request Mar 31, 2022

[discuss][EBT] Defer sendTo setup #129014

Closed

OptInConfig APIs: return early when possible

e87b474

afharo added v8.3.0 and removed v8.2.0 labels Mar 31, 2022

Bamieh self-requested a review March 31, 2022 10:30

lukeelmers self-requested a review March 31, 2022 13:52

azasypkin mentioned this pull request Apr 4, 2022

Collect analytics for the used authentication mechanisms. #129302

Merged

Bamieh approved these changes Apr 5, 2022

View reviewed changes

Merge branch 'main' of github.com:elastic/kibana into ebt/create-elas…

2da3b7c

…tic-analytics-package

afharo enabled auto-merge (squash) April 5, 2022 13:54

afharo merged commit fcf8622 into elastic:main Apr 5, 2022

afharo deleted the ebt/create-elastic-analytics-package branch April 5, 2022 15:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create `@elastic/analytics` package #128407

Create `@elastic/analytics` package #128407

afharo commented Mar 23, 2022 •

edited

Loading

afharo commented Mar 30, 2022

pgayvallet left a comment •

edited

Loading

pgayvallet Mar 31, 2022

afharo Mar 31, 2022

pgayvallet Mar 31, 2022

pgayvallet Mar 31, 2022

afharo Mar 31, 2022

pgayvallet Mar 31, 2022

afharo Mar 31, 2022

afharo commented Mar 31, 2022 •

edited

Loading

pgayvallet commented Mar 31, 2022

afharo commented Mar 31, 2022

Bamieh left a comment

Bamieh Mar 31, 2022

afharo Apr 5, 2022

afharo commented Apr 5, 2022

kibana-ci commented Apr 5, 2022

API count

ESLint disabled line counts

Total ESLint disabled count

Create @elastic/analytics package #128407

Create @elastic/analytics package #128407

Conversation

afharo commented Mar 23, 2022 • edited Loading

Summary

Checklist

For maintainers

afharo commented Mar 30, 2022

pgayvallet left a comment • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afharo commented Mar 31, 2022 • edited Loading

pgayvallet commented Mar 31, 2022

afharo commented Mar 31, 2022

Bamieh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

afharo commented Apr 5, 2022

kibana-ci commented Apr 5, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Any counts in public APIs

Async chunks

Public APIs missing exports

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

Create `@elastic/analytics` package #128407

Create `@elastic/analytics` package #128407

afharo commented Mar 23, 2022 •

edited

Loading

pgayvallet left a comment •

edited

Loading

afharo commented Mar 31, 2022 •

edited

Loading