[Logs] Add advanced setting to show Logs UI and log stream embeddable in “Add panel” on dashboards #193320
Assignees
Labels
Team:obs-ux-logs
Observability Logs User Experience Team
Comments
|
Pinging @elastic/obs-ux-logs-team (Team:obs-ux-logs) |
tonyghiani
added a commit
to tonyghiani/kibana
that referenced
this issue
Oct 9, 2024
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:/user-attachments/assets/f4173294-8789-4abd-9972-29c9b7c197ed ### Logs Stream dashboard panel entry removed https:/user-attachments/assets/7f99ca2a-c030-4867-b976-8fdc1df09d29 ### Logs Stream app removed from project nav https:/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:/user-attachments/assets/99fd5554-004b-45e4-81db-cb23947e210e"> ### Unavailable setting in serverless https:/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
tonyghiani
added a commit
that referenced
this issue
Oct 9, 2024
… 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) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https:/sqren/backport) <!--BACKPORT [{"author":{"name":"Marco Antonio Ghiani","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-09T08:14:06Z","message":"[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option (#194519)\n\n## 📓 Summary\r\n\r\nCloses #193319 \r\nCloses #193320 \r\n\r\nThis work is part of the effort to progressively deprecate the existing\r\nLogs Stream feature.\r\n\r\nChanges taken on this PR consist of:\r\n- Create a new uiSettings `observability:enableLogsStream` which\r\ndefaults to `false` on the stateful/cloud deployments and is not\r\navailable in serverless ones (still, defaults to `false` behind the\r\nscene).\r\n- When `observability:enableLogsStream` is `false`, the Logs Stream page\r\nroute is not registered, and neither is its deep link for global search.\r\n- When `observability:enableLogsStream` is `false`, the panels list on\r\nDashboard won't show anymore the option `Logs Stream (Deprecated)` to\r\nprevent usage of this embeddable in new dashboards. The embeddable is\r\nstill registered for retro-compatibility with active dashboards, and it\r\nhas now a callout explaining the status of this embeddable\r\n(unmaintained/deprecated).\r\n- Rename logs ML to \"Logs Anomalies\" and \"Logs Categories\".\r\n\r\nOther minor improvements regard:\r\n- Remove duplicate Xstate utils and use the relative package instead.\r\n- Remove the duplicated `useBoolean` hook used in the deprecation\r\ncallout.\r\n- Sync deep links registration with available routes through a single\r\n`getLogsRoutes` util.\r\n\r\n## 🎥 Recordings\r\n\r\n### Logs Stream app removed\r\n\r\n\r\nhttps:/user-attachments/assets/f4173294-8789-4abd-9972-29c9b7c197ed\r\n\r\n### Logs Stream dashboard panel entry removed\r\n\r\n\r\nhttps:/user-attachments/assets/7f99ca2a-c030-4867-b976-8fdc1df09d29\r\n\r\n### Logs Stream app removed from project nav\r\n\r\n\r\nhttps:/user-attachments/assets/de51bdd6-820a-4c03-8b64-fb1a6ced0a12\r\n\r\n### Embeddable deprecation callout\r\n\r\n<img width=\"949\" alt=\"Screenshot 2024-10-02 at 10 22 09\"\r\nsrc=\"https:/user-attachments/assets/99fd5554-004b-45e4-81db-cb23947e210e\">\r\n\r\n### Unavailable setting in serverless\r\n\r\n\r\nhttps:/user-attachments/assets/91bf6c37-0845-4918-a485-b6250bbd96bf\r\n\r\n---------\r\n\r\nCo-authored-by: Marco Antonio Ghiani <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Mike Birnstiehl <[email protected]>","sha":"9907601dd148ba59420bffda45ff584686f47b43","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:deprecation","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-logs","Team:obs-ux-management","apm:review"],"number":194519,"url":"https:/elastic/kibana/pull/194519","mergeCommit":{"message":"[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option (#194519)\n\n## 📓 Summary\r\n\r\nCloses #193319 \r\nCloses #193320 \r\n\r\nThis work is part of the effort to progressively deprecate the existing\r\nLogs Stream feature.\r\n\r\nChanges taken on this PR consist of:\r\n- Create a new uiSettings `observability:enableLogsStream` which\r\ndefaults to `false` on the stateful/cloud deployments and is not\r\navailable in serverless ones (still, defaults to `false` behind the\r\nscene).\r\n- When `observability:enableLogsStream` is `false`, the Logs Stream page\r\nroute is not registered, and neither is its deep link for global search.\r\n- When `observability:enableLogsStream` is `false`, the panels list on\r\nDashboard won't show anymore the option `Logs Stream (Deprecated)` to\r\nprevent usage of this embeddable in new dashboards. The embeddable is\r\nstill registered for retro-compatibility with active dashboards, and it\r\nhas now a callout explaining the status of this embeddable\r\n(unmaintained/deprecated).\r\n- Rename logs ML to \"Logs Anomalies\" and \"Logs Categories\".\r\n\r\nOther minor improvements regard:\r\n- Remove duplicate Xstate utils and use the relative package instead.\r\n- Remove the duplicated `useBoolean` hook used in the deprecation\r\ncallout.\r\n- Sync deep links registration with available routes through a single\r\n`getLogsRoutes` util.\r\n\r\n## 🎥 Recordings\r\n\r\n### Logs Stream app removed\r\n\r\n\r\nhttps:/user-attachments/assets/f4173294-8789-4abd-9972-29c9b7c197ed\r\n\r\n### Logs Stream dashboard panel entry removed\r\n\r\n\r\nhttps:/user-attachments/assets/7f99ca2a-c030-4867-b976-8fdc1df09d29\r\n\r\n### Logs Stream app removed from project nav\r\n\r\n\r\nhttps:/user-attachments/assets/de51bdd6-820a-4c03-8b64-fb1a6ced0a12\r\n\r\n### Embeddable deprecation callout\r\n\r\n<img width=\"949\" alt=\"Screenshot 2024-10-02 at 10 22 09\"\r\nsrc=\"https:/user-attachments/assets/99fd5554-004b-45e4-81db-cb23947e210e\">\r\n\r\n### Unavailable setting in serverless\r\n\r\n\r\nhttps:/user-attachments/assets/91bf6c37-0845-4918-a485-b6250bbd96bf\r\n\r\n---------\r\n\r\nCo-authored-by: Marco Antonio Ghiani <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Mike Birnstiehl <[email protected]>","sha":"9907601dd148ba59420bffda45ff584686f47b43"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https:/elastic/kibana/pull/194519","number":194519,"mergeCommit":{"message":"[LogsUI] Add UI setting to hide Logs Stream and dashboard panel option (#194519)\n\n## 📓 Summary\r\n\r\nCloses #193319 \r\nCloses #193320 \r\n\r\nThis work is part of the effort to progressively deprecate the existing\r\nLogs Stream feature.\r\n\r\nChanges taken on this PR consist of:\r\n- Create a new uiSettings `observability:enableLogsStream` which\r\ndefaults to `false` on the stateful/cloud deployments and is not\r\navailable in serverless ones (still, defaults to `false` behind the\r\nscene).\r\n- When `observability:enableLogsStream` is `false`, the Logs Stream page\r\nroute is not registered, and neither is its deep link for global search.\r\n- When `observability:enableLogsStream` is `false`, the panels list on\r\nDashboard won't show anymore the option `Logs Stream (Deprecated)` to\r\nprevent usage of this embeddable in new dashboards. The embeddable is\r\nstill registered for retro-compatibility with active dashboards, and it\r\nhas now a callout explaining the status of this embeddable\r\n(unmaintained/deprecated).\r\n- Rename logs ML to \"Logs Anomalies\" and \"Logs Categories\".\r\n\r\nOther minor improvements regard:\r\n- Remove duplicate Xstate utils and use the relative package instead.\r\n- Remove the duplicated `useBoolean` hook used in the deprecation\r\ncallout.\r\n- Sync deep links registration with available routes through a single\r\n`getLogsRoutes` util.\r\n\r\n## 🎥 Recordings\r\n\r\n### Logs Stream app removed\r\n\r\n\r\nhttps:/user-attachments/assets/f4173294-8789-4abd-9972-29c9b7c197ed\r\n\r\n### Logs Stream dashboard panel entry removed\r\n\r\n\r\nhttps:/user-attachments/assets/7f99ca2a-c030-4867-b976-8fdc1df09d29\r\n\r\n### Logs Stream app removed from project nav\r\n\r\n\r\nhttps:/user-attachments/assets/de51bdd6-820a-4c03-8b64-fb1a6ced0a12\r\n\r\n### Embeddable deprecation callout\r\n\r\n<img width=\"949\" alt=\"Screenshot 2024-10-02 at 10 22 09\"\r\nsrc=\"https:/user-attachments/assets/99fd5554-004b-45e4-81db-cb23947e210e\">\r\n\r\n### Unavailable setting in serverless\r\n\r\n\r\nhttps:/user-attachments/assets/91bf6c37-0845-4918-a485-b6250bbd96bf\r\n\r\n---------\r\n\r\nCo-authored-by: Marco Antonio Ghiani <[email protected]>\r\nCo-authored-by: kibanamachine <[email protected]>\r\nCo-authored-by: Mike Birnstiehl <[email protected]>","sha":"9907601dd148ba59420bffda45ff584686f47b43"}}]}] BACKPORT-->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary
Part of the Logs UI deprecation.
An advanced setting should be added that enables the Logs UI and the embeddable in "add panel" on dashboards.
Acceptance criteria
An advanced setting is added.
false(off / hidden) by default.In serverless it is always hidden (we won't register this setting in serverless).
When the setting is enabled (set to
true) the Logs UI is enabled and it's available as a panel in dashboards.The text was updated successfully, but these errors were encountered: