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

[Log Stream] Soft-deprecate log stream app and embeddable #184992

Closed
flash1293 opened this issue Jun 7, 2024 · 20 comments · Fixed by #186510
Closed

[Log Stream] Soft-deprecate log stream app and embeddable #184992

flash1293 opened this issue Jun 7, 2024 · 20 comments · Fixed by #186510
Assignees
Labels
Team:obs-ux-logs Observability Logs User Experience Team

Comments

@flash1293
Copy link
Contributor

flash1293 commented Jun 7, 2024

The log stream app and embeddable are planned to be removed in a future release (probably 9.0)

To reflect this, the following tasks need to be performed:

  • Add a banner to the top of the log stream app explaining the deprecation
    • Link to Logs explorer
    • Explain that we are working on a new experience for exploring logs which is recommended and it's not recommended anymore to use Logs stream
  • In the "Add panel" dropdown menu, mark "Log stream" as deprecated
  • Add a banner to the top of the documentation pages regarding logs stream under https://www.elastic.co/guide/en/observability/current/monitor-logs.html , explaining the same things
  • The "Logs" menu entry in the main sidenav should link to Logs Explorer instead of Logs Stream. There should be a "beta" label next to the menu entry to reflect the beta status of Logs Explorer.
@flash1293 flash1293 added the Team:obs-ux-logs Observability Logs User Experience Team label Jun 7, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-logs-team (Team:obs-ux-logs)

@flash1293 flash1293 changed the title [Log Stream] Deprecate log stream app and embeddable [Log Stream] Soft-deprecate log stream app and embeddable Jun 18, 2024
@tonyghiani tonyghiani self-assigned this Jun 20, 2024
@tonyghiani
Copy link
Contributor

@flash1293 I looked into this one and most of the changes should be quick wins. We should get a design and an informative callout sentence, I can advance a proposal while this is reviewed to speed up the work and put the tech changes under review.

@flash1293
Copy link
Contributor Author

Thanks for the look @tonyghiani I agree with the course of action.

@mdbirnstiehl is aware of the need for the text and will get back to us early next week.

About the design - let's start with a warning callout and @sileschristian can provide some input on it.

@sileschristian
Copy link

For the Stream a warning callout sounds good. I have to check what component we use in documentation for these cases. Copy to be decided.
image

@tonyghiani
Copy link
Contributor

@sileschristian I have the following in place, I ChatGPT-ed the copy for some proposals:

Screen.Recording.2024-06-20.at.10.22.01.mov

I'll update the CTA button to a solid color, moving the callout above the title might be more tricky as the page template is shared one, let me know if the position looks good anyway. I'll wait for the copies update.
Also, on the action panels, I did the following, but I'd appreciate your input:

Screenshot 2024-06-20 at 10 59 51

Add a banner to the top of the documentation pages regarding logs stream under https://www.elastic.co/guide/en/observability/current/monitor-logs.html , explaining the same things

@flash1293 regarding the doc update, should we set the banner on the tail logs page instead of the main exploration one?

@sileschristian
Copy link

moving the callout above the title might be more tricky as the page template is shared one

I see. Looks good then (also the badge on the dropdown). Just replace the button color and verify copies with @mdbirnstiehl

@flash1293
Copy link
Contributor Author

flash1293 commented Jun 20, 2024

regarding the doc update, should we set the banner on the tail logs page instead of the main exploration one?

Good point, @tonyghiani , as the "Tail Logs" page is purely about logs stream we should set a banner there and change the main "Explore logs" page to mention logs explorer as the recommended way. Not sure whether we should even mention logs stream anymore on this overview page, if we do, we should also remark that it's on it's way out (@mdbirnstiehl can also help here)

@tonyghiani
Copy link
Contributor

@flash1293 sounds good, let's sync next week with @mdbirnstiehl for the copies, the documentation change will go on a different PR as it's not on the Kibana codebase, so it should unblock the linked PR for this work.

@gbamparop
Copy link
Contributor

Should we consider providing the ability to users to close the callout, something similar to what we do in other places with local storage?

@flash1293
Copy link
Contributor Author

@gbamparop I think that would be a nice addition as long as it doesn't cause a lot of work (it should be easy to wire that up locally though).

For the text - I think we should try to keep it to a single line so it doesn't take up too much vertical screen space.

@tonyghiani
Copy link
Contributor

@flash1293 @gbamparop letting the user close it and save it locally is fairly easy.

However, this is not just an optional suggestion, in the long term the plan is to deprecate the Log Stream, and users should be explicitly told that we have a must-go better option now.

IMO, letting them close the callout and continue using the Log Stream makes the intent of the callout weaker.

@flash1293
Copy link
Contributor Author

However, this is not just an optional suggestion, in the long term the plan is to deprecate the Log Stream, and users should be explicitly told that we have a must-go better option now.

I think it's OK as we will make this very clear in 8.16 by defaulting to hiding the app.

@tonyghiani
Copy link
Contributor

I'll add the option to dismiss it and save the preference in the local storage 👍

@mdbirnstiehl
Copy link
Contributor

regarding the doc update, should we set the banner on the tail logs page instead of the main exploration one?

Good point, @tonyghiani , as the "Tail Logs" page is purely about logs stream we should set a banner there and change the main "Explore logs" page to mention logs explorer as the recommended way. Not sure whether we should even mention logs stream anymore on this overview page, if we do, we should also remark that it's on it's way out (@mdbirnstiehl can also help here)

@tonyghiani @flash1293 Do we have an issue open for this? I'm happy to help here.

@tonyghiani
Copy link
Contributor

Do we have an issue open for this? I'm happy to help here

It was part of this one but it got closed by the automated mention on the PR I just closed, sorry for that!
I'm reopening this and we can continue the discussion here.

@tonyghiani tonyghiani reopened this Jun 27, 2024
@gbamparop
Copy link
Contributor

@mdbirnstiehl we could also mark is as legacy in https://www.elastic.co/guide/en/kibana/current/dashboard.html and mention what the alternative should be.

@gbamparop
Copy link
Contributor

@tonyghiani can we close this?

@tonyghiani
Copy link
Contributor

can we close this?

I re-opened this for @mdbirnstiehl to have a tracking issue, otherwise we can close it 👌

@mdbirnstiehl
Copy link
Contributor

mdbirnstiehl commented Jul 11, 2024

can we close this?

I re-opened this for @mdbirnstiehl to have a tracking issue, otherwise we can close it 👌

@tonyghiani @gbamparop I can create an issue specific for updating the docs if we want to close this one.

@gbamparop
Copy link
Contributor

@tonyghiani @gbamparop I can create an issue specific for updating the docs if we want to close this one.

That'll be perfect thanks, just to have higher-level visibility from the project issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:obs-ux-logs Observability Logs User Experience Team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants