[API DOCS] Usage Collection by afharo · Pull Request #98656 · elastic/kibana

afharo · 2021-04-28T17:06:23Z

Summary

This PR cleans up all the unused APIs exposed by the usageCollection plugin and documents the exposed ones.

When running node scripts/build_api_docs --plugin usageCollection --stats any --stats comments --stats exports we still get the following warnings.

 info --- Plugin 'usageCollection' ----`
 info 0 API items with ANY
┌─────────┐
│ (index) │
├─────────┤
└─────────┘
 info 1 API items missing comments
┌─────────┬──────────────────────────────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│ (index) │                  id                  │                                                                         link                                                                         │
├─────────┼──────────────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
│    0    │ 'def-public.TrackApplicationView.$1' │ 'https://github.com/elastic/kibana/tree/master/src/plugins/usage_collection/public/components/track_application_view/track_application_view.tsx#L23' │
└─────────┴──────────────────────────────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

This is because the current tool is not able to link the JSDocs and the methods declared as const myFn = (prop) => arrowFnResult. (#98744)

~~Also, re SerializeCounterParams, it is exposed. I may need some help from @stacey-gammon to find out what is it that I'm missing 🥺~~ Nevermind, I found out it's because I was adding @internal to that interface's docs.

Checklist

Documentation was added for features that require explanation or tutorials

For maintainers

This was checked for breaking API changes and was labeled appropriately

afharo · 2021-04-28T17:08:48Z

src/plugins/usage_collection/public/index.ts

Removed as we're using import { METRIC_TYPE } from '@kbn/analytics' everywhere except in lens and the data plugins (which I changed in this PR).

afharo · 2021-04-28T17:09:43Z

x-pack/plugins/lens/public/editor_frame_service/embeddable/embeddable.tsx

I'm normalizing this import to how it's done everywhere else. This way we can avoid re-exporting it from the usageCollection plugin 😇

afharo · 2021-04-28T17:28:24Z

src/plugins/data/public/autocomplete/collectors/create_usage_collector.ts

Normalizing this import so we don't need to re-export it from the usageCollection plugin

afharo · 2021-04-29T09:08:26Z

src/fixtures/telemetry_collectors/nested_collector.ts


 export class NestedInside {
-  collector?: UsageCollector<Usage>;
+  collector?: Collector<Usage>;


Using Collector as a general interface. Not exporting UsageCollector anymore. This will help in the future when/if we want to merge both entities back into one.

elasticmachine · 2021-04-29T11:04:30Z

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

elasticmachine · 2021-04-29T11:04:31Z

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

flash1293

Lens changes LGTM - great simplification!

Dosant

app services code changes lgtm

pgayvallet

LGTM

pgayvallet · 2021-05-02T19:16:50Z

src/plugins/usage_collection/server/collector/types.ts

+export interface ICollectorOptionsFetchExtendedContext<WithKibanaRequest extends boolean> {
+  /**
+   * Set to `true` if your `fetch` method requires the `KibanaRequest` object to be added in its context {@link CollectorFetchContextWithRequest}.
+   * @remark You should fully understand acknowledge that by using the `KibanaRequest` in your collector, you need to ensure it should specially work without it because it won't be provided when building the telemetry payload actually sent to the remote telemetry service.


NIT: You should fully understand acknowledge

pgayvallet · 2021-05-02T19:17:40Z

src/plugins/usage_collection/server/collector/types.ts

+   * Unique string identifier for the collector
+   */
+  type: string;
+  init?: Function;


Any way to be more specific than Function?

I'm actually wondering if we could remove it (I believe this API is not used at all since it was never documented). I'll see if that statement is true :)

…eCollection

kibanamachine · 2021-05-04T11:05:53Z

💚 Build Succeeded

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
`usageCollection`	46	1	-45

Async chunks

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

id	before	after	diff
`data`	176.9KB	176.9KB	-2.0B
`lens`	970.5KB	970.5KB	+26.0B
total			+24.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
`usageCollection`	7	0	-7

Page load bundle

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

id	before	after	diff
`data`	803.0KB	803.1KB	+98.0B
`lens`	35.3KB	35.1KB	-170.0B
`usageCollection`	8.4KB	8.3KB	-127.0B
total			-199.0B

Unknown metric groups

API count

id	before	after	diff
`usageCollection`	53	42	-11

History

💚 Build #123199 succeeded fedf20b
💚 Build #123181 succeeded df43089
💔 Build #123052 failed aa2bcadcc47d24005ad13faf56a0c26946e69fec
💔 Build #123037 failed bf0101be677136aa1746877455516de50e2eb258

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

kibanamachine · 2021-05-04T11:35:05Z

💔 Backport failed

Status	Branch	Result
❌	7.x	Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 98656

# Conflicts: # api_docs/usage_collection.json # api_docs/usage_collection.mdx

afharo · 2021-05-04T11:52:10Z

Backport to 7.x: #99186

# Conflicts: # api_docs/usage_collection.json # api_docs/usage_collection.mdx

afharo added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// Feature:Telemetry release_note:skip Skip the PR/issue when compiling release notes Team:KibanaTelemetry v7.14.0 APIDocs labels Apr 28, 2021

afharo commented Apr 28, 2021

View reviewed changes

afharo force-pushed the api_docs/usageCollection branch 2 times, most recently from f4b4285 to e5227cc Compare April 28, 2021 17:40

afharo commented Apr 28, 2021

View reviewed changes

afharo force-pushed the api_docs/usageCollection branch from e5227cc to aa2bcad Compare April 28, 2021 17:50

[API DOCS] Usage Collection

df43089

afharo force-pushed the api_docs/usageCollection branch from aa2bcad to df43089 Compare April 29, 2021 09:06

afharo commented Apr 29, 2021

View reviewed changes

afharo marked this pull request as ready for review April 29, 2021 11:04

afharo requested a review from a team April 29, 2021 11:04

afharo requested review from a team as code owners April 29, 2021 11:04

Fix @Link to @link

fedf20b

afharo force-pushed the api_docs/usageCollection branch from e846e3d to fedf20b Compare April 29, 2021 11:23

flash1293 approved these changes Apr 29, 2021

View reviewed changes

afharo mentioned this pull request Apr 29, 2021

[APIDocs] const + arrow functions result in uncommented function parameters #98744

Closed

Dosant approved these changes Apr 30, 2021

View reviewed changes

afharo added the auto-backport Deprecated - use backport:version if exact versions are needed label Apr 30, 2021

afharo mentioned this pull request Apr 30, 2021

Add Usage collection server setup/start types in API docs #95555

Closed

afharo linked an issue Apr 30, 2021 that may be closed by this pull request

Add Usage collection server setup/start types in API docs #95555

Closed

pgayvallet approved these changes May 2, 2021

View reviewed changes

Merge branch 'master' of github.com:elastic/kibana into api_docs/usag…

4868ab2

…eCollection

afharo added 2 commits May 4, 2021 11:06

Remove deprecated Collector.init + fix description remark

8bea657

Update api-docs

c67c999

afharo merged commit 6d22f6f into elastic:master May 4, 2021

afharo deleted the api_docs/usageCollection branch May 4, 2021 11:32

afharo mentioned this pull request May 4, 2021

[7.x] [API DOCS] Usage Collection (#98656) #99186

Merged

afharo added a commit to afharo/kibana that referenced this pull request May 4, 2021

[API DOCS] Usage Collection (elastic#98656)

c1e386b

# Conflicts: # api_docs/usage_collection.json # api_docs/usage_collection.mdx

afharo added a commit that referenced this pull request May 4, 2021

[API DOCS] Usage Collection (#98656) (#99186)

9ad99c3

# Conflicts: # api_docs/usage_collection.json # api_docs/usage_collection.mdx

lukeelmers removed the Team:KibanaTelemetry label Oct 1, 2021

Conversation

afharo commented Apr 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

For maintainers

Uh oh!

afharo Apr 28, 2021 • 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!

afharo Apr 28, 2021

Choose a reason for hiding this comment

Uh oh!

afharo Apr 28, 2021

Choose a reason for hiding this comment

Uh oh!

afharo Apr 29, 2021

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Apr 29, 2021

Uh oh!

elasticmachine commented Apr 29, 2021

Uh oh!

flash1293 left a comment

Choose a reason for hiding this comment

Uh oh!

Dosant left a comment

Choose a reason for hiding this comment

Uh oh!

pgayvallet left a comment

Choose a reason for hiding this comment

Uh oh!

pgayvallet May 2, 2021

Choose a reason for hiding this comment

Uh oh!

pgayvallet May 2, 2021

Choose a reason for hiding this comment

Uh oh!

afharo May 4, 2021

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented May 4, 2021

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

History

Uh oh!

kibanamachine commented May 4, 2021

💔 Backport failed

Uh oh!

afharo commented May 4, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

afharo commented Apr 28, 2021 •

edited

Loading

afharo Apr 28, 2021 •

edited

Loading