-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[Usage Collection] Supports field descriptions as meta data #92701
[Usage Collection] Supports field descriptions as meta data #92701
Conversation
…itted to mapping files
src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed 2 gotchas (probably IDE related). Once those are fixed, it LGTM.
src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
Outdated
Show resolved
Hide resolved
src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
Outdated
Show resolved
Hide resolved
src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
Outdated
Show resolved
Hide resolved
…nt/schema.ts Co-authored-by: Alejandro Fernández Haro <[email protected]>
…nt/schema.ts Co-authored-by: Alejandro Fernández Haro <[email protected]>
Add trailing whitespace back.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Pending on green CI! Thank you for doing this @TinaHeiligers
💚 Build SucceededMetrics [docs]Async chunks
Page load bundle
To update your PR or re-run it, just comment with: |
💔 Backport failed❌ 7.x: Commit could not be cherrypicked due to conflicts To backport manually, check out the target branch and run: |
…92701) Co-authored-by: Alejandro Fernández Haro <[email protected]> Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # src/plugins/kibana_usage_collection/server/collectors/management/schema.ts
…2701) (#93295) * [Usage Collection] Supports field descriptions as meta data (#92701) Co-authored-by: Alejandro Fernández Haro <[email protected]> Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # src/plugins/kibana_usage_collection/server/collectors/management/schema.ts * Updates schema
Resolves #89685
This PR enables support for field-level descriptions to allow developers to document what each field in their collector represents.
The
description
is support as plain text and makes no assumptions on the length of the string that is provided.The
description
is added to an optional new schema field level_meta
object that will enable other meta data to be added at a later stage.Descriptions are added to the
localization
collector as an initial implementation example.Before:
After:
Adds descriptions to usage collectors in
kibana_usage_collection
:Checklist
Delete any items that are not applicable to this PR.
For maintainers