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

[APM Service Logs] Show flyout in LogsEmbeddable #111325

Closed
5 tasks done
Tracked by #125869
formgeist opened this issue Sep 7, 2021 · 9 comments · Fixed by #132617
Closed
5 tasks done
Tracked by #125869

[APM Service Logs] Show flyout in LogsEmbeddable #111325

formgeist opened this issue Sep 7, 2021 · 9 comments · Fixed by #132617
Assignees
Labels
enhancement New value added to drive a business result Feature:Logs UI Logs UI feature Team:APM All issues that need APM UI Team support Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services

Comments

@formgeist
Copy link
Contributor

formgeist commented Sep 7, 2021

📓 Summary

One of the existing capabilities of the Logs UI log stream view is the option to view the details of a specific log document in a fly-out which can be invoked from the context menu button when hovering each log line. This capability should be available for the shared <LogStream /> component as well.

✔️ Acceptance criteria

🎨 Mock-ups

Action menu and fly-out as currently shown in the Logs UI:
CleanShot 2021-09-07 at 09 53 32

APM: Show the details for a selected logline in the Logs tab for an individual Trace:
CleanShot 2021-09-07 at 09 57 41@2x

APM: Show the details within the Logs tab for the selected service:
CleanShot 2021-09-07 at 09 41 08@2x

💡 Implementation hints

  • The menu should show up when the onOpenLogEntryFlyout prop is passed to the ScrollableLogTextStreamView. So the shared component would just have to handle basic state mangement and conditionally mount the existing fly-out. Data loading is handled within the fly-out component already.

Possible follow-up tasks

CleanShot 2021-09-07 at 09 59 10@2x

@formgeist formgeist added Team:APM All issues that need APM UI Team support enhancement New value added to drive a business result 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 Epic: Shared Logs Component labels Sep 7, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/logs-metrics-ui (Team:logs-metrics-ui)

@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:apm)

@botelastic
Copy link

botelastic bot commented Mar 6, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@botelastic botelastic bot added the stale Used to mark issues that were closed for being stale label Mar 6, 2022
@formgeist
Copy link
Contributor Author

As indicated in #123256 this is one of the most prioritized features for places where the Logs component is embedded as it can provide additional details without having to navigate away from the existing context.

@jasonrhodes Do you want to ensure that we prioritize on our roadmap as part of supporting embedded use-cases within Observability? Thx

@botelastic botelastic bot removed the stale Used to mark issues that were closed for being stale label Mar 7, 2022
@formgeist
Copy link
Contributor Author

@jasonrhodes @smith Would you consider putting this on the planning for the next cycle? Would love to see this implemented in the embeddable logs component.

@weltenwort
Copy link
Member

The description shows that the log stream component is used deeply in UI hierarchies and in floating dialogs. Is the addition of a fly-out appropriate in all locations or do we need to be selective about it?

@formgeist
Copy link
Contributor Author

@weltenwort That's definitely worth considering, but in my opinion I don't think it makes sense in the above use-cases to change the behaviour depending on the location. I can imagine in all cases the user will want to learn more details about the log line and it will quickly become an expected interaction.

@katefarrar @katrin-freihofner any thoughts on adding the "view details" flyout for inspecting the log document detail in a flyout?

@katrin-freihofner
Copy link
Contributor

@formgeist Inventory is going to move that flying panel into a flyout which means triggering a flyout from a flyout. I think that's why @weltenwort is concerned. I think it can work - it just needs a bit more work to define the behavior in this case.

@formgeist
Copy link
Contributor Author

@katrin-freihofner Right, that's true. I didn't necessarily want this to be blocked by that conversion, but I imagine we can solve that use-case (and any subsequent use-cases that require to show the Logs component inside a flyout) after this implementation.

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:Logs UI Logs UI feature Team:APM All issues that need APM UI Team support Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants