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

[Stack Monitoring] Remove 'observability' and 'observabilityShared' plugin dependencies #203492

Merged

Conversation

gbamparop
Copy link
Contributor

@gbamparop gbamparop commented Dec 9, 2024

Summary

A recent bug that affected some of the pages in Stack Monitoring was caused by changes related to the locators of the logs-related apps.

The goal of this PR is to reduce the number of Observability dependencies that could potentially cause issues in the app by removing the observability and observabilityShared plugin dependencies from the monitoring plugin.

Currently, the monitoring plugin is categorised as observability but when the dependency on the infra plugin is removed, it can be marked as a platform plugin.

Notes for reviewers

  • The components used to render the header menu as well as the use_track_metric hook were copied from the observabilityShared plugin
  • There should be no UX and functionality changes in the stack monitoring header
  • Usage collection could be verified by searching for UI counters sent by the cluster created for this PR, once telemetry has been sent

Testing

The stateful environment deployed by this PR includes logs and metrics for stack monitoring. Please make sure to select a larger time range (e.g. last 14 days).

@gbamparop gbamparop requested review from a team as code owners December 9, 2024 20:07
@botelastic botelastic bot added ci:project-deploy-observability Create an Observability project Team:obs-ux-management Observability Management User Experience Team labels Dec 9, 2024
@elasticmachine
Copy link
Contributor

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

Copy link
Contributor

github-actions bot commented Dec 9, 2024

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

@gbamparop gbamparop added backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes labels Dec 9, 2024
@gbamparop
Copy link
Contributor Author

/ci

@gbamparop gbamparop changed the title Remove 'observability' and 'observabilityShared' plugin dependencies [Stack Monitoring] Remove 'observability' and 'observabilityShared' plugin dependencies Dec 9, 2024
@gbamparop
Copy link
Contributor Author

/oblt-deploy

@gbamparop gbamparop marked this pull request as draft December 9, 2024 20:37
@gbamparop
Copy link
Contributor Author

/ci

@gbamparop gbamparop marked this pull request as ready for review December 10, 2024 09:41
@gbamparop
Copy link
Contributor Author

@elasticmachine merge upstream

@elasticmachine
Copy link
Contributor

elasticmachine commented Dec 10, 2024

💚 Build Succeeded

  • Buildkite Build
  • Commit: 418d545
  • Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-203492-418d54590de8

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
monitoring 496 500 +4

Async chunks

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

id before after diff
monitoring 533.9KB 538.3KB +4.4KB

Page load bundle

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

id before after diff
monitoring 25.8KB 25.8KB -33.0B
Unknown metric groups

async chunk count

id before after diff
monitoring 5 6 +1

ESLint disabled line counts

id before after diff
monitoring 22 25 +3

References to deprecated APIs

id before after diff
monitoring 2 4 +2

Total ESLint disabled count

id before after diff
monitoring 29 32 +3

History

Copy link
Contributor

@miltonhultgren miltonhultgren left a comment

Choose a reason for hiding this comment

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

Code review only, but these changes look correct.

Copy link
Contributor

@consulthys consulthys left a comment

Choose a reason for hiding this comment

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

LGT Stack Monitoring

In the oblt test cluster deployed, I can see that:

  • usage counters are being properly reported via /api/ui_counters/_report
  • there doesn't appear to be any UX changes
  • the header menu appears unchanged
  • the Discover link appears at the bottom of the logs list and when clicked properly redirects the user to the Discover view

@gbamparop gbamparop merged commit 7e2f67e into elastic:main Dec 10, 2024
8 checks passed
flash1293 added a commit that referenced this pull request Dec 11, 2024
Blocked by #203492

The monitoring plugin is currently marked as observability plugin
because it's relying on the `infra` plugin.

However, in practice, no functionality is actually used. This PR removes
the dependency -it makes monitoring and logstash a `platform/private`
plugin as well (logstash needs to go along with monitoring, but that
should be fine because it's only required by monitoring).

Some considerations left as comments in the code.

---------

Co-authored-by: kibanamachine <[email protected]>
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 11, 2024
Blocked by elastic#203492

The monitoring plugin is currently marked as observability plugin
because it's relying on the `infra` plugin.

However, in practice, no functionality is actually used. This PR removes
the dependency -it makes monitoring and logstash a `platform/private`
plugin as well (logstash needs to go along with monitoring, but that
should be fine because it's only required by monitoring).

Some considerations left as comments in the code.

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 59d3ac6)
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Dec 12, 2024
…lugin dependencies (elastic#203492)

### Summary
A recent [bug](elastic#199902) that
affected some of the pages in Stack Monitoring was caused by changes
related to the locators of the logs-related apps.

The goal of this PR is to reduce the number of Observability
dependencies that could potentially cause issues in the app by removing
the `observability` and `observabilityShared` plugin dependencies from
the `monitoring` plugin.

Currently, the `monitoring` plugin is [categorised as
observability](https://github.com/elastic/kibana/blob/main/x-pack/plugins/monitoring/kibana.jsonc#L7)
but when the dependency on the `infra` plugin is removed, it can be
marked as a `platform` plugin.

### Notes for reviewers
- The components used to render the header menu as well as the
[use_track_metric](https://github.com/elastic/kibana/pull/203492/files#diff-7e39fc60ca80ee551d824ca97f9f879e3364a368a5736cf9178b5943a12ca7a7)
hook were copied from the `observabilityShared` plugin
- There should be no UX and functionality changes in the stack
monitoring header
- Usage collection could be verified by searching for UI counters sent
by the cluster created for this PR, once telemetry has been sent

### Testing
The stateful environment deployed by this PR includes logs and metrics
for stack monitoring. Please make sure to select a larger time range
(e.g. last 14 days).

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Dec 12, 2024
Blocked by elastic#203492

The monitoring plugin is currently marked as observability plugin
because it's relying on the `infra` plugin.

However, in practice, no functionality is actually used. This PR removes
the dependency -it makes monitoring and logstash a `platform/private`
plugin as well (logstash needs to go along with monitoring, but that
should be fine because it's only required by monitoring).

Some considerations left as comments in the code.

---------

Co-authored-by: kibanamachine <[email protected]>
@gbamparop
Copy link
Contributor Author

💚 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

gbamparop added a commit to gbamparop/kibana that referenced this pull request Dec 19, 2024
…lugin dependencies (elastic#203492)

### Summary
A recent [bug](elastic#199902) that
affected some of the pages in Stack Monitoring was caused by changes
related to the locators of the logs-related apps.

The goal of this PR is to reduce the number of Observability
dependencies that could potentially cause issues in the app by removing
the `observability` and `observabilityShared` plugin dependencies from
the `monitoring` plugin.

Currently, the `monitoring` plugin is [categorised as
observability](https://github.com/elastic/kibana/blob/main/x-pack/plugins/monitoring/kibana.jsonc#L7)
but when the dependency on the `infra` plugin is removed, it can be
marked as a `platform` plugin.

### Notes for reviewers
- The components used to render the header menu as well as the
[use_track_metric](https://github.com/elastic/kibana/pull/203492/files#diff-7e39fc60ca80ee551d824ca97f9f879e3364a368a5736cf9178b5943a12ca7a7)
hook were copied from the `observabilityShared` plugin
- There should be no UX and functionality changes in the stack
monitoring header
- Usage collection could be verified by searching for UI counters sent
by the cluster created for this PR, once telemetry has been sent

### Testing
The stateful environment deployed by this PR includes logs and metrics
for stack monitoring. Please make sure to select a larger time range
(e.g. last 14 days).

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
(cherry picked from commit 7e2f67e)
gbamparop added a commit that referenced this pull request Dec 19, 2024
…red' plugin dependencies (#203492) (#204912)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Stack Monitoring] Remove 'observability' and 'observabilityShared'
plugin dependencies
(#203492)](#203492)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Giorgos
Bamparopoulos","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-10T16:43:49Z","message":"[Stack
Monitoring] Remove 'observability' and 'observabilityShared' plugin
dependencies (#203492)\n\n### Summary\r\nA recent
[bug](#199902) that\r\naffected
some of the pages in Stack Monitoring was caused by changes\r\nrelated
to the locators of the logs-related apps.\r\n\r\nThe goal of this PR is
to reduce the number of Observability\r\ndependencies that could
potentially cause issues in the app by removing\r\nthe `observability`
and `observabilityShared` plugin dependencies from\r\nthe `monitoring`
plugin.\r\n\r\nCurrently, the `monitoring` plugin is [categorised
as\r\nobservability](https://github.com/elastic/kibana/blob/main/x-pack/plugins/monitoring/kibana.jsonc#L7)\r\nbut
when the dependency on the `infra` plugin is removed, it can
be\r\nmarked as a `platform` plugin.\r\n\r\n### Notes for reviewers\r\n-
The components used to render the header menu as well as
the\r\n[use_track_metric](https://github.com/elastic/kibana/pull/203492/files#diff-7e39fc60ca80ee551d824ca97f9f879e3364a368a5736cf9178b5943a12ca7a7)\r\nhook
were copied from the `observabilityShared` plugin\r\n- There should be
no UX and functionality changes in the stack\r\nmonitoring header\r\n-
Usage collection could be verified by searching for UI counters
sent\r\nby the cluster created for this PR, once telemetry has been
sent\r\n\r\n### Testing\r\nThe stateful environment deployed by this PR
includes logs and metrics\r\nfor stack monitoring. Please make sure to
select a larger time range\r\n(e.g. last 14
days).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<[email protected]>\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"7e2f67ebc550167f8b9d678312c69eda1abc921b","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:skip","v9.0.0","ci:project-deploy-observability","Team:obs-ux-management"],"number":203492,"url":"https://github.com/elastic/kibana/pull/203492","mergeCommit":{"message":"[Stack
Monitoring] Remove 'observability' and 'observabilityShared' plugin
dependencies (#203492)\n\n### Summary\r\nA recent
[bug](#199902) that\r\naffected
some of the pages in Stack Monitoring was caused by changes\r\nrelated
to the locators of the logs-related apps.\r\n\r\nThe goal of this PR is
to reduce the number of Observability\r\ndependencies that could
potentially cause issues in the app by removing\r\nthe `observability`
and `observabilityShared` plugin dependencies from\r\nthe `monitoring`
plugin.\r\n\r\nCurrently, the `monitoring` plugin is [categorised
as\r\nobservability](https://github.com/elastic/kibana/blob/main/x-pack/plugins/monitoring/kibana.jsonc#L7)\r\nbut
when the dependency on the `infra` plugin is removed, it can
be\r\nmarked as a `platform` plugin.\r\n\r\n### Notes for reviewers\r\n-
The components used to render the header menu as well as
the\r\n[use_track_metric](https://github.com/elastic/kibana/pull/203492/files#diff-7e39fc60ca80ee551d824ca97f9f879e3364a368a5736cf9178b5943a12ca7a7)\r\nhook
were copied from the `observabilityShared` plugin\r\n- There should be
no UX and functionality changes in the stack\r\nmonitoring header\r\n-
Usage collection could be verified by searching for UI counters
sent\r\nby the cluster created for this PR, once telemetry has been
sent\r\n\r\n### Testing\r\nThe stateful environment deployed by this PR
includes logs and metrics\r\nfor stack monitoring. Please make sure to
select a larger time range\r\n(e.g. last 14
days).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<[email protected]>\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"7e2f67ebc550167f8b9d678312c69eda1abc921b"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/203492","number":203492,"mergeCommit":{"message":"[Stack
Monitoring] Remove 'observability' and 'observabilityShared' plugin
dependencies (#203492)\n\n### Summary\r\nA recent
[bug](#199902) that\r\naffected
some of the pages in Stack Monitoring was caused by changes\r\nrelated
to the locators of the logs-related apps.\r\n\r\nThe goal of this PR is
to reduce the number of Observability\r\ndependencies that could
potentially cause issues in the app by removing\r\nthe `observability`
and `observabilityShared` plugin dependencies from\r\nthe `monitoring`
plugin.\r\n\r\nCurrently, the `monitoring` plugin is [categorised
as\r\nobservability](https://github.com/elastic/kibana/blob/main/x-pack/plugins/monitoring/kibana.jsonc#L7)\r\nbut
when the dependency on the `infra` plugin is removed, it can
be\r\nmarked as a `platform` plugin.\r\n\r\n### Notes for reviewers\r\n-
The components used to render the header menu as well as
the\r\n[use_track_metric](https://github.com/elastic/kibana/pull/203492/files#diff-7e39fc60ca80ee551d824ca97f9f879e3364a368a5736cf9178b5943a12ca7a7)\r\nhook
were copied from the `observabilityShared` plugin\r\n- There should be
no UX and functionality changes in the stack\r\nmonitoring header\r\n-
Usage collection could be verified by searching for UI counters
sent\r\nby the cluster created for this PR, once telemetry has been
sent\r\n\r\n### Testing\r\nThe stateful environment deployed by this PR
includes logs and metrics\r\nfor stack monitoring. Please make sure to
select a larger time range\r\n(e.g. last 14
days).\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<[email protected]>\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"7e2f67ebc550167f8b9d678312c69eda1abc921b"}}]}]
BACKPORT-->
CAWilson94 pushed a commit to CAWilson94/kibana that referenced this pull request Jan 13, 2025
Blocked by elastic#203492

The monitoring plugin is currently marked as observability plugin
because it's relying on the `infra` plugin.

However, in practice, no functionality is actually used. This PR removes
the dependency -it makes monitoring and logstash a `platform/private`
plugin as well (logstash needs to go along with monitoring, but that
should be fine because it's only required by monitoring).

Some considerations left as comments in the code.

---------

Co-authored-by: kibanamachine <[email protected]>
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 ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:obs-ux-management Observability Management User Experience Team v8.18.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants