[telemetry] add schema guideline + schema_check new check for --path config #75747

Bamieh · 2020-08-24T12:50:55Z

Add a schema guideline to help teams update their collector schemas.

Context: #70180

elasticmachine · 2020-08-24T12:50:57Z

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

afharo

Great piece of work! I'd just like to better understand some comments and questions I've got before giving the final LGTM 🙂

Also added some NITs that I think we can improve in separate issues.

packages/kbn-telemetry-tools/GUIDELINE.md

packages/kbn-telemetry-tools/src/cli/run_telemetry_check.ts

afharo · 2020-08-24T14:15:13Z

packages/kbn-telemetry-tools/src/cli/run_telemetry_check.ts

+        {
+          enabled: () => typeof path !== 'undefined',
+          title: 'Checking collectors in --path are not excluded',
+          task: ({ roots }: TaskContext) => {
+            const totalCollections = roots.reduce((acc, root) => {
+              return acc + (root.parsedCollections?.length || 0);
+            }, 0);
+            const collectorsInPath = Array.isArray(path) ? path.length : 1;
+
+            if (totalCollections !== collectorsInPath) {
+              throw new Error(
+                'Collector specified in `path` is excluded; Check the telemetryrc.json files.'
+              );
+            }
+          },
+        },


Just to fully understand this piece of code: Each path should only contain one collector for this to work. i.e.: I can't run --path=src/plugins/kibana_usage_collection

Is that correct?

yes. It is documented in the README as well:

--path specifies a collector path instead of checking all collectors specified in the .telemetryrc.json files. Accepts a .ts file. The file must be discoverable by at least one rc file.

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

…ema_guideline

kibanamachine · 2020-09-14T13:27:00Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: d05db32

Build metrics

distributable file count

id	value	diff	baseline
default	45519	+1	45518
oss	27224	+1	27223
total		+2

History

💔 Build #69968 failed d3af5e1

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

afharo

LGMT!

…config (elastic#75747)

* master: (26 commits) updating datatable type (elastic#77320) [ML] Fix custom URLs processing for security app (elastic#76957) [telemetry] add schema guideline + schema_check new check for --path config (elastic#75747) [ML] Transforms: API schemas and integration tests (elastic#75164) [Mappings editor] Add support for wildcard field type (elastic#76574) [Ingest Manager] Fix flyout instruction selection (elastic#77071) [Telemetry Tools] update lodash to 4.17 (elastic#77317) [APM] Service inventory redesign (elastic#76744) Hide management sections based on cluster/index privileges (elastic#67791) [Snapshot Restore] Disable steps when form is invalid (elastic#76540) [Mappings editor] Add support for positive_score_impact to rank_feature (elastic#76824) Update apm.ts (elastic#77310) [OBS] Remove beta badge, change news feed size and add external icon to news feed link (elastic#77164) [Discover] Convert legacy sort to be compatible with multi sort (elastic#76986) [APM] API Snapshot Testing (elastic#77229) [ML] Functional tests - increase wait time for DFA start (elastic#77307) [UiActions][Drilldowns] Fix actions sorting in context menu (elastic#77162) [Drilldowns] Wire up new links to new docs (elastic#77154) Fix APM issue template [Ingest Pipelines] Drop into an empty tree (elastic#76885) ...

…-path config (#75747) (#77358)

* master: (65 commits) [Security Solution][Resolver] Analyzed event styling (elastic#77115) filter invalid SOs from the searc hresults in Task Manager (elastic#76891) [RUM Dashboard] Visitors by region map (elastic#77135) [Security Solution][Endpoint][Admin] Task/endpoint list actions (elastic#76555) [Ingest pipelines] Forms for processors T-U (elastic#76710) updating datatable type (elastic#77320) [ML] Fix custom URLs processing for security app (elastic#76957) [telemetry] add schema guideline + schema_check new check for --path config (elastic#75747) [ML] Transforms: API schemas and integration tests (elastic#75164) [Mappings editor] Add support for wildcard field type (elastic#76574) [Ingest Manager] Fix flyout instruction selection (elastic#77071) [Telemetry Tools] update lodash to 4.17 (elastic#77317) [APM] Service inventory redesign (elastic#76744) Hide management sections based on cluster/index privileges (elastic#67791) [Snapshot Restore] Disable steps when form is invalid (elastic#76540) [Mappings editor] Add support for positive_score_impact to rank_feature (elastic#76824) Update apm.ts (elastic#77310) [OBS] Remove beta badge, change news feed size and add external icon to news feed link (elastic#77164) [Discover] Convert legacy sort to be compatible with multi sort (elastic#76986) [APM] API Snapshot Testing (elastic#77229) ...

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

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

Bamieh added 2 commits August 24, 2020 15:46

add guideline

f88977c

remove unrelated changes

d3af5e1

Bamieh added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:KibanaTelemetry v7.10.0 labels Aug 24, 2020

Bamieh requested a review from a team as a code owner August 24, 2020 12:50

afharo reviewed Aug 24, 2020

View reviewed changes

afharo mentioned this pull request Aug 24, 2020

[Telemetry] schema check throw on missing schema #75750

Merged

Bamieh added 2 commits September 14, 2020 14:49

refocus PR to only the guideline

ea3db21

run telemetry extract

254806e

Bamieh requested a review from afharo September 14, 2020 11:51

Merge branch 'master' of github.com:elastic/kibana into telemetry/sch…

d05db32

…ema_guideline

Bamieh changed the title ~~[telemetry] add schema guideline~~ [telemetry] add schema guideline + schema_check new check for --path config Sep 14, 2020

afharo approved these changes Sep 14, 2020

View reviewed changes

Bamieh merged commit 8eb4b2e into elastic:master Sep 14, 2020

Bamieh deleted the telemetry/schema_guideline branch September 14, 2020 14:39

Bamieh added a commit to Bamieh/kibana that referenced this pull request Sep 14, 2020

[telemetry] add schema guideline + schema_check new check for --path …

24fb382

…config (elastic#75747)

Bamieh mentioned this pull request Sep 14, 2020

[7.x] [telemetry] add schema guideline + schema_check new check for --path config (#75747) #77358

Merged

Bamieh added a commit that referenced this pull request Sep 14, 2020

[7.x] [telemetry] add schema guideline + schema_check new check for -…

0764fc7

…-path config (#75747) (#77358)

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

lukeelmers added Feature:Telemetry and removed Team:KibanaTelemetry labels Oct 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[telemetry] add schema guideline + schema_check new check for --path config #75747

[telemetry] add schema guideline + schema_check new check for --path config #75747

Bamieh commented Aug 24, 2020

elasticmachine commented Aug 24, 2020

afharo left a comment

afharo Aug 24, 2020

Bamieh Sep 14, 2020

kibanamachine commented Sep 14, 2020

afharo left a comment

elasticmachine commented Oct 1, 2021

[telemetry] add schema guideline + schema_check new check for --path config #75747

[telemetry] add schema guideline + schema_check new check for --path config #75747

Conversation

Bamieh commented Aug 24, 2020

elasticmachine commented Aug 24, 2020

afharo left a comment

Choose a reason for hiding this comment

afharo Aug 24, 2020

Choose a reason for hiding this comment

Bamieh Sep 14, 2020

Choose a reason for hiding this comment

kibanamachine commented Sep 14, 2020

💚 Build Succeeded

Build metrics

distributable file count

History

afharo left a comment

Choose a reason for hiding this comment

elasticmachine commented Oct 1, 2021