[Logs UX] Classify logs-data-access and logs-shared as platform plugins #201263

weltenwort · 2024-11-21T18:09:59Z

📝 Summary

This classifies @kbn/logs-data-access-plugin, @kbn/logs-shared-plugin and @kbn/observability-logs-overview as "platform/shared".

partly addresses: https://github.com/elastic/observability-dev/issues/4059

🕵️‍♀️ Review Notes

In order to remove the forbidden dependency of logs-shared on observability-shared a few changes were made:

The link to APM is created via the locator registry. The existing transaction-by-trace-id locator was enhanced to support passing the time range parameters as required.
The ability to extend the log entry context menu via the triggers mechanism was removed, because it was unused anyway.
Some convenience wrappers for the ui counters were inlined.
@kbn/xstate-utils as a shared dependency was also classified as platform/shared.

…dules

…fix'

…dules

weltenwort · 2024-12-11T09:27:48Z

...servability_solution/logs_shared/public/components/logging/log_text_stream/log_entry_row.tsx

@@ -74,7 +68,7 @@ export const LogEntryRow = memo(
    scale,
    wrap,
  }: LogEntryRowProps) => {
-    const trackMetric = useUiTracker({ app: 'infra_logs' });
+    const trackMetric = useUiTracker();


The in-lined version of this is hard-coded to infra_logs.

weltenwort · 2024-12-11T09:28:36Z

x-pack/plugins/observability_solution/logs_shared/public/hooks/use_kibana.tsx

@@ -20,8 +20,7 @@ import {
 } from '../types';

 export type PluginKibanaContextValue = CoreStart &
-  LogsSharedClientStartDeps &
-  LogsSharedClientStartExports;
+  LogsSharedClientStartDeps & { logsShared: LogsSharedClientStartExports };


This aligns the shape of the context with that of the other consuming plugins. This way no distinction of local and non-local usage is necessary at the usage site.

elasticmachine · 2024-12-11T09:29:22Z

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

jennypavlova

Obs UX Infra changes LGTM / code review only

github-actions · 2024-12-11T10:40:22Z

🤖 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!)

tonyghiani

Code review only LGTM, I see we'll get some duplicated utils between observability-shared and logs-shared, but it doesn't seem anything urgent to refactor yet 👌

weltenwort · 2024-12-11T16:56:15Z

@tonyghiani thanks for the review!

I see we'll get some duplicated utils between observability-shared and logs-shared, but it doesn't seem anything urgent to refactor yet

Yes, that was the proposed short-term solution to cut the dependency ties in the issue. While there was an obvious shared package to move the APM locators to, I didn't want to add more complexity by creating some more packages for just a few lines.

weltenwort · 2024-12-12T15:03:26Z

@elasticmachine merge upstream

fkanout

Code review only LGTM.

…dules

elasticmachine · 2024-12-16T16:02:12Z

💚 Build Succeeded

Buildkite Build
Commit: dde3adc
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-201263-dde3adc4d932

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`apm`	1922	1923	+1
`dataQuality`	90	91	+1
`datasetQuality`	277	278	+1
`dataUsage`	142	143	+1
`discover`	944	945	+1
`infra`	1542	1543	+1
`inventory`	257	258	+1
`logsExplorer`	569	570	+1
`logsShared`	376	379	+3
`observability`	1107	1108	+1
`observabilityAIAssistantApp`	414	415	+1
`observabilityLogsExplorer`	211	212	+1
`observabilityOnboarding`	255	256	+1
`observabilityShared`	221	231	+10
`profiling`	312	313	+1
`unifiedDocViewer`	216	217	+1
`uptime`	591	592	+1
`ux`	205	206	+1
total			+29

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
`@kbn/deeplinks-observability`	53	58	+5
`observabilityShared`	516	518	+2
total			+7

Async chunks

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

id	before	after	diff
`infra`	1.7MB	1.7MB	+1.0B
`logsShared`	294.6KB	291.0KB	-3.6KB
total			-3.6KB

Page load bundle

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

id	before	after	diff
`infra`	57.8KB	57.8KB	-79.0B
`logsShared`	174.8KB	174.8KB	+6.0B
`observabilityShared`	93.7KB	93.8KB	+37.0B
total			-36.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/deeplinks-observability`	65	70	+5
`observabilityShared`	522	524	+2
total			+7

History

💚 Build #259876 succeeded 9b1742c
💚 Build #259016 succeeded 6146ba0
💔 Build #258967 failed 87c2348
💔 Build #258924 failed 12f4c80
💚 Build #256183 succeeded 84a9906

cc @weltenwort

jloleysens

Core changes LGTM

jloleysens · 2024-12-17T09:32:30Z

x-pack/plugins/observability_solution/logs_data_access/kibana.jsonc

+  "group": "platform",
+  "visibility": "shared",


Is the plan to move this out of the observability_solution directory to reflect this scoping in the dir structure too?

I imagine so, when this PR is merged, we will be able to re-run the relocation logic on the relocation PR.
Then, these modules will be placed under

x-pack/platform/plugins/shared/...

Correct?

What remains to be seen, is if my script will remove the observability_solution fragment of the path with a transform function, I'll check to confirm.

jloleysens · 2024-12-17T09:33:04Z

x-pack/plugins/observability_solution/logs_shared/kibana.jsonc

@@ -2,29 +2,39 @@
  "type": "plugin",
  "id": "@kbn/logs-shared-plugin",
  "owner": "@elastic/obs-ux-logs-team",
+  "group": "platform",


Same comment as for logs_data_access

gsoldevila

LGTM on green! Since the ESLINT rule has been removed, CI will confirm whether the changes violate the no_group_crossing rules.

kibanamachine · 2024-12-17T10:48:53Z

Starting backport for target branches: 8.x

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

kibanamachine · 2024-12-17T10:53:55Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 201263

Questions ?

Please refer to the Backport tool documentation

weltenwort · 2024-12-17T11:11:40Z

💚 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

…ns (elastic#201263) This classifies `@kbn/logs-data-access-plugin`, `@kbn/logs-shared-plugin` and `@kbn/observability-logs-overview` as "platform/shared". --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]> (cherry picked from commit d5e0d3a) # Conflicts: # .eslintrc.js

… plugins (#201263) (#204546) # Backport This will backport the following commits from `main` to `8.x`: - [[Logs UX] Classify logs-data-access and logs-shared as platform plugins (#201263)](#201263)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

…ns (elastic#201263) This classifies `@kbn/logs-data-access-plugin`, `@kbn/logs-shared-plugin` and `@kbn/observability-logs-overview` as "platform/shared". --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>

weltenwort added 3 commits November 20, 2024 17:57

Classify @kbn/logs-data-access-plugin as a platform-shared plugin

2fdf7cd

Duplicate a small utility hook

17483fe

Move trace locator param type to package

d0a1385

weltenwort added the Team:obs-ux-logs Observability Logs User Experience Team label Nov 21, 2024

weltenwort self-assigned this Nov 21, 2024

Merge remote-tracking branch 'upstream/main' into logs-ux-classify-mo…

9d30869

…dules

weltenwort changed the title ~~[Logs UX] Classify modules sustainably~~ [Logs UX] Classify logs-data-access and logs-shared as platform plugins Nov 22, 2024

weltenwort and others added 8 commits November 22, 2024 17:10

Inline ui event tracking code into logs_shared

6c11937

Invert dependency direction of logs-shared and obs-shared

3026444

Remove unused uiActions trigger from context menu

ded04f3

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

6071a11

…fix'

Merge remote-tracking branch 'upstream/main' into logs-ux-classify-mo…

1316001

…dules

Fix log flyout apm link unit tests

b33b37a

Merge remote-tracking branch 'upstream/main' into logs-ux-classify-mo…

27f4e08

…dules

Fix linting problems

84a9906

weltenwort mentioned this pull request Dec 4, 2024

Sustainable Kibana Architecture: Move modules owned by @elastic/observability-ui #202834

Open

weltenwort added 3 commits December 10, 2024 12:56

Merge remote-tracking branch 'upstream/main' into logs-ux-classify-mo…

ef85395

…dules

Fix shape of own services in React context

215514d

Remove linting exception for logs_shared

12f4c80

weltenwort added 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) labels Dec 10, 2024

weltenwort added 2 commits December 10, 2024 17:12

Classify logs-overview as platform/shared

87c2348

Classify dependency xstate-utils as platform/shared

6146ba0

weltenwort commented Dec 11, 2024

View reviewed changes

weltenwort marked this pull request as ready for review December 11, 2024 09:29

weltenwort requested review from a team as code owners December 11, 2024 09:29

jennypavlova approved these changes Dec 11, 2024

View reviewed changes

botelastic bot added the ci:project-deploy-observability Create an Observability project label Dec 11, 2024

tonyghiani approved these changes Dec 11, 2024

View reviewed changes

Ikuni17 approved these changes Dec 11, 2024

View reviewed changes

Merge branch 'main' into logs-ux-classify-modules

9b1742c

fkanout self-requested a review December 16, 2024 14:08

fkanout approved these changes Dec 16, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/main' into logs-ux-classify-mo…

dde3adc

…dules

jloleysens approved these changes Dec 17, 2024

View reviewed changes

gsoldevila approved these changes Dec 17, 2024

View reviewed changes

weltenwort merged commit d5e0d3a into elastic:main Dec 17, 2024
9 checks passed

kibanamachine added the v9.0.0 label Dec 17, 2024

weltenwort mentioned this pull request Dec 17, 2024

[8.x] [Logs UX] Classify logs-data-access and logs-shared as platform plugins (#201263) #204546

Merged

kibanamachine added the v8.18.0 label Dec 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Logs UX] Classify logs-data-access and logs-shared as platform plugins #201263

[Logs UX] Classify logs-data-access and logs-shared as platform plugins #201263

weltenwort commented Nov 21, 2024 •

edited by kibanamachine

Loading

weltenwort Dec 11, 2024

weltenwort Dec 11, 2024

elasticmachine commented Dec 11, 2024

jennypavlova left a comment

github-actions bot commented Dec 11, 2024

tonyghiani left a comment

weltenwort commented Dec 11, 2024

weltenwort commented Dec 12, 2024

fkanout left a comment

elasticmachine commented Dec 16, 2024 •

edited

Loading

API count

jloleysens left a comment

jloleysens Dec 17, 2024

gsoldevila Dec 17, 2024

gsoldevila Dec 17, 2024

jloleysens Dec 17, 2024

gsoldevila left a comment

kibanamachine commented Dec 17, 2024

kibanamachine commented Dec 17, 2024

weltenwort commented Dec 17, 2024

[Logs UX] Classify logs-data-access and logs-shared as platform plugins #201263

[Logs UX] Classify logs-data-access and logs-shared as platform plugins #201263

Conversation

weltenwort commented Nov 21, 2024 • edited by kibanamachine Loading

📝 Summary

🕵️‍♀️ Review Notes

weltenwort Dec 11, 2024

Choose a reason for hiding this comment

weltenwort Dec 11, 2024

Choose a reason for hiding this comment

elasticmachine commented Dec 11, 2024

jennypavlova left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 11, 2024

🤖 GitHub comments

tonyghiani left a comment

Choose a reason for hiding this comment

weltenwort commented Dec 11, 2024

weltenwort commented Dec 12, 2024

fkanout left a comment

Choose a reason for hiding this comment

elasticmachine commented Dec 16, 2024 • edited Loading

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

jloleysens left a comment

Choose a reason for hiding this comment

jloleysens Dec 17, 2024

Choose a reason for hiding this comment

gsoldevila Dec 17, 2024

Choose a reason for hiding this comment

gsoldevila Dec 17, 2024

Choose a reason for hiding this comment

jloleysens Dec 17, 2024

Choose a reason for hiding this comment

gsoldevila left a comment

Choose a reason for hiding this comment

kibanamachine commented Dec 17, 2024

kibanamachine commented Dec 17, 2024

💔 All backports failed

Manual backport

Questions ?

weltenwort commented Dec 17, 2024

💚 All backports created successfully

Questions ?

weltenwort commented Nov 21, 2024 •

edited by kibanamachine

Loading

elasticmachine commented Dec 16, 2024 •

edited

Loading