[Usage Collection] [schema] `lens` #77929

afharo · 2020-09-18T16:40:19Z

Summary

Add schema definition to the collector lens.
Add support for type aliases, & unions and Record<string, SOMETHING> in the @kbn/telemetry-tools
Fixed additional nesting in IndexSignature definitions in @kbn/telemetry-tools

Related to #70180.

Checklist

Delete any items that are not applicable to this PR.

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

elasticmachine · 2020-09-18T16:40:22Z

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

wylieconlon · 2020-09-18T16:46:27Z

x-pack/plugins/lens/server/usage/schema.ts

+  indexpattern_dimension_operation_max: { type: 'long' },
+  indexpattern_dimension_operation_sum: { type: 'long' },
+  indexpattern_dimension_operation_count: { type: 'long' },
+  indexpattern_dimension_operation_cardinality: { type: 'long' },


I believe you are missing one of the newly added functions, indexpattern_dimension_operation_filters

wylieconlon · 2020-09-18T16:46:48Z

x-pack/plugins/lens/server/usage/schema.ts

+const suggestionEventsSchema: MakeSchemaFrom<LensUsage['suggestion_events_30_days']> = {
+  back_to_current: { type: 'long' },
+  reload: { type: 'long' },
+  position_0_of_5: { type: 'long' },


Just removed this one

Suggested change

position_0_of_5: { type: 'long' },

wylieconlon · 2020-09-18T16:48:41Z

x-pack/plugins/lens/server/usage/schema.ts

+
+const savedSchema: MakeSchemaFrom<LensUsage['saved_overall']> = {
+  bar_stacked: { type: 'long' },
+  // TODO: Extend this list as we know more visualizationTypes


The full list is here https://github.com/elastic/telemetry/issues/453

wylieconlon · 2020-09-18T16:49:06Z

x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json

+            },
+            "indexpattern_dimension_operation_cardinality": {
+              "type": "long"
+            }


Same comment about the filters operation

wylieconlon · 2020-09-18T16:49:14Z

x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json

+              "type": "long"
+            },
+            "position_0_of_5": {
+              "type": "long"


Not valid any more

afharo · 2020-09-18T17:07:08Z

Thank you @wylieconlon! I've amended the schema. Do you mind taking a second look?

wylieconlon

Approving the Lens-related parts, can't comment on the more general changes

afharo · 2020-09-21T09:53:30Z

@elasticmachine merge upstream

afharo · 2020-09-23T17:30:43Z

@elasticmachine merge upstream

afharo · 2020-09-23T17:54:12Z

@elasticmachine merge upstream

kibanamachine · 2020-09-23T19:30:55Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 5ef9e7f

Build metrics

distributable file count

id	value	diff	baseline
default	45868	+1	45867

History

💚 Build #75797 succeeded 04f45d8
💚 Build #75648 succeeded e4e7079
💚 Build #75633 succeeded 40ef8db

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

TinaHeiligers

I'm not sure if we missed position_0_of_5 in the schema or if it's added in the indexing layer.
Otherwise. LGTM

TinaHeiligers · 2020-09-23T21:38:44Z

x-pack/plugins/lens/server/usage/schema.ts

+
+const suggestionEventsSchema: MakeSchemaFrom<LensUsage['suggestion_events_30_days']> = {
+  back_to_current: { type: 'long' },
+  reload: { type: 'long' },


xpack-phone-home also has a position_0_of_5 field (type: long) in the suggestion_events_30_days field.

Wylie asked to remove it because they are not sending it anymore 🙂

TinaHeiligers · 2020-09-23T22:02:41Z

packages/kbn-telemetry-tools/src/tools/serializer.ts

@@ -157,6 +165,19 @@ export function getDescriptor(node: ts.Node, program: ts.Program): Descriptor |
    return uniqueKinds[0];
  }

+  // Support `type MyUsageType = SomethingElse`


Personally, I'm not a fan of type aliases but see them often enough to warrant adding support here.

I agree. The underlying reason to support it is type MyType = Something & SomethingElse, which definitely has a point 🙂

Co-authored-by: Elastic Machine <[email protected]>

Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

elasticmachine · 2021-10-01T21:38:36Z

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

[Usage Collection] [schema] lens

40ef8db

afharo added Feature:Telemetry v8.0.0 Feature:Lens Team:KibanaTelemetry v7.10.0 labels Sep 18, 2020

afharo requested a review from a team as a code owner September 18, 2020 16:40

afharo requested a review from a team September 18, 2020 16:40

afharo added the release_note:skip Skip the PR/issue when compiling release notes label Sep 18, 2020

afharo mentioned this pull request Sep 18, 2020

[Telemetry] [Collectors] Required schema fixes #70180

Closed

14 tasks

wylieconlon suggested changes Sep 18, 2020

View reviewed changes

Revisit fields in the schema based on Lens team comments

e4e7079

afharo requested a review from wylieconlon September 18, 2020 17:07

wylieconlon approved these changes Sep 18, 2020

View reviewed changes

Merge branch 'master' into usage_collection/schema/lens

04f45d8

Merge branch 'master' into usage_collection/schema/lens

95c644c

Merge branch 'master' into usage_collection/schema/lens

5ef9e7f

TinaHeiligers approved these changes Sep 23, 2020

View reviewed changes

afharo merged commit 4d08763 into elastic:master Sep 24, 2020

afharo deleted the usage_collection/schema/lens branch September 24, 2020 10:41

afharo added a commit to afharo/kibana that referenced this pull request Sep 24, 2020

[Usage Collection] [schema] lens (elastic#77929)

3284ca8

Co-authored-by: Elastic Machine <[email protected]>

afharo mentioned this pull request Sep 24, 2020

[7.x] [Usage Collection] [schema] lens (#77929) #78401

Merged

afharo added a commit that referenced this pull request Sep 24, 2020

[7.x] [Usage Collection] [schema] lens (#77929) (#78401)

0b62537

Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

lukeelmers added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Oct 1, 2021

lukeelmers removed the Team:KibanaTelemetry label Oct 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Usage Collection] [schema] `lens` #77929

[Usage Collection] [schema] `lens` #77929

afharo commented Sep 18, 2020

elasticmachine commented Sep 18, 2020

wylieconlon Sep 18, 2020

TinaHeiligers Sep 23, 2020

wylieconlon Sep 18, 2020

wylieconlon Sep 18, 2020

wylieconlon Sep 18, 2020

TinaHeiligers Sep 23, 2020

wylieconlon Sep 18, 2020

afharo commented Sep 18, 2020

wylieconlon left a comment

afharo commented Sep 21, 2020

afharo commented Sep 23, 2020

afharo commented Sep 23, 2020

kibanamachine commented Sep 23, 2020

TinaHeiligers left a comment

TinaHeiligers Sep 23, 2020

afharo Sep 24, 2020

TinaHeiligers Sep 23, 2020

afharo Sep 24, 2020

elasticmachine commented Oct 1, 2021

[Usage Collection] [schema] lens #77929

[Usage Collection] [schema] lens #77929

Conversation

afharo commented Sep 18, 2020

Summary

Checklist

For maintainers

elasticmachine commented Sep 18, 2020

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 Sep 18, 2020

wylieconlon left a comment

Choose a reason for hiding this comment

afharo commented Sep 21, 2020

afharo commented Sep 23, 2020

afharo commented Sep 23, 2020

kibanamachine commented Sep 23, 2020

💚 Build Succeeded

Build metrics

distributable file count

History

TinaHeiligers left a 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

elasticmachine commented Oct 1, 2021

[Usage Collection] [schema] `lens` #77929

[Usage Collection] [schema] `lens` #77929