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] Updated docs for Logs UI deprecation #4315

Closed
mdbirnstiehl opened this issue Sep 30, 2024 · 4 comments · Fixed by #4362
Closed

[Logs] Updated docs for Logs UI deprecation #4315

mdbirnstiehl opened this issue Sep 30, 2024 · 4 comments · Fixed by #4362
Assignees

Comments

@mdbirnstiehl
Copy link
Contributor

mdbirnstiehl commented Sep 30, 2024

The log stream component will be hidden by default and there's going to be a Kibana advanced setting to enable it. Our docs need to be updated to explain this.

Kibana guide also needs to be updated

Project link

@mdbirnstiehl mdbirnstiehl self-assigned this Sep 30, 2024
@mdbirnstiehl mdbirnstiehl changed the title Deprecate Logs UI [Logs] Updated docs for Logs UI deprecation Sep 30, 2024
@mdbirnstiehl
Copy link
Contributor Author

@tonyghiani currently the docs show the same message as the UI:

Image

I think we should change the title of this page to make it more obvious that it's about the Logs Stream app, and update the note that Stream will be deactivated by default and that users will have to turn it on, and give those steps.

I assume we want to be pretty assertive that this is not the preferred method and users should be switching to Logs Explorer. I will also move this down in the navigation hierarchy so it's not so prominent.

Other than that, I'll update the Kibana guide to focus more on Logs Explorer and get rid of Stream references. I think I've already removed most references to Logs Stream elsewhere, but I'll make sure.

Anything else I'm missing?

@tonyghiani
Copy link

@mdbirnstiehl everything you listed sounds good! Let me know if you need guidance on the steps to take to re-enable it and what the newly introduced setting hides in Kibana (only Logs Stream app and Logs Stream Dashboard panel), I agree we should put emphasis on this not being a recommended option 👌

@mdbirnstiehl
Copy link
Contributor Author

@tonyghiani It would be great if you could provide the steps for re-enabling Logs stream, thanks!

@tonyghiani
Copy link

@mdbirnstiehl Sure, here is a resume of the situation once the user upgrades to the new version.

  • There is a new Advanced Setting named Logs Stream (observability:enableLogsStream) which defaults to false on the stateful/cloud deployments and is not available in serverless ones (still, defaults to false behind the scene).
    • When observability:enableLogsStream is false, the Logs Stream page route is not registered, and neither is its deep link for global search.
    • When observability:enableLogsStream is false, the panels list on Dashboard won't show anymore the option Logs Stream (Deprecated) to prevent usage of this embeddable in new dashboards. The embeddable is still registered for retro-compatibility with active dashboards, and it now has a callout explaining the status of this embeddable (unmaintained/deprecated).

To re-enable the above features disabled by the new setting, the user should:

  • Visit Management -> Advanced Settings -> Search for Logs Stream
  • Enable the setting, save the changes and reload the page.
  • Visit the Observability -> Logs and che the Stream entry is again available in the sidebar
  • Search in global search should display the stream as a result
  • The legacy dashboard panel Logs Stream (deprecated) should be displayed again.

This setting is not available in serverless and the default behaviour is the same, where Logs Stream has not been available since the beginning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants