[Logs UI] Redirect Logs UI to Discover when in serverless mode #154145

tonyghiani · 2023-03-31T11:20:37Z

📓 Summary

The implementation creates a new LogsApp service where we should keep any logic concerned with what target_app parameter is configured and the actions related to a specific configuration. I thought it could be a good approach to avoid drilling down the global config till we need it and keep it cleaner by injecting only the service with predefined actions.

In this first case, we create a redirect to discover using its locator, and the exposed method can be used anywhere across the app for triggering the redirect.

🧪 Testing

Normal behaviour

When Kibana is used as always, we want to keep the current behaviour and the user will stay on the Logs UI pages.

Launch the Kibana dev environment with yarn start
Navigate to Logs UI
Verify the navigation works normally and that no redirect to Discover occurs

Serverless behaviour

When Kibana is used in serverless mode, we want to redirect any user landing to Logs UI to the Discover page, configuring the same data view or creating an ad-hoc one starting from the index pattern

Launch the Kibana dev environment with yarn serverless-oblt
Navigate to Logs UI
Verify to be redirected to Discover and a temporary data view is created from the current index pattern

github-actions · 2023-03-31T11:20:51Z

Documentation preview:

✨ Changed pages

apmmachine · 2023-03-31T11:20:54Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

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

…fix'

…-fix'

…ub.com:tonyghiani/kibana into 153890-redirect-logs-ui-to-discover-serverless

elasticmachine · 2023-04-12T10:40:43Z

Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI)

jeramysoucy

@tonyghiani I noticed when running in serverless mode the nav link to logs in the main navigation sidebar is gone. If I navigate to Observability and then to any of the 3 Logs nav links (Stream, Anomalies, Categories), I am redirected to Discover as expected. However, using the browser back button will not take me back to Observability. Is this the intended behavior?

weltenwort · 2023-04-13T17:25:27Z

@jeramysoucy yes, we're intentionally hiding the Logs UI from the serverless deployment. The plan is to use a Discover variant that has been enhanced for log consumption instead. The observability navigation will also not exist as it does right now. How and where that new Discover-base log explorer will be represented in the solution navigation is still undecided, because we're still waiting for the basic implementation of that navigation.

weltenwort · 2023-04-13T17:55:00Z

@jeramysoucy I only just realized what you were asking specifically. Sorry for not reading carefully enough. 🙈 You're right that the redirect creates a new browser history entry instead of replacing the current one. Thanks for pointing that out! ❤️

@tonyghiani the locator's navigate() call supports a second argument in which we can specify that it replaces the history entry. That would make sense to me. Would you agree?

tonyghiani · 2023-04-13T18:50:39Z

@tonyghiani the locator's navigate() call supports a second argument in which we can specify that it replaces the history entry. That would make sense to me. Would you agree?

Totally, I'll update that part too!

weltenwort

This looks really good, just one more question arose while testing:

weltenwort · 2023-04-18T20:13:36Z

x-pack/plugins/infra/public/apps/discover_app.tsx

+  const { discover } = plugins;
+  const { logViews } = pluginStart;
+
+  const machine = createLogViewStateMachine({


Do we need to use the log view reference from the url instead of a hard-coded default here? Or am I missing some other mechanism using which it is initialized correctly?

I didn't think of it and you are right, it was always using the default log view, even with a different one specified in the URL. I created the initializeFromUrl function and passed it to the state machine, now it does correctly recover the URL param if exists.

jeramysoucy

Looks good from AppEx Security perspective, and nav history works as expected now. 👍

weltenwort

Well done, looks like great quality to me 👍 thanks for investing the effort!

kibana-ci · 2023-04-19T15:30:46Z

💚 Build Succeeded

Buildkite Build
Commit: 36e7b92

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`infra`	1339	1340	+1

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
`infra`	40	41	+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`	2.0MB	2.0MB	+1.5KB

Page load bundle

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

id	before	after	diff
`infra`	90.1KB	90.5KB	+407.0B

Unknown metric groups

API count

id	before	after	diff
`infra`	43	44	+1

async chunk count

id	before	after	diff
`infra`	28	29	+1

ESLint disabled line counts

id	before	after	diff
`securitySolution`	394	397	+3

Total ESLint disabled count

id	before	after	diff
`securitySolution`	474	477	+3

History

💚 Build #120983 succeeded 31a3018
💚 Build #120147 succeeded 0835ce5
💚 Build #119855 succeeded f2c2d84
💚 Build #119798 succeeded fef8be3
💔 Build #119786 failed 5f2d288
💚 Build #119747 succeeded 5d41247

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

Closes #185711 ## Summary This change fixes #185711, but while working on that I also realised that we should move away from using hardcoded urls. So this PR does two things: - Displays the button only when the user has `authz.fleet.readAgents` privilege - Refactors the button functionality to use the new locators that take care of linking to the observability logs/discover app ### Why the refactor While testing this button, I noticed that the functionality was broken in some cases, that's because we were manually routing the urls to Logs UI/Discover apps based if we are in serverless or not. I found a PR that already implements this functionality: #155156 I also found #154145 that takes care of the redirect to the correct app. So I'm replacing the current manual functionality with these utilities so that `getLogsLocatorsFromUrlService` takes care of where the open in logs button should link. ### ESS https://github.com/elastic/kibana/assets/16084106/3f0760c9-3afb-4793-a3af-317f625b36d7 https://github.com/elastic/kibana/assets/16084106/3436cf5a-36c9-425d-a114-e116ddaa1a03 ### Serverless https://github.com/elastic/kibana/assets/16084106/84176f09-96a4-4932-9508-5f7682d03aae --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

…ic#187871) Closes elastic#185711 ## Summary This change fixes elastic#185711, but while working on that I also realised that we should move away from using hardcoded urls. So this PR does two things: - Displays the button only when the user has `authz.fleet.readAgents` privilege - Refactors the button functionality to use the new locators that take care of linking to the observability logs/discover app ### Why the refactor While testing this button, I noticed that the functionality was broken in some cases, that's because we were manually routing the urls to Logs UI/Discover apps based if we are in serverless or not. I found a PR that already implements this functionality: elastic#155156 I also found elastic#154145 that takes care of the redirect to the correct app. So I'm replacing the current manual functionality with these utilities so that `getLogsLocatorsFromUrlService` takes care of where the open in logs button should link. ### ESS https://github.com/elastic/kibana/assets/16084106/3f0760c9-3afb-4793-a3af-317f625b36d7 https://github.com/elastic/kibana/assets/16084106/3436cf5a-36c9-425d-a114-e116ddaa1a03 ### Serverless https://github.com/elastic/kibana/assets/16084106/84176f09-96a4-4932-9508-5f7682d03aae --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]> (cherry picked from commit 696bb88)

…#187871) (#188000) # Backport This will backport the following commits from `main` to `8.15`: - [[Fleet] Display view in logs button when logs app is available (#187871)](#187871)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Cristina Amico <[email protected]>

Marco Antonio Ghiani added 2 commits March 31, 2023 13:06

feat(infra): add logs.app_target config

39ba6a6

refactor(infra): stricter parameter validation

f61e185

Marco Antonio Ghiani and others added 8 commits March 31, 2023 13:47

refactor(infra): update tests

0e19e58

refactor(infra): update functional tests

1596b6b

chore(infra): include discover plugin to access locator

b4b21e3

feat(infra): add logs app service

e5e0a70

feat(infra): consume logs app service

e7d61b8

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

539c7d9

…fix'

Merge branch 'main' into 153890-redirect-logs-ui-to-discover-serverless

e4995f7

feat(infra): minor change

b2346f6

tonyghiani added Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services release_note:skip Skip the PR/issue when compiling release notes labels Apr 4, 2023

Marco Antonio Ghiani and others added 10 commits April 12, 2023 10:36

refactor(infra): lift navigation higher in the tree

f91d543

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

643f798

…-fix'

refactor(infra): create discover app

7dcef58

Merge branch '153890-redirect-logs-ui-to-discover-serverless' of gith…

8a0b2c3

…ub.com:tonyghiani/kibana into 153890-redirect-logs-ui-to-discover-serverless

refactor(infra): fix merge conflict

4c08f60

Merge branch 'main' into 153890-redirect-logs-ui-to-discover-serverless

e280f64

refactor(infra): stricter app mount

313c330

refactor(infra): stop machine service on unmount

712783a

refactor(infra): remove unused type

6d4d032

refactor(infra): minor change

694b6be

tonyghiani marked this pull request as ready for review April 12, 2023 10:40

tonyghiani requested review from a team as code owners April 12, 2023 10:40

Merge branch 'main' into 153890-redirect-logs-ui-to-discover-serverless

0e5b194

weltenwort self-requested a review April 13, 2023 10:33

Marco Antonio Ghiani and others added 2 commits April 13, 2023 17:51

refactor(infra): change requests

7748e7e

Merge branch 'main' into 153890-redirect-logs-ui-to-discover-serverless

f2c2d84

jeramysoucy reviewed Apr 13, 2023

View reviewed changes

Marco Antonio Ghiani and others added 3 commits April 17, 2023 09:32

refactor(infra): replace url on logs redirect

9ff6c2d

refactor(infra): apply name to ad-hoc data view

f2db6f2

Merge branch 'main' into 153890-redirect-logs-ui-to-discover-serverless

0835ce5

weltenwort reviewed Apr 18, 2023

View reviewed changes

Marco Antonio Ghiani and others added 3 commits April 19, 2023 10:04

refactor(infra): restore log view from url

04e9316

fix(fleet): mismatching config name

8ae8fb5

Merge branch 'main' into 153890-redirect-logs-ui-to-discover-serverless

31a3018

jeramysoucy approved these changes Apr 19, 2023

View reviewed changes

weltenwort approved these changes Apr 19, 2023

View reviewed changes

Merge branch 'main' into 153890-redirect-logs-ui-to-discover-serverless

36e7b92

tonyghiani enabled auto-merge (squash) April 19, 2023 14:28

tonyghiani merged commit b40b89e into elastic:main Apr 19, 2023

kibanamachine added v8.8.0 backport:skip This commit does not require backporting labels Apr 19, 2023

tonyghiani deleted the 153890-redirect-logs-ui-to-discover-serverless branch April 19, 2023 15:34

weltenwort mentioned this pull request May 8, 2023

Limit the target_app setting to serverless deployments #157042

Closed

weltenwort mentioned this pull request Aug 30, 2023

[Logs UI] Remove configurable redirects to Discover #165227

Closed

criamico mentioned this pull request Jul 9, 2024

[Fleet] Display view in logs button when logs app is available #187871

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Logs UI] Redirect Logs UI to Discover when in serverless mode #154145

[Logs UI] Redirect Logs UI to Discover when in serverless mode #154145

tonyghiani commented Mar 31, 2023 •

edited

Loading

github-actions bot commented Mar 31, 2023

apmmachine commented Mar 31, 2023

elasticmachine commented Apr 12, 2023

jeramysoucy left a comment •

edited

Loading

weltenwort commented Apr 13, 2023 •

edited

Loading

weltenwort commented Apr 13, 2023

tonyghiani commented Apr 13, 2023

weltenwort left a comment

weltenwort Apr 18, 2023

tonyghiani Apr 19, 2023

jeramysoucy left a comment

weltenwort left a comment

kibana-ci commented Apr 19, 2023

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

[Logs UI] Redirect Logs UI to Discover when in serverless mode #154145

[Logs UI] Redirect Logs UI to Discover when in serverless mode #154145

Conversation

tonyghiani commented Mar 31, 2023 • edited Loading

📓 Summary

🧪 Testing

Normal behaviour

Serverless behaviour

github-actions bot commented Mar 31, 2023

apmmachine commented Mar 31, 2023

🤖 GitHub comments

elasticmachine commented Apr 12, 2023

jeramysoucy left a comment • edited Loading

Choose a reason for hiding this comment

weltenwort commented Apr 13, 2023 • edited Loading

weltenwort commented Apr 13, 2023

tonyghiani commented Apr 13, 2023

weltenwort left a comment

Choose a reason for hiding this comment

weltenwort Apr 18, 2023

Choose a reason for hiding this comment

tonyghiani Apr 19, 2023

Choose a reason for hiding this comment

jeramysoucy left a comment

Choose a reason for hiding this comment

weltenwort left a comment

Choose a reason for hiding this comment

kibana-ci commented Apr 19, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

async chunk count

ESLint disabled line counts

Total ESLint disabled count

History

tonyghiani commented Mar 31, 2023 •

edited

Loading

jeramysoucy left a comment •

edited

Loading

weltenwort commented Apr 13, 2023 •

edited

Loading