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

[Dataset Quality] Check if Obs Logs Explorer accessible before linking Logs Explorer #197020

Conversation

awahab07
Copy link
Contributor

@awahab07 awahab07 commented Oct 21, 2024

Fixes #196506

Summary

Before linking to Logs Explorer in Dataset Quality, the PR checks if observability-logs-explorer is available and accessible before consuming the SINGLE_DATASET_LOCATOR_ID locator.

Observability Logs Explorer app is not available in Security and Search solution views.

After the fix:

196506-obs-logs-link-broken-security-search.mov

There's only one more place, Observability Onboarding, where SINGLE_DATASET_LOCATOR_ID is consumed. Which being part of Observability solution view, it can be assumed that Observability Logs Explorer will always be available.

image


The other Observability Logs Explorer locator ALL_DATASETS_LOCATOR_ID is only consumed in observability wrapper apps and apm and infra plugins, all of which are only available under Observability where Observability Logs Explorer is also available.

export const ALL_DATASETS_LOCATOR_ID = 'ALL_DATASETS_LOCATOR';

@awahab07 awahab07 added bug Fixes for quality problems that affect the customer experience release_note:skip Skip the PR/issue when compiling release notes 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 21, 2024
@awahab07 awahab07 requested a review from a team as a code owner October 21, 2024 09:54
@elasticmachine
Copy link
Contributor

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

@botelastic botelastic bot added the ci:project-deploy-observability Create an Observability project label Oct 21, 2024
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.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@elasticmachine
Copy link
Contributor

elasticmachine commented Oct 21, 2024

💛 Build succeeded, but was flaky

  • Buildkite Build
  • Commit: aad75e8
  • Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-197020-aad75e8998ae

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
datasetQuality 225 230 +5

Async chunks

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

id before after diff
datasetQuality 229.0KB 229.8KB +816.0B

Page load bundle

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

id before after diff
datasetQuality 18.5KB 18.5KB +49.0B

History

Copy link
Contributor

@yngrdyn yngrdyn left a comment

Choose a reason for hiding this comment

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

LGTM

@mohamedhamed-ahmed
Copy link
Contributor

Are we going to backport this to 8.16 since its a bug? if so we might need to update the labels

@awahab07 awahab07 merged commit c076b7a into elastic:main Oct 22, 2024
26 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.x

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

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 22, 2024
…g Logs Explorer (elastic#197020)

Fixes elastic#196506

## Summary

Before linking to Logs Explorer in Dataset Quality, the PR checks if
`observability-logs-explorer` is available and accessible before
consuming the `SINGLE_DATASET_LOCATOR_ID` locator.

Observability Logs Explorer app is not available in Security and Search
solution views.

After the fix:

https://github.com/user-attachments/assets/ed36806a-0483-4765-a6f1-85936b92d390

There's only one more place, Observability Onboarding, where
`SINGLE_DATASET_LOCATOR_ID` is consumed. Which being part of
Observability solution view, it can be assumed that Observability Logs
Explorer will always be available.

![image](https://github.com/user-attachments/assets/b51bf9b6-a9c4-4fd4-8865-3dda76262a93)

----

The other Observability Logs Explorer locator `ALL_DATASETS_LOCATOR_ID`
is only consumed in observability wrapper apps and `apm` and `infra`
plugins, all of which are only available under Observability where
Observability Logs Explorer is also available.

https://github.com/elastic/kibana/blob/68b3267ca2f76d8de4fedef622608d8685e7eceb/packages/deeplinks/observability/locators/observability_logs_explorer.ts#L24

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit c076b7a)
@kibanamachine
Copy link
Contributor

💚 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

kibanamachine added a commit that referenced this pull request Oct 22, 2024
…linking Logs Explorer (#197020) (#197235)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Dataset Quality] Check if Obs Logs Explorer accessible before
linking Logs Explorer
(#197020)](#197020)

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

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

<!--BACKPORT [{"author":{"name":"Abdul Wahab
Zahid","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-22T13:09:48Z","message":"[Dataset
Quality] Check if Obs Logs Explorer accessible before linking Logs
Explorer (#197020)\n\nFixes
https://github.com/elastic/kibana/issues/196506\r\n\r\n##
Summary\r\n\r\nBefore linking to Logs Explorer in Dataset Quality, the
PR checks if\r\n`observability-logs-explorer` is available and
accessible before\r\nconsuming the `SINGLE_DATASET_LOCATOR_ID`
locator.\r\n\r\nObservability Logs Explorer app is not available in
Security and Search\r\nsolution views.\r\n\r\n\r\nAfter the
fix:\r\n\r\n\r\nhttps://github.com/user-attachments/assets/ed36806a-0483-4765-a6f1-85936b92d390\r\n\r\n\r\n\r\nThere's
only one more place, Observability Onboarding,
where\r\n`SINGLE_DATASET_LOCATOR_ID` is consumed. Which being part
of\r\nObservability solution view, it can be assumed that Observability
Logs\r\nExplorer will always be
available.\r\n\r\n\r\n![image](https://github.com/user-attachments/assets/b51bf9b6-a9c4-4fd4-8865-3dda76262a93)\r\n\r\n----\r\n\r\nThe
other Observability Logs Explorer locator
`ALL_DATASETS_LOCATOR_ID`\r\nis only consumed in observability wrapper
apps and `apm` and `infra`\r\nplugins, all of which are only available
under Observability where\r\nObservability Logs Explorer is also
available.\r\n\r\nhttps://github.com/elastic/kibana/blob/68b3267ca2f76d8de4fedef622608d8685e7eceb/packages/deeplinks/observability/locators/observability_logs_explorer.ts#L24\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"c076b7ac45957c2cffb4cbb5f197e8b01a64c8f9","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-logs"],"title":"[Dataset
Quality] Check if Obs Logs Explorer accessible before linking Logs
Explorer","number":197020,"url":"https://github.com/elastic/kibana/pull/197020","mergeCommit":{"message":"[Dataset
Quality] Check if Obs Logs Explorer accessible before linking Logs
Explorer (#197020)\n\nFixes
https://github.com/elastic/kibana/issues/196506\r\n\r\n##
Summary\r\n\r\nBefore linking to Logs Explorer in Dataset Quality, the
PR checks if\r\n`observability-logs-explorer` is available and
accessible before\r\nconsuming the `SINGLE_DATASET_LOCATOR_ID`
locator.\r\n\r\nObservability Logs Explorer app is not available in
Security and Search\r\nsolution views.\r\n\r\n\r\nAfter the
fix:\r\n\r\n\r\nhttps://github.com/user-attachments/assets/ed36806a-0483-4765-a6f1-85936b92d390\r\n\r\n\r\n\r\nThere's
only one more place, Observability Onboarding,
where\r\n`SINGLE_DATASET_LOCATOR_ID` is consumed. Which being part
of\r\nObservability solution view, it can be assumed that Observability
Logs\r\nExplorer will always be
available.\r\n\r\n\r\n![image](https://github.com/user-attachments/assets/b51bf9b6-a9c4-4fd4-8865-3dda76262a93)\r\n\r\n----\r\n\r\nThe
other Observability Logs Explorer locator
`ALL_DATASETS_LOCATOR_ID`\r\nis only consumed in observability wrapper
apps and `apm` and `infra`\r\nplugins, all of which are only available
under Observability where\r\nObservability Logs Explorer is also
available.\r\n\r\nhttps://github.com/elastic/kibana/blob/68b3267ca2f76d8de4fedef622608d8685e7eceb/packages/deeplinks/observability/locators/observability_logs_explorer.ts#L24\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"c076b7ac45957c2cffb4cbb5f197e8b01a64c8f9"}},"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/197020","number":197020,"mergeCommit":{"message":"[Dataset
Quality] Check if Obs Logs Explorer accessible before linking Logs
Explorer (#197020)\n\nFixes
https://github.com/elastic/kibana/issues/196506\r\n\r\n##
Summary\r\n\r\nBefore linking to Logs Explorer in Dataset Quality, the
PR checks if\r\n`observability-logs-explorer` is available and
accessible before\r\nconsuming the `SINGLE_DATASET_LOCATOR_ID`
locator.\r\n\r\nObservability Logs Explorer app is not available in
Security and Search\r\nsolution views.\r\n\r\n\r\nAfter the
fix:\r\n\r\n\r\nhttps://github.com/user-attachments/assets/ed36806a-0483-4765-a6f1-85936b92d390\r\n\r\n\r\n\r\nThere's
only one more place, Observability Onboarding,
where\r\n`SINGLE_DATASET_LOCATOR_ID` is consumed. Which being part
of\r\nObservability solution view, it can be assumed that Observability
Logs\r\nExplorer will always be
available.\r\n\r\n\r\n![image](https://github.com/user-attachments/assets/b51bf9b6-a9c4-4fd4-8865-3dda76262a93)\r\n\r\n----\r\n\r\nThe
other Observability Logs Explorer locator
`ALL_DATASETS_LOCATOR_ID`\r\nis only consumed in observability wrapper
apps and `apm` and `infra`\r\nplugins, all of which are only available
under Observability where\r\nObservability Logs Explorer is also
available.\r\n\r\nhttps://github.com/elastic/kibana/blob/68b3267ca2f76d8de4fedef622608d8685e7eceb/packages/deeplinks/observability/locators/observability_logs_explorer.ts#L24\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"c076b7ac45957c2cffb4cbb5f197e8b01a64c8f9"}}]}]
BACKPORT-->

Co-authored-by: Abdul Wahab Zahid <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) bug Fixes for quality problems that affect the customer experience ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:obs-ux-logs Observability Logs User Experience Team v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Dataset Quality] 🐞 Link to logs explorer is broken in non-observability instances
5 participants