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 Explorer] Convert log explorer profile into standalone app #164493

Merged
merged 57 commits into from Aug 31, 2023

Conversation

weltenwort
Copy link
Member

@weltenwort weltenwort commented Aug 22, 2023

πŸ“ Summary

This converts the log explorer profile into a stand-alone log explorer component and an observability log explorer app, that uses it.

closes #164197

Release note

The Observability Log Explorer App is made available as a preview in the Observability solution navigation. It offers the usability of Discover, but is optimized for viewing log entries from log data streams.

πŸ› οΈ Implementation notes

  • This renames the discover_log_explorer plugin into log_explorer.
  • Instead of registering a discover profile, log_explorer now exports a component that renders the DiscoverContainer with the previously implemented customizations. This is where integration-level customization will go in the future. For observability-specific customizations this component will have to become a lot more configurable.
  • The new plugin observability_log_explorer registers a log explorer application, which renders the aforementioned log explorer component. This is where observability-specific customizations will go in the future.
  • The functional tests for both stateful and serverless were renamed and adapted accordingly.
  • The functional tests use discover page objects in many places, which is sensible because components are identical. The test utilities for this identical UX should probably be factored out into smaller, specialized page objects as the componentization of Discover progresses.
  • The name that the app is labelled with in the UI is still being discussed.
  • The search session feature is left in an uninitialized state because this injects a proxy of the search session service, which ignores the enablement call.

🎨 Previews

Stateful /app/observability-log-explorer

image

Stateless /app/observability-log-explorer

image

@weltenwort weltenwort added Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services labels Aug 22, 2023
@weltenwort weltenwort self-assigned this Aug 22, 2023
@apmmachine
Copy link
Contributor

πŸ€– GitHub comments

Expand to view the GitHub comments

Just comment with:

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

@kibana-ci

This comment was marked as outdated.

@weltenwort weltenwort requested review from a team as code owners August 29, 2023 17:47
@elasticmachine
Copy link
Contributor

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

Copy link
Contributor

@jeramysoucy jeramysoucy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes in test/plugin_functional/test_suites/core_plugins/rendering.ts LGTM. Just one minor nit/ask.

* xpack.discoverLogExplorer.featureFlags is conditional and will never resolve if used in non-serverless environment
*/
'xpack.discoverLogExplorer.featureFlags.deepLinkVisible (any)',
'xpack.observabilityLogExplorer.navigation.showAppLink (any)',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weltenwort Could you add a short comment to explain the any type? I know we don't have them for all of the any-typed items here, but we're trying to be better about this.

Copy link
Member

@jbudz jbudz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

limits.yml, storybook aliases lgtm

Copy link
Contributor

@tonyghiani tonyghiani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The latest changes LGTM and the features still work correctly, thanks for this work πŸ‘

Copy link
Member

@pheyos pheyos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

x-pack/test_serverless/functional/config.base.ts changes LGTM

@weltenwort weltenwort added the release_note:feature Makes this part of the condensed release notes label Aug 30, 2023
@kibana-ci
Copy link
Collaborator

πŸ’š Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
discoverLogExplorer 317 - -317
logExplorer - 319 +319
observabilityLogExplorer - 32 +32
total +34

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
logExplorer - 3 +3

Async chunks

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

id before after diff
discoverLogExplorer 221.1KB - -221.1KB
logExplorer - 220.7KB ⚠️ +220.7KB
total -354.0B

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id before after diff
logExplorer - 1 +1

Page load bundle

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

id before after diff
discoverLogExplorer 5.9KB - -5.9KB
infra 105.8KB 105.9KB +78.0B
logExplorer - 5.5KB +5.5KB
observabilityLogExplorer - 8.7KB +8.7KB
serverlessObservability 44.1KB 44.2KB +12.0B
total +8.3KB
Unknown metric groups

API count

id before after diff
logExplorer - 3 +3

async chunk count

id before after diff
discoverLogExplorer 8 - -8
logExplorer - 8 +8
total -0

ESLint disabled in files

id before after diff
discoverLogExplorer 2 - -2
logExplorer - 2 +2
total -0

ESLint disabled line counts

id before after diff
discoverLogExplorer 4 - -4
logExplorer - 6 +6
observabilityLogExplorer - 2 +2
total +4

Total ESLint disabled count

id before after diff
discoverLogExplorer 6 - -6
logExplorer - 8 +8
observabilityLogExplorer - 2 +2
total +4

History

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

cc @weltenwort

@weltenwort weltenwort merged commit ad59308 into elastic:main Aug 31, 2023
25 checks passed
@weltenwort weltenwort deleted the log-explorer-app branch August 31, 2023 12:18
@kibanamachine kibanamachine added v8.11.0 backport:skip This commit does not require backporting labels Aug 31, 2023
bryce-b pushed a commit to bryce-b/kibana that referenced this pull request Sep 19, 2023
…tic#164493)

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani01@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Logs UI Logs UI feature release_note:feature Makes this part of the condensed release notes Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v8.11.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Log Explorer] Convert the log explorer profile into a standalone app