Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Telemetry] Full schema definition #90273

Merged
merged 28 commits into from
Mar 1, 2021
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
1b529a1
[Telemetry] Full `schema` definition
afharo Feb 4, 2021
2cf5fed
Add OSS tests
afharo Feb 4, 2021
9e00b1b
Sort OSS tests
afharo Feb 5, 2021
d2c0bd6
Add X-Pack tests + better message error message
afharo Feb 5, 2021
b28e262
Fix missing fields in xpack_root
afharo Feb 5, 2021
1e17622
Fix schemas for actions, alerts and APM
afharo Feb 5, 2021
c3a9418
Add documentation about testing
afharo Feb 5, 2021
fdd6f19
Update APM test snapshot
afharo Feb 5, 2021
42e8489
Merge branch 'master' into telemetry/full-schema-definition
kibanamachine Feb 8, 2021
6705e90
Use DYNAMIC_KEY in the spaces.disabledFeatures collector
afharo Feb 8, 2021
64102c9
Fix xpack.data_tiers schema
afharo Feb 8, 2021
4e2e0bb
Merge branch 'master' into telemetry/full-schema-definition
kibanamachine Feb 9, 2021
8e46903
Merge branch 'master' of github.com:elastic/kibana into telemetry/ful…
afharo Feb 10, 2021
b3d33b6
Merge branch 'master' of github.com:elastic/kibana into telemetry/ful…
afharo Feb 10, 2021
481bafc
Merge branch 'master' of github.com:elastic/kibana into telemetry/ful…
afharo Feb 11, 2021
f0cb981
Add unit tests to the test utils
afharo Feb 11, 2021
ae7efdb
Add "jest" to the types in functional tests: used for unit tests of t…
afharo Feb 11, 2021
548a290
Merge branch 'master' of github.com:elastic/kibana into telemetry/ful…
afharo Feb 11, 2021
0e07709
Move unit tests to JS because of Jest typing issues in the `mocha` world
afharo Feb 11, 2021
2c5ceea
Merge branch 'master' of github.com:elastic/kibana into telemetry/ful…
afharo Feb 11, 2021
4f9e3e7
Merge branch 'master' into telemetry/full-schema-definition
kibanamachine Feb 15, 2021
a4d2e8b
Merge branch 'master' into telemetry/full-schema-definition
kibanamachine Feb 17, 2021
7b8096c
Merge branch 'master' into telemetry/full-schema-definition
kibanamachine Feb 19, 2021
2d80f23
Merge branch 'master' into telemetry/full-schema-definition
kibanamachine Feb 22, 2021
a0a80e8
Merge branch 'master' of github.com:elastic/kibana into telemetry/ful…
afharo Feb 25, 2021
f041b19
Do not validate ES-sourced data for now
afharo Feb 25, 2021
74967d0
Merge branch 'master' into telemetry/full-schema-definition
kibanamachine Mar 1, 2021
eef6173
Add documentation about the new type `pass_through`
afharo Mar 1, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions .telemetryrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,6 @@
{
"output": "src/plugins/telemetry/schema/oss_plugins.json",
"root": "src/plugins/",
"exclude": [
"src/plugins/kibana_react/",
"src/plugins/testbed/",
"src/plugins/kibana_utils/"
]
},
{
"output": "src/plugins/telemetry/schema/legacy_plugins.json",
"root": "src/legacy/server/",
"exclude": []
}
]
17 changes: 17 additions & 0 deletions src/plugins/telemetry/schema/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Telemetry Schemas

This list of `.json` files describes the format of the payloads sent to the Remote Telemetry Service. All the files should follow the schema convention as defined in the `usage_collection` plugin and `@kbn/telemetry-tools`.

There are currently 2 files:

- `oss_root.json`: Defines the schema for the payload from the root keys.
Manually maintained for now because the frequency it changes should be pretty low.
- `oss_plugins.json`: The schema for the content that will be nested in `stack_stats.kibana.plugins`.
It is automatically generated by `@kbn/telemetry-tools` based on the `schema` property provided by all the registered Usage Collectors via the `usageCollection.makeUsageCollector` API.
More details in the [Schema field](../../usage_collection/README.md#schema-field) chapter in the UsageCollection's docs.

NOTE: Despite its similarities to ES mappings, the intention of these files is not to define any index mappings. They should be considered as a tool to understand the format of the payload that will be sent when reporting telemetry to the Remote Service.

## Testing

Functional tests are defined at `test/api_integration/apis/telemetry/telemetry_local.ts`. They merge both files, and validates the actual output of the telemetry endpoint against the final schema.
3 changes: 0 additions & 3 deletions src/plugins/telemetry/schema/legacy_plugins.json

This file was deleted.

Loading