[Telemetry] Full `schema` including Elasticsearch fields by afharo · Pull Request #92867 · elastic/kibana

afharo · 2021-02-25T17:51:52Z

Summary

This is a follow-up to #90273. It adds the definition of the Elasticsearch fields, being discussed as ES might provide the schema from their project instead.

I'll keep it as draft, but will rebase it from master once #90273 is merged until we agree on anything.

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

For maintainers

This was checked for breaking API changes and was labeled appropriately

…l-schema-definition

…est utils

…l-schema-definition

kibanamachine · 2021-02-25T18:48:14Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: a0a80e8
Storybooks Preview
Pipeline Steps (look for red circles / failed steps)
Interpreting CI Failures
Documentation Changes

Failed CI Steps

Test Failures

Kibana Pipeline / general / X-Pack API Integration Tests.x-pack/test/api_integration/apis/telemetry/telemetry_local·ts.apis Telemetry /api/telemetry/v2/clusters/_stats with monitoring disabled should pass the schema validation

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has failed 1 times on tracked branches: https://dryrun

[00:00:00]       │
[00:00:00]         └-: apis
[00:00:00]           └-> "before all" hook in "apis"
[00:01:34]           └-: Telemetry
[00:01:34]             └-> "before all" hook in "Telemetry"
[00:01:37]             └-: /api/telemetry/v2/clusters/_stats with monitoring disabled
[00:01:37]               └-> "before all" hook for "should pass the schema validation"
[00:01:37]               └-> "before all" hook: disable monitoring and pull local stats for "should pass the schema validation"
[00:01:39]               └-> should pass the schema validation
[00:01:39]                 └-> "before each" hook: global before each for "should pass the schema validation"
[00:01:40]                 └- ✖ fail: apis Telemetry /api/telemetry/v2/clusters/_stats with monitoring disabled should pass the schema validation
[00:01:40]                 │      Error: The telemetry schemas in 'x-pack/plugins/telemetry_collection_xpack/schema/' are out-of-date, please update it as required: [stack_stats.xpack.ml.data_frame_analytics_jobs.memory_usage]: definition for this key is missing. Received `{"peak_usage_bytes":{"total":0,"min":0,"avg":0,"max":0}}`
[00:01:40]                 │       at ObjectType.validate (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:51:19)
[00:01:40]                 │       at assertTelemetryPayload (/dev/shm/workspace/parallel/17/kibana/test/api_integration/apis/telemetry/utils/schema_to_config_schema.ts:129:34)
[00:01:40]                 │       at Context.apply (test/api_integration/apis/telemetry/telemetry_local.ts:57:9)
[00:01:40]                 │       at Object.apply (/dev/shm/workspace/parallel/17/kibana/packages/kbn-test/src/functional_test_runner/lib/mocha/wrap_function.js:73:30)
[00:01:40]                 │ 
[00:01:40]                 │

Stack Trace

ValidationError: The telemetry schemas in 'x-pack/plugins/telemetry_collection_xpack/schema/' are out-of-date, please update it as required: [stack_stats.xpack.ml.data_frame_analytics_jobs.memory_usage]: definition for this key is missing. Received `{"peak_usage_bytes":{"total":0,"min":0,"avg":0,"max":0}}`
    at ObjectType.validate (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:51:19)
    at assertTelemetryPayload (/dev/shm/workspace/parallel/17/kibana/test/api_integration/apis/telemetry/utils/schema_to_config_schema.ts:129:34)
    at Context.apply (test/api_integration/apis/telemetry/telemetry_local.ts:57:9)
    at Object.apply (/dev/shm/workspace/parallel/17/kibana/packages/kbn-test/src/functional_test_runner/lib/mocha/wrap_function.js:73:30) {
  cause: SchemaTypeError: definition for this key is missing
      at ObjectType.onError (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:76:20)
      at type.<anonymous> (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:41:53)
      at finish (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:529:50)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:618:24)
      at type._base (/dev/shm/workspace/kibana/node_modules/joi/lib/types/object/index.js:212:45)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:614:37)
      at type._base (/dev/shm/workspace/kibana/node_modules/joi/lib/types/object/index.js:212:45)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:614:37)
      at type._base (/dev/shm/workspace/kibana/node_modules/joi/lib/types/object/index.js:212:45)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:614:37)
      at type._base (/dev/shm/workspace/kibana/node_modules/joi/lib/types/object/index.js:212:45)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:614:37)
      at type._validateWithOptions (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:674:29)
      at module.exports.internals.Any.root.validate (/dev/shm/workspace/kibana/node_modules/joi/lib/index.js:146:23)
      at ObjectType.validate (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:46:72)
      at assertTelemetryPayload (/dev/shm/workspace/parallel/17/kibana/test/api_integration/apis/telemetry/utils/schema_to_config_schema.ts:129:34)
      at Context.apply (/dev/shm/workspace/parallel/17/kibana/x-pack/test/api_integration/apis/telemetry/telemetry_local.ts:57:9)
      at Object.apply (/dev/shm/workspace/parallel/17/kibana/packages/kbn-test/src/functional_test_runner/lib/mocha/wrap_function.js:73:30) {
    cause: undefined,
    path: [
      'stack_stats',
      'xpack',
      'ml',
      'data_frame_analytics_jobs',
      'memory_usage'
    ]
  }
}

Kibana Pipeline / general / X-Pack API Integration Tests.x-pack/test/api_integration/apis/telemetry/telemetry_local·ts.apis Telemetry /api/telemetry/v2/clusters/_stats with monitoring disabled should pass the schema validation

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has not failed recently on tracked branches

[00:00:00]       │
[00:00:00]         └-: apis
[00:00:00]           └-> "before all" hook in "apis"
[00:01:36]           └-: Telemetry
[00:01:36]             └-> "before all" hook in "Telemetry"
[00:01:41]             └-: /api/telemetry/v2/clusters/_stats with monitoring disabled
[00:01:41]               └-> "before all" hook for "should pass the schema validation"
[00:01:41]               └-> "before all" hook: disable monitoring and pull local stats for "should pass the schema validation"
[00:01:42]               └-> should pass the schema validation
[00:01:42]                 └-> "before each" hook: global before each for "should pass the schema validation"
[00:01:43]                 └- ✖ fail: apis Telemetry /api/telemetry/v2/clusters/_stats with monitoring disabled should pass the schema validation
[00:01:43]                 │      Error: The telemetry schemas in 'x-pack/plugins/telemetry_collection_xpack/schema/' are out-of-date, please update it as required: [stack_stats.xpack.ml.data_frame_analytics_jobs.memory_usage]: definition for this key is missing. Received `{"peak_usage_bytes":{"total":0,"min":0,"avg":0,"max":0}}`
[00:01:43]                 │       at ObjectType.validate (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:51:19)
[00:01:43]                 │       at assertTelemetryPayload (/dev/shm/workspace/parallel/17/kibana/test/api_integration/apis/telemetry/utils/schema_to_config_schema.ts:129:34)
[00:01:43]                 │       at Context.apply (test/api_integration/apis/telemetry/telemetry_local.ts:57:9)
[00:01:43]                 │       at Object.apply (/dev/shm/workspace/parallel/17/kibana/packages/kbn-test/src/functional_test_runner/lib/mocha/wrap_function.js:73:30)
[00:01:43]                 │ 
[00:01:43]                 │

Stack Trace

ValidationError: The telemetry schemas in 'x-pack/plugins/telemetry_collection_xpack/schema/' are out-of-date, please update it as required: [stack_stats.xpack.ml.data_frame_analytics_jobs.memory_usage]: definition for this key is missing. Received `{"peak_usage_bytes":{"total":0,"min":0,"avg":0,"max":0}}`
    at ObjectType.validate (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:51:19)
    at assertTelemetryPayload (/dev/shm/workspace/parallel/17/kibana/test/api_integration/apis/telemetry/utils/schema_to_config_schema.ts:129:34)
    at Context.apply (test/api_integration/apis/telemetry/telemetry_local.ts:57:9)
    at Object.apply (/dev/shm/workspace/parallel/17/kibana/packages/kbn-test/src/functional_test_runner/lib/mocha/wrap_function.js:73:30) {
  cause: SchemaTypeError: definition for this key is missing
      at ObjectType.onError (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:76:20)
      at type.<anonymous> (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:41:53)
      at finish (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:529:50)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:618:24)
      at type._base (/dev/shm/workspace/kibana/node_modules/joi/lib/types/object/index.js:212:45)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:614:37)
      at type._base (/dev/shm/workspace/kibana/node_modules/joi/lib/types/object/index.js:212:45)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:614:37)
      at type._base (/dev/shm/workspace/kibana/node_modules/joi/lib/types/object/index.js:212:45)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:614:37)
      at type._base (/dev/shm/workspace/kibana/node_modules/joi/lib/types/object/index.js:212:45)
      at type._validate (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:614:37)
      at type._validateWithOptions (/dev/shm/workspace/kibana/node_modules/joi/lib/types/any/index.js:674:29)
      at module.exports.internals.Any.root.validate (/dev/shm/workspace/kibana/node_modules/joi/lib/index.js:146:23)
      at ObjectType.validate (/dev/shm/workspace/parallel/17/kibana/packages/kbn-config-schema/target/out/types/type.js:46:72)
      at assertTelemetryPayload (/dev/shm/workspace/parallel/17/kibana/test/api_integration/apis/telemetry/utils/schema_to_config_schema.ts:129:34)
      at Context.apply (/dev/shm/workspace/parallel/17/kibana/x-pack/test/api_integration/apis/telemetry/telemetry_local.ts:57:9)
      at Object.apply (/dev/shm/workspace/parallel/17/kibana/packages/kbn-test/src/functional_test_runner/lib/mocha/wrap_function.js:73:30) {
    cause: undefined,
    path: [
      'stack_stats',
      'xpack',
      'ml',
      'data_frame_analytics_jobs',
      'memory_usage'
    ]
  }
}

Metrics [docs]

✅ unchanged

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

afharo and others added 25 commits February 5, 2021 12:23

[Telemetry] Full schema definition

1b529a1

Add OSS tests

2cf5fed

Sort OSS tests

9e00b1b

Add X-Pack tests + better message error message

d2c0bd6

Fix missing fields in xpack_root

b28e262

Fix schemas for actions, alerts and APM

1e17622

Add documentation about testing

c3a9418

Update APM test snapshot

fdd6f19

Merge branch 'master' into telemetry/full-schema-definition

42e8489

Use DYNAMIC_KEY in the spaces.disabledFeatures collector

6705e90

Fix xpack.data_tiers schema

64102c9

Merge branch 'master' into telemetry/full-schema-definition

4e2e0bb

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

8e46903

…l-schema-definition

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

b3d33b6

…l-schema-definition

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

481bafc

…l-schema-definition

Add unit tests to the test utils

f0cb981

Add "jest" to the types in functional tests: used for unit tests of t…

ae7efdb

…est utils

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

548a290

…l-schema-definition

Move unit tests to JS because of Jest typing issues in the mocha world

0e07709

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

2c5ceea

…l-schema-definition

Merge branch 'master' into telemetry/full-schema-definition

4f9e3e7

Merge branch 'master' into telemetry/full-schema-definition

a4d2e8b

Merge branch 'master' into telemetry/full-schema-definition

7b8096c

Merge branch 'master' into telemetry/full-schema-definition

2d80f23

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

a0a80e8

…l-schema-definition

afharo mentioned this pull request Feb 25, 2021

[Telemetry] Full schema definition #90273

Merged

3 tasks

legrego closed this Jul 17, 2024

afharo deleted the telemetry/full-schema-definition-elasticsearch-fields branch July 17, 2024 18:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Telemetry] Full `schema` including Elasticsearch fields#92867

[Telemetry] Full `schema` including Elasticsearch fields#92867
afharo wants to merge 25 commits intoelastic:mainfrom
afharo:telemetry/full-schema-definition-elasticsearch-fields

afharo commented Feb 25, 2021

Uh oh!

kibanamachine commented Feb 25, 2021 •

edited

Loading

Standard Out

Stack Trace

Standard Out

Stack Trace

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

afharo commented Feb 25, 2021

Summary

Checklist

For maintainers

Uh oh!

kibanamachine commented Feb 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Failed CI Steps

Test Failures

Standard Out

Stack Trace

Standard Out

Stack Trace

Metrics [docs]

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

kibanamachine commented Feb 25, 2021 •

edited

Loading