Kibana: [Telemetry] [schema] Define schema for the data that is reported by the `telemetry` plugin

Created on 18 Nov 2020  路  5Comments  路  Source: elastic/kibana

We currently have a way to define the schema that is returned by the Usage Collectors.

They usually end up under stack_stats.kibana.plugins.[]. But we need to find a way to define and keep up to date the structure of the data that we return for every other fields (other stack_stats.[PRODUCT], and the stack_stats.kibana and root keys like version, cluster_stats, etc.).

This way we can have a _contract_ with the remote telemetry service for all the fields that we send.

Telemetry KibanaTelemetry

All 5 comments

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

Additional tasks required to support this:

  • [ ] Update the telemetry-tools
  • [ ] Update the schema-to-mapping tools in the telemetry repo

Note: nodes/usage fields will need to be mostly dynamic. We might also need to get non-kibana teams to supply the schemas somehow.

I suggest that we keep away from complicating the tools we have to support the "static" part of the data we report. I think adding a static file for the remainder of the reported fields in the telemetry repo should be more than enough. I dont recall any changes to those fields since the past 2 years or so.

Makes sense! +1 on creating static schemas for that.

I'd add on top some sort of validation based on the schema we define in the API's functional tests to make sure we are compliant over time. How does that sound?

+1 to including functional tests in the scope of this task

Was this page helpful?
0 / 5 - 0 ratings

Related issues

LukeMathWalker picture LukeMathWalker  路  3Comments

snide picture snide  路  3Comments

treussart picture treussart  路  3Comments

socialmineruser1 picture socialmineruser1  路  3Comments

timmolter picture timmolter  路  3Comments