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.

Sign up for GitHub

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

Jump to bottom

[Usage Collection/schema] Add _meta.isOptional #98000

Closed
afharo opened this issue Apr 22, 2021 · 4 comments
Closed

[Usage Collection/schema] Add _meta.isOptional #98000

afharo opened this issue Apr 22, 2021 · 4 comments
Labels
Feature:Telemetry impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@afharo
Copy link
Member

afharo commented Apr 22, 2021

Related to #92781.

After adding _meta.description. It might be useful to be able to describe what fields are optional in the schema.

This could help us in defining stricter validation schemas for the telemetry payloads.
@afharo afharo added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Telemetry Team:KibanaTelemetry labels Apr 22, 2021
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@afharo
Copy link
Member Author

afharo commented Apr 22, 2021

An example of how we could implement this can be found in #95960.

Re prioritization, the team maintaining the Remote Telemetry Service don't have using this field in their roadmap yet. Although they mentioned that they would use it if available.

@exalate-issue-sync exalate-issue-sync bot added impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort labels Nov 4, 2021
@afharo
Copy link
Member Author

afharo commented Jan 27, 2022

I'm having second thoughts about this issue. While it's useful for internal validation, the fact is that most fields are optional because we skip any failed collectors and report whatever we managed to retrieve in the report.

I'll close the issue for now. Feel free to reopen if there's any need for this feature in the future.

@afharo afharo closed this as completed Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature:Telemetry impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@lukeelmers @afharo @elasticmachine