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

[Discover] Show ECS field descriptions in Discover, like Security app #97246

Closed
Tracked by #172341
gbanasiak opened this issue Apr 15, 2021 · 6 comments · Fixed by #187160
Closed
Tracked by #172341

[Discover] Show ECS field descriptions in Discover, like Security app #97246

gbanasiak opened this issue Apr 15, 2021 · 6 comments · Fixed by #187160
Labels
enhancement New value added to drive a business result Feature:Discover Discover Application impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:needs-research This issue requires some research before it can be worked on or estimated Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL.

Comments

@gbanasiak
Copy link
Contributor

gbanasiak commented Apr 15, 2021

Describe the feature:

Security app shows index field descriptions taken from ECS schema, example for 7.12.0:

Screenshot 2021-04-15 at 14 51 32

Descriptions are not present for fields copied from source indices (if not part of ECS schema).

Request:

  • provide a way to add descriptions for custom fields outside of ECS schema
  • extend display of field descriptions to Discover

Describe a specific use case for the feature:

Easier inspection of custom data.

@botelastic botelastic bot added the needs-team Issues missing a team label label Apr 15, 2021
@wylieconlon wylieconlon changed the title custom index field descriptions in Discover and Security app [Discover] Show ECS field descriptions in Discover, like Security app Apr 19, 2021
@wylieconlon wylieconlon added enhancement New value added to drive a business result Feature:Discover Discover Application Team:Visualizations Visualization editors, elastic-charts and infrastructure and removed needs-team Issues missing a team label labels Apr 19, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app (Team:KibanaApp)

@wylieconlon
Copy link
Contributor

wylieconlon commented Apr 19, 2021

@ebeahan
Copy link
Member

ebeahan commented Apr 29, 2021

@gbanasiak this sounds amazing!

provide a way to add descriptions for custom fields outside of ECS schema

We have some tooling around ECS that helps users manage their custom fields alongside ECS. Would be awesome to expand that support to this type of feature.

cc @elastic/ecs

@timroes
Copy link
Contributor

timroes commented Apr 30, 2021

I don't think we should tie that specifically to ECS in Discover, since it's a general purpose tool, but instead we should be able to show field descriptions in general, so that we can show helpful descriptions to whatever the users added as information to the fields. We're currently not loading them into index patterns unfortunately. I've created #98873 to track this.

@timroes timroes added Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. and removed Team:Visualizations Visualization editors, elastic-charts and infrastructure labels Aug 31, 2021
@jughosta
Copy link
Contributor

Linking to #89726

@jughosta jughosta added the impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. label Jan 24, 2023
@davismcphee davismcphee added the loe:needs-research This issue requires some research before it can be worked on or estimated label Sep 8, 2023
@kertal
Copy link
Member

kertal commented Jun 5, 2024

Since we now have a field fields metadata service this could be implemented #183806, so if no description is DataView Field Description is provided, we can use this new service to provide ECS description information

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Discover Discover Application impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:needs-research This issue requires some research before it can be worked on or estimated Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL.
Projects
None yet
8 participants