[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option #194519

tonyghiani · 2024-10-01T08:05:19Z

Release note

The logs stream app is hidden by default - users are advised to use the logs explorer app instead. The logs explorer can be found in the left hand observability menu under Logs > Explorer. When using Elastic Cloud and the observability navigation, Logs Explorer will be displayed as a separate tab under the "Discover" menu item. To re-enable the logs stream app, navigate to Stack management > Advanced settings and enable the observability:enableLogsStream setting.

📓 Summary

Closes #193319
Closes #193320

This work is part of the effort to progressively deprecate the existing Logs Stream feature.

Changes taken on this PR consist of:

Create a new uiSettings 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 has now a callout explaining the status of this embeddable (unmaintained/deprecated).
Rename logs ML to "Logs Anomalies" and "Logs Categories".

Other minor improvements regard:

Remove duplicate Xstate utils and use the relative package instead.
Remove the duplicated useBoolean hook used in the deprecation callout.
Sync deep links registration with available routes through a single getLogsRoutes util.

🎥 Recordings

Logs Stream app removed

remove_logs_stream_app.mov

Logs Stream dashboard panel entry removed

remove_logs_steram_panel.mov

Logs Stream app removed from project nav

remove_logs_stream_project.mov

Embeddable deprecation callout

Unavailable setting in serverless

serverless.mov

…erless

obltmachine · 2024-10-01T08:05:31Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

…onyghiani/kibana into 193320-advance-setting-to-show-logs-ui

tonyghiani · 2024-10-01T09:59:34Z

x-pack/plugins/observability_solution/infra/server/lib/ui_settings.ts

+      value: false,
+      description: i18n.translate('xpack.infra.enableLogsStreamDescription', {
+        defaultMessage:
+          'Enables the legacy Logs Stream application. When enabled, the dashboard panel for legacy logs streams is also available. ',


@mdbirnstiehl Could you double-check this ui setting description, please?

...ns/observability_solution/infra/public/components/log_stream/log_stream_react_embeddable.tsx

x-pack/plugins/observability_solution/infra/common/ui_settings.ts

Co-authored-by: Mike Birnstiehl <[email protected]>

…-fix'

tonyghiani · 2024-10-02T15:16:46Z

@flash1293 at the current stage, the Settings navigation link in the top nav will still show up in the Logs Category and Logs Anomalies pages as it was by default.
Those settings won't affect the behaviour on Logs Explorer, IMO it might be misleading for the user if they select some defaults columns there and those are not reflected on the data grid, which would be the expected behaviour for users who didn't use the Logs Stream earlier.

Alternatively we can show the settings page in the side nav directly.

This sounds like a more convenient option, as we can append this navigation entry after Logs Anomalies and Logs Categories when the Logs Stream is disabled.
Regarding the new side nav, we could also add the settings entry after those entries.

Are we good to proceed with this way? Let me know your thoughts

flash1293 · 2024-10-02T15:29:52Z

Those settings won't affect the behaviour on Logs Explorer, IMO it might be misleading for the user if they select some defaults columns there and those are not reflected on the data grid, which would be the expected behaviour for users who didn't use the Logs Stream earlier.

That's a good point, you are right

This sounds like a more convenient option, as we can append this navigation entry after Logs Anomalies and Logs Categories when the Logs Stream is disabled.
Regarding the new side nav, we could also add the settings entry after those entries.

Yeah, that sounds good to me - for the new side nav we should put it under "Other tools". And probably add some kind of deprecation banner on top of it. Sorry for just coming up with this now.

…banner

…onyghiani/kibana into 193320-advance-setting-to-show-logs-ui

tonyghiani · 2024-10-02T15:58:22Z

Yeah, that sounds good to me - for the new side nav we should put it under "Other tools". And probably add some kind of deprecation banner on top of it. Sorry for just coming up with this now.

No prob @flash1293 , it was a fairly simple change, I reused the deprecation banner we implemented for the Stream page with a slightly different phrasing to redirect the user to use Logs Explorer.

x-pack/plugins/observability_solution/infra/public/components/logs_deprecation_callout.tsx

…logs_deprecation_callout.tsx Co-authored-by: Mike Birnstiehl <[email protected]>

maryam-saeidi

Obs-ux-management LGTM (code review only)

afharo

Telemetry changes LGTM

kibana-ci · 2024-10-07T09:11:43Z

💚 Build Succeeded

Buildkite Build
Commit: 2d9d15b
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-194519-2d9d15ba2821

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`infra`	1504	1508	+4

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/management-settings-ids`	141	142	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`infra`	1.6MB	1.6MB	+57.0KB
`observability`	467.6KB	467.8KB	+134.0B
total			+57.1KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`infra`	52.5KB	52.7KB	+249.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/management-settings-ids`	143	144	+1

async chunk count

id	before	after	diff
`infra`	23	31	+8

History

💛 Build #239395 was flaky 6f73452
💚 Build #239357 succeeded e413fbb
💛 Build #239018 was flaky f87c4b2
💔 Build #238986 failed 0254c2c
💛 Build #238871 was flaky 987e59a

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

mohamedhamed-ahmed

LGTM!! Amazing work mate and thanks for refactoring some parts there 🚀

The only thing that was a bit confusing to me is that when the Logs Stream is disabled I saw the new Settings side nav entry with the new callout but nothing pointing me to how I can re-enable Stream if I want to.

Also as a user of Stream if I now suddenly see Page not found when I open stream links with no hints on what happened not sure about this but maybe if we have a hint on how it could be re-enabled or so.

tonyghiani · 2024-10-08T10:33:17Z

The only thing that was a bit confusing to me is that when the Logs Stream is disabled I saw the new Settings side nav entry with the new callout but nothing pointing me to how I can re-enable Stream if I want to.

This was the approach we agreed on the comments above to still give the user a quick touch-point on the settings since the log view is still used for other features such as anomalies and categories.
I don't think we really want to give the user a direct hint to re-enable the logs stream, as we instead suggest to use Logs Explorer when they go to the settings page.

Also as a user of Stream if I now suddenly see Page not found when I open stream links with no hints on what happened not sure about this but maybe if we have a hint on how it could be re-enabled or so.

This is a good point, we could add a redirect to Logs Explorer in case of a direct hit to the /stream URL, wdyt @flash1293 ?

tonyghiani · 2024-10-08T14:52:51Z

I added the redirect to Logs Explorer when directly accessing the Logs Stream route while disabled, that feels the most natural behaviour.

elasticmachine · 2024-10-08T15:50:24Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 1778b8e
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-194519-1778b8e8a871

Failed CI Steps

FTR Configs #72

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`infra`	1504	1508	+4

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/management-settings-ids`	141	142	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`infra`	1.6MB	1.6MB	+57.1KB
`observability`	467.6KB	467.8KB	+134.0B
total			+57.3KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`infra`	52.5KB	52.7KB	+249.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/management-settings-ids`	143	144	+1

async chunk count

id	before	after	diff
`infra`	23	31	+8

History

kibanamachine · 2024-10-09T08:14:23Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11250921067

kibanamachine · 2024-10-09T08:18:56Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 194519

Questions ?

Please refer to the Backport tool documentation

tonyghiani · 2024-10-09T08:26:24Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

elastic#194519) ## 📓 Summary Closes elastic#193319 Closes elastic#193320 This work is part of the effort to progressively deprecate the existing Logs Stream feature. Changes taken on this PR consist of: - Create a new uiSettings `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 has now a callout explaining the status of this embeddable (unmaintained/deprecated). - Rename logs ML to "Logs Anomalies" and "Logs Categories". Other minor improvements regard: - Remove duplicate Xstate utils and use the relative package instead. - Remove the duplicated `useBoolean` hook used in the deprecation callout. - Sync deep links registration with available routes through a single `getLogsRoutes` util. ## 🎥 Recordings ### Logs Stream app removed https://github.com/user-attachments/assets/f4173294-8789-4abd-9972-29c9b7c197ed ### Logs Stream dashboard panel entry removed https://github.com/user-attachments/assets/7f99ca2a-c030-4867-b976-8fdc1df09d29 ### Logs Stream app removed from project nav https://github.com/user-attachments/assets/de51bdd6-820a-4c03-8b64-fb1a6ced0a12 ### Embeddable deprecation callout <img width="949" alt="Screenshot 2024-10-02 at 10 22 09" src="https://github.com/user-attachments/assets/99fd5554-004b-45e4-81db-cb23947e210e"> ### Unavailable setting in serverless https://github.com/user-attachments/assets/91bf6c37-0845-4918-a485-b6250bbd96bf --------- Co-authored-by: Marco Antonio Ghiani <[email protected]> Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Mike Birnstiehl <[email protected]> (cherry picked from commit 9907601) # Conflicts: # src/plugins/telemetry/schema/oss_plugins.json

… option (#194519) (#195542) # Backport This will backport the following commits from `main` to `8.x`: - [[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option (#194519)](#194519)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

Marco Antonio Ghiani added 6 commits September 30, 2024 16:02

feeat(logs): add new logs stream enabled setting

1b79825

feat(logs): conditionally register logs stream panel

0a26bac

refactor(logs): use xstate utils package

8d6bf83

refactor(logs): use xstate utils package

89896be

feat(logs): conditionally load logs stream app

06e9f65

feat(logs): set default value when setting is not registered for serv…

c3ed920

…erless

kibanamachine and others added 4 commits October 1, 2024 08:18

[CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'

2e241e3

fix(translations): remove unused translations

b640655

fix(infra): udpate translations and remove unused hook

013cfea

Merge branch '193320-advance-setting-to-show-logs-ui' of github.com:t…

1b5bc92

…onyghiani/kibana into 193320-advance-setting-to-show-logs-ui

tonyghiani mentioned this pull request Oct 1, 2024

[Logs Explorer] Fix Privileges Accessibility #193894

Merged

Marco Antonio Ghiani and others added 2 commits October 1, 2024 11:39

feat(infra): add embeddable deprecation callout

709169d

Merge branch 'main' into 193320-advance-setting-to-show-logs-ui

8732dbe

tonyghiani commented Oct 1, 2024

View reviewed changes

Marco Antonio Ghiani and others added 3 commits October 1, 2024 13:13

test(infra): update tests for log stream

3113f7b

Merge branch 'main' into 193320-advance-setting-to-show-logs-ui

50ba6e8

fix(infra): update types

a107aaa

tonyghiani commented Oct 1, 2024

View reviewed changes

...ns/observability_solution/infra/public/components/log_stream/log_stream_react_embeddable.tsx Outdated Show resolved Hide resolved

fix(infra): update usage collector

02a6e81

mdbirnstiehl reviewed Oct 1, 2024

View reviewed changes

x-pack/plugins/observability_solution/infra/common/ui_settings.ts Outdated Show resolved Hide resolved

tonyghiani and others added 3 commits October 1, 2024 17:09

Update x-pack/plugins/observability_solution/infra/common/ui_settings.ts

1fedc03

Co-authored-by: Mike Birnstiehl <[email protected]>

refactor(infra): update deprecation callout warning

aa1159f

Merge branch 'main' into 193320-advance-setting-to-show-logs-ui

0bfb149

tonyghiani added release_note:deprecation backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Team:obs-ux-logs Observability Logs User Experience Team labels Oct 2, 2024

tonyghiani and others added 2 commits October 2, 2024 08:28

Merge branch 'main' into 193320-advance-setting-to-show-logs-ui

bc8ef2c

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

e97f35b

…-fix'

tonyghiani marked this pull request as ready for review October 2, 2024 09:20

Marco Antonio Ghiani added 2 commits October 2, 2024 17:56

feat(infra): add logs settings page navigation entry and deprecation …

4b02294

…banner

Merge branch '193320-advance-setting-to-show-logs-ui' of github.com:t…

987e59a

…onyghiani/kibana into 193320-advance-setting-to-show-logs-ui

mdbirnstiehl reviewed Oct 2, 2024

View reviewed changes

x-pack/plugins/observability_solution/infra/public/components/logs_deprecation_callout.tsx Outdated Show resolved Hide resolved

smith added the apm:review label Oct 3, 2024

tonyghiani and others added 2 commits October 3, 2024 08:34

Update x-pack/plugins/observability_solution/infra/public/components/…

0254c2c

…logs_deprecation_callout.tsx Co-authored-by: Mike Birnstiehl <[email protected]>

Merge branch 'main' into 193320-advance-setting-to-show-logs-ui

f87c4b2

maryam-saeidi approved these changes Oct 4, 2024

View reviewed changes

Merge branch 'main' into 193320-advance-setting-to-show-logs-ui

e413fbb

afharo approved these changes Oct 4, 2024

View reviewed changes

tonyghiani added 2 commits October 4, 2024 12:27

Merge branch 'main' into 193320-advance-setting-to-show-logs-ui

6f73452

Merge branch 'main' into 193320-advance-setting-to-show-logs-ui

2d9d15b

mohamedhamed-ahmed approved these changes Oct 8, 2024

View reviewed changes

refactor(infra): redirect to logs explorer once accessing /stream route

1778b8e

tonyghiani merged commit 9907601 into elastic:main Oct 9, 2024
24 checks passed

tonyghiani deleted the 193320-advance-setting-to-show-logs-ui branch October 9, 2024 08:14

kibanamachine added the v9.0.0 label Oct 9, 2024

tonyghiani mentioned this pull request Oct 9, 2024

[8.x] [LogsUI] Add UI setting to hide Logs Stream and dashboard panel option (#194519) #195542

Merged

kibanamachine added the v8.16.0 label Oct 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option #194519

[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option #194519

tonyghiani commented Oct 1, 2024 •

edited by flash1293

Loading

obltmachine commented Oct 1, 2024

tonyghiani Oct 1, 2024

tonyghiani commented Oct 2, 2024

flash1293 commented Oct 2, 2024 •

edited

Loading

tonyghiani commented Oct 2, 2024

maryam-saeidi left a comment

afharo left a comment

kibana-ci commented Oct 7, 2024 •

edited

Loading

API count

async chunk count

mohamedhamed-ahmed left a comment •

edited

Loading

tonyghiani commented Oct 8, 2024

tonyghiani commented Oct 8, 2024

elasticmachine commented Oct 8, 2024 •

edited

Loading

API count

async chunk count

kibanamachine commented Oct 9, 2024

kibanamachine commented Oct 9, 2024

tonyghiani commented Oct 9, 2024

[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option #194519

[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option #194519

Conversation

tonyghiani commented Oct 1, 2024 • edited by flash1293 Loading

Release note

📓 Summary

🎥 Recordings

Logs Stream app removed

Logs Stream dashboard panel entry removed

Logs Stream app removed from project nav

Embeddable deprecation callout

Unavailable setting in serverless

obltmachine commented Oct 1, 2024

🤖 GitHub comments

tonyghiani Oct 1, 2024

Choose a reason for hiding this comment

tonyghiani commented Oct 2, 2024

flash1293 commented Oct 2, 2024 • edited Loading

tonyghiani commented Oct 2, 2024

maryam-saeidi left a comment

Choose a reason for hiding this comment

afharo left a comment

Choose a reason for hiding this comment

kibana-ci commented Oct 7, 2024 • edited Loading

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

async chunk count

History

mohamedhamed-ahmed left a comment • edited Loading

Choose a reason for hiding this comment

tonyghiani commented Oct 8, 2024

tonyghiani commented Oct 8, 2024

elasticmachine commented Oct 8, 2024 • edited Loading

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

async chunk count

History

kibanamachine commented Oct 9, 2024

kibanamachine commented Oct 9, 2024

💔 All backports failed

Manual backport

Questions ?

tonyghiani commented Oct 9, 2024

💚 All backports created successfully

Questions ?

tonyghiani commented Oct 1, 2024 •

edited by flash1293

Loading

flash1293 commented Oct 2, 2024 •

edited

Loading

kibana-ci commented Oct 7, 2024 •

edited

Loading

mohamedhamed-ahmed left a comment •

edited

Loading

elasticmachine commented Oct 8, 2024 •

edited

Loading