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

[Discover] Support overriding root profile in Discover session embeddable #203121

Closed
davismcphee opened this issue Dec 5, 2024 · 4 comments · Fixed by #205986
Closed

[Discover] Support overriding root profile in Discover session embeddable #203121

davismcphee opened this issue Dec 5, 2024 · 4 comments · Fixed by #205986
Assignees
Labels
enhancement New value added to drive a business result Feature:Discover Discover Application impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort Project:OneDiscover Enrich Discover with contextual awareness Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. Team:obs-ux-logs Observability Logs User Experience Team

Comments

@davismcphee
Copy link
Contributor

davismcphee commented Dec 5, 2024

📓 Summary

The Discover session embeddable is being used as the foundation for the Observability team's new embedded logs component (e.g. in Observability Services pages, see #199787). It depends on the O11y logs data source profile to display the correct content in the table (Summary column, log level indicators, log overview tab, etc.). This worked well until #199255 was merged where the contextual awareness was removed from the classic Kibana nav, leaving the embedded logs component in a state where it's missing logs features outside of O11y project types (e.g. classic nav).

To address this in the near term we need to introduce a root profile override that can be passed to the Discover session embeddable to force a specific root profile, allowing the embedded logs component to render in the O11y root context with the expected logs features.

✔ Acceptance criteria

  • The Discover session embeddable should be extended with something like a rootProfileOverride prop to allow overriding the active root profile.
  • The O11y embedded logs component should use this prop to force the embeddable to display in the O11y root context as expected.
@davismcphee davismcphee added enhancement New value added to drive a business result Feature:Discover Discover Application impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. Team:obs-ux-logs Observability Logs User Experience Team labels Dec 5, 2024
@davismcphee davismcphee self-assigned this Dec 5, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-logs-team (Team:obs-ux-logs)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

@davismcphee davismcphee added the Project:OneDiscover Enrich Discover with contextual awareness label Dec 5, 2024
@ninoslavmiskovic
Copy link
Contributor

@davismcphee We should start calling this Discover Session Embeddable 😄

@davismcphee davismcphee changed the title [Discover] Support overriding root profile in saved search embeddable [Discover] Support overriding root profile in Discover session embeddable Dec 6, 2024
@davismcphee
Copy link
Contributor Author

@ninoslavmiskovic good point since soon it will be! Updated the issue to use "Discover session" instead.

kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Jan 13, 2025
…esolution in embeddable (elastic#205986)

## Summary

This PR adds support for overriding the `solutionNavId` used for root
profile resolution within the Discover embeddable, allowing consumers to
force specific root profiles. Additionally the current usages of
`LazySavedSearchComponent` within Observability apps have been updated
to pass `solutionNavIdOverride: 'oblt'` to ensure their embedded logs
components render in logs mode as expected.

Resolves elastic#203121.

### Checklist

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [x] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

(cherry picked from commit 13d4813)
kibanamachine added a commit that referenced this issue Jan 14, 2025
…r root profile resolution in embeddable (#205986) (#206525)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Discover] Support overriding `solutionNavId` used for root
profile resolution in embeddable
(#205986)](#205986)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Davis
McPhee","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-01-13T22:58:37Z","message":"[Discover]
Support overriding `solutionNavId` used for root profile resolution in
embeddable (#205986)\n\n## Summary\r\n\r\nThis PR adds support for
overriding the `solutionNavId` used for root\r\nprofile resolution
within the Discover embeddable, allowing consumers to\r\nforce specific
root profiles. Additionally the current usages
of\r\n`LazySavedSearchComponent` within Observability apps have been
updated\r\nto pass `solutionNavIdOverride: 'oblt'` to ensure their
embedded logs\r\ncomponents render in logs mode as
expected.\r\n\r\nResolves #203121.\r\n\r\n### Checklist\r\n\r\n- [ ] Any
text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] If a plugin
configuration key changed, check if it needs to be\r\nallowlisted in the
cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This was checked for breaking HTTP API changes, and any
breaking\r\nchanges have been approved by the breaking-change committee.
The\r\n`release_note:breaking` label should be applied in these
situations.\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [x] The PR description includes
the appropriate Release Notes section,\r\nand the correct
`release_note:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13d4813151ff0c7cb549cf0d22565a1f9d46fb68","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:DataDiscovery","backport:prev-minor","Team:obs-ux-logs","Team:obs-ux-infra_services","Project:OneDiscover"],"title":"[Discover]
Support overriding `solutionNavId` used for root profile resolution in
embeddable","number":205986,"url":"https://github.com/elastic/kibana/pull/205986","mergeCommit":{"message":"[Discover]
Support overriding `solutionNavId` used for root profile resolution in
embeddable (#205986)\n\n## Summary\r\n\r\nThis PR adds support for
overriding the `solutionNavId` used for root\r\nprofile resolution
within the Discover embeddable, allowing consumers to\r\nforce specific
root profiles. Additionally the current usages
of\r\n`LazySavedSearchComponent` within Observability apps have been
updated\r\nto pass `solutionNavIdOverride: 'oblt'` to ensure their
embedded logs\r\ncomponents render in logs mode as
expected.\r\n\r\nResolves #203121.\r\n\r\n### Checklist\r\n\r\n- [ ] Any
text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] If a plugin
configuration key changed, check if it needs to be\r\nallowlisted in the
cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This was checked for breaking HTTP API changes, and any
breaking\r\nchanges have been approved by the breaking-change committee.
The\r\n`release_note:breaking` label should be applied in these
situations.\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [x] The PR description includes
the appropriate Release Notes section,\r\nand the correct
`release_note:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13d4813151ff0c7cb549cf0d22565a1f9d46fb68"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205986","number":205986,"mergeCommit":{"message":"[Discover]
Support overriding `solutionNavId` used for root profile resolution in
embeddable (#205986)\n\n## Summary\r\n\r\nThis PR adds support for
overriding the `solutionNavId` used for root\r\nprofile resolution
within the Discover embeddable, allowing consumers to\r\nforce specific
root profiles. Additionally the current usages
of\r\n`LazySavedSearchComponent` within Observability apps have been
updated\r\nto pass `solutionNavIdOverride: 'oblt'` to ensure their
embedded logs\r\ncomponents render in logs mode as
expected.\r\n\r\nResolves #203121.\r\n\r\n### Checklist\r\n\r\n- [ ] Any
text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\r\n-
[x]\r\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\r\nwas
added for features that require explanation or tutorials\r\n- [x] [Unit
or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [ ] If a plugin
configuration key changed, check if it needs to be\r\nallowlisted in the
cloud and added to the
[docker\r\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\r\n-
[ ] This was checked for breaking HTTP API changes, and any
breaking\r\nchanges have been approved by the breaking-change committee.
The\r\n`release_note:breaking` label should be applied in these
situations.\r\n- [ ] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n- [x] The PR description includes
the appropriate Release Notes section,\r\nand the correct
`release_note:*` label is applied per
the\r\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"13d4813151ff0c7cb549cf0d22565a1f9d46fb68"}}]}]
BACKPORT-->

Co-authored-by: Davis McPhee <[email protected]>
viduni94 pushed a commit to viduni94/kibana that referenced this issue Jan 23, 2025
…esolution in embeddable (elastic#205986)

## Summary

This PR adds support for overriding the `solutionNavId` used for root
profile resolution within the Discover embeddable, allowing consumers to
force specific root profiles. Additionally the current usages of
`LazySavedSearchComponent` within Observability apps have been updated
to pass `solutionNavIdOverride: 'oblt'` to ensure their embedded logs
components render in logs mode as expected.

Resolves elastic#203121.

### Checklist

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [x] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Discover Discover Application impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:small Small Level of Effort Project:OneDiscover Enrich Discover with contextual awareness Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. Team:obs-ux-logs Observability Logs User Experience Team
Projects
None yet
3 participants