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

Logs flyout enhancements for use on APM service logs view #125869

Closed
6 tasks done
cyrille-leclerc opened this issue Feb 16, 2022 · 8 comments
Closed
6 tasks done

Logs flyout enhancements for use on APM service logs view #125869

cyrille-leclerc opened this issue Feb 16, 2022 · 8 comments
Labels
enhancement New value added to drive a business result epic Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services

Comments

@cyrille-leclerc
Copy link
Contributor

cyrille-leclerc commented Feb 16, 2022

@cyrille-leclerc cyrille-leclerc added enhancement New value added to drive a business result Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services labels Feb 16, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI)

@smith smith added the design label Feb 22, 2022
@weltenwort
Copy link
Member

@cyrille-leclerc, thanks for illustrating the changes! I'd like to ask some questions to increase the clarity further:

Permalink to share, via slack or via a bug ticket, the hyperlink to visualize the log entry

Should the link just navigate to the log stream at the specific time or should it also open the fly-out? We don't yet have a stable link schema for the latter, but it could be added.

Link to Kibana Discover in the "Investigate" drop down

Since Discover requires an underlying data view this would only be available if the log source was configured to use a data view itself. Would that be acceptable?

Easy access to the _id field

The id is shown in the title of the flyout. What would make it "easier" to access if it was added to the table?

@cyrille-leclerc
Copy link
Contributor Author

Thank you very much @weltenwort for your detailed review of my requests.

Permalink to share, via slack or via a bug ticket, the hyperlink to visualize the log entry

Should the link just navigate to the log stream at the specific time or should it also open the fly-out? We don't yet have a stable link schema for the latter, but it could be added.

I would like to link to a specific log message with "expanded view on this details". Today the way to visualize the details of a log message is the flyout so it would ideally be a link to the opened flyout.

I am not a huge fan of the flyout because it prevents from inspecting multiple log lines in parallel. I have the same problem in our trace explorer, I would prefer our GUI to expand a fragment of the underlying screen rather than introducing a modal flyout.

Link to Kibana Discover in the "Investigate" drop down

Since Discover requires an underlying data view this would only be available if the log source was configured to use a data view itself. Would that be acceptable?

I think so because configuring our logs explorer with a data view will be our recommended setup. Longer term, we should aim at supporting the same selection of underlying dataset in all screens. I think the ongoing search unification initiative (cc @jasonrhodes and @smith ) is our solution to make our GUIS more consistent.
If we disable "open in Discover" for "non data view settings", I would like to have a clear explanation provided to the user (maybe feature is greyed with online documentation explaining why I can't benefit of it)

Easy access to the _id field

The id is shown in the title of the flyout. What would make it "easier" to access if it was added to the table?

I was searching for the _idfield in the list of fields, the same way the _id field is listed with other fields in the Kibana Discover flyout.

By the way, why don't we reuse the Kibana Discover Flyout?

image

@weltenwort
Copy link
Member

I would like to link to a specific log message with "expanded view on this details". Today the way to visualize the details of a log message is the flyout so it would ideally be a link to the opened flyout.

I am not a huge fan of the flyout because it prevents from inspecting multiple log lines in parallel. I have the same problem in our trace explorer, I would prefer our GUI to expand a fragment of the underlying screen rather than introducing a modal flyout.

Yes, it's quite obtrusive. But that change would warrant a separate design effort.

[...] configuring our logs explorer with a data view will be our recommended setup. Longer term, we should aim at supporting the same selection of underlying dataset in all screens. I think the ongoing search unification initiative (cc @jasonrhodes and @smith ) is our solution to make our GUIS more consistent. If we disable "open in Discover" for "non data view settings", I would like to have a clear explanation provided to the user (maybe feature is greyed with online documentation explaining why I can't benefit of it)

Yes, that sounds good.

I was searching for the _idfield in the list of fields, the same way the _id field is listed with other fields in the Kibana Discover flyout.

I see. They must be explicitly merging the meta fields into the fly-out's field list. We could do that as well.

By the way, why don't we reuse the Kibana Discover Flyout?

Because our fly-out is older than Discover's. Until Discover recently changed their rendering to the data grid they used to expand the details of the documents inline. I don't know if it is written in a way that we can re-use it and add special elements like the links to APM and Uptime.

@cyrille-leclerc cyrille-leclerc changed the title [Logs App] From "Log Entry Details" flyout, want permalink, link to discover, and easier access to document _id [Logs App] From "Log Entry Details" flyout, want permalink, link to discover, navigation between lines, json, and easier access to document _id Apr 3, 2022
@cyrille-leclerc
Copy link
Contributor Author

Please note that I added the following enhancements to this umbrella ticket:

  • Navigation "|< < > >|" on log line details similar to Kibana Discover
  • Switch visualization of log line details between "Table" and "JSON" similar to Kibana Discover

Flyout versus inlined details
Yes, it's quite obtrusive. But that change would warrant a separate design effort.

💯 replacing the flyout by inlined details would be a big effort, broader than just this use case, not to be worked on for the moment but hopefully food for thoughts for our product design team (cc @katefarrar )

@cyrille-leclerc
Copy link
Contributor Author

@weltenwort as discussed, I broke down this umbrella enhancement request in 5 sub tickets.
@katefarrar @weltenwort please tell me if the problems to solve are refined enough. Please feel free to evolve the UX the want you want, my "mockups" are just intended to describe the idea.

@weltenwort
Copy link
Member

nice, thank you! I'll ask any further refining questions on the individual issues

@smith smith changed the title [Logs App] From "Log Entry Details" flyout, want permalink, link to discover, navigation between lines, json, and easier access to document _id Logs flyout enhancements for use on APM service logs view Apr 15, 2022
@smith smith added Feature:Logs UI Logs UI feature and removed design labels Apr 15, 2022
@smith
Copy link
Contributor

smith commented Jul 11, 2022

Closing this in favor of #134412.

@smith smith closed this as not planned Won't fix, can't repro, duplicate, stale Jul 11, 2022
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 epic Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services
Projects
None yet
Development

No branches or pull requests

5 participants