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

[8.x][Data Usage] New plugin (#193466) #193597

Merged
merged 1 commit into from
Sep 20, 2024
Merged

[8.x][Data Usage] New plugin (#193466) #193597

merged 1 commit into from
Sep 20, 2024

Conversation

neptunian
Copy link
Contributor

The initial serverless only plugin for viewing data usage and retention in Management. The purpose of this PR is to provide a place for other engineers to work on it, hidden from public use.

  • Plugin is hidden by default and can be enabled through kibana.yml xpack.dataUsage.enabled: true
  • Currently it will show up in both stateful and serverless (if enabled using config above). When we are ready to make the plugin available we will enable it in config/serverless.yml
  • Renders a card in Management (serverless) when enabled: Screenshot 2024-09-19 at 4 14 15 PM

#192965
#192966


Summary

Summarize your PR. If it involves visual changes include a screenshot or gif.

Checklist

Delete any items that are not applicable to this PR.

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

The initial serverless only plugin for viewing data usage and retention
in Management. The purpose of this PR is to provide a place for other
engineers to work on it, hidden from public use.

- Plugin is hidden by default and can be enabled through kibana.yml
`xpack.dataUsage.enabled: true`
- Currently it will show up in both stateful and serverless (if enabled
using config above). When we are ready to make the plugin available we
will enable it in config/serverless.yml
- Renders a card in Management (serverless) when enabled:
<img width="1269" alt="Screenshot 2024-09-19 at 4 14 15 PM"
src="https:/user-attachments/assets/705e3866-bc88-436a-8532-2af53167f7b1">

elastic#192965
elastic#192966

---------

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

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@obltmachine
Copy link

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

@neptunian neptunian changed the title [Data Usage] New plugin (#193466) [8.x][Data Usage] New plugin (#193466) Sep 20, 2024
@neptunian
Copy link
Contributor Author

/ci

@kibana-ci
Copy link
Collaborator

kibana-ci commented Sep 20, 2024

💔 Build Failed

Failed CI Steps

Test Failures

  • [job] [logs] Jest Tests #8 / SuggestUsersPopover calls onUsersChange when 1 user is selected
  • [job] [logs] Jest Tests #8 / SuggestUsersPopover calls onUsersChange when 1 user is selected

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
dataUsage - 30 +30

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
dataUsage - 6 +6

Async chunks

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

id before after diff
dataUsage - 6.7KB +6.7KB
management 45.9KB 46.1KB +219.0B
total +6.9KB

Page load bundle

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

id before after diff
dataUsage - 4.0KB +4.0KB
serverless 14.0KB 14.1KB +168.0B
serverlessObservability 27.0KB 27.2KB +168.0B
serverlessSearch 20.8KB 21.0KB +168.0B
total +4.5KB
Unknown metric groups

API count

id before after diff
dataUsage - 6 +6

async chunk count

id before after diff
dataUsage - 1 +1

ESLint disabled in files

id before after diff
dataUsage - 1 +1

ESLint disabled line counts

id before after diff
dataUsage - 3 +3

Total ESLint disabled count

id before after diff
dataUsage - 4 +4

History

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

@jbudz jbudz merged commit 3d72870 into elastic:8.x Sep 20, 2024
31 of 34 checks passed
@delanni
Copy link
Contributor

delanni commented Sep 23, 2024

Just connecting the dots here, this is a backport of #193466

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants