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.

Sign up for GitHub

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

Jump to bottom

[Index Management][Serverless] Extend Index Management UI to visualize the data usage over the time #192966

Closed
YulNaumenko opened this issue Sep 16, 2024 · 11 comments
Closed

[Index Management][Serverless] Extend Index Management UI to visualize the data usage over the time #192966

YulNaumenko opened this issue Sep 16, 2024 · 11 comments
Assignees
@neptunian @ashokaditya
Labels
enhancement New value added to drive a business result Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more

Comments

@YulNaumenko
Copy link
Contributor

YulNaumenko commented Sep 16, 2024 •
edited
Loading

Serverless users should be able to analyze how much data they are ingesting (daily/weekly/etc.) and retaining over the selected period of time.
Current Kibana Index Management page shows only the storage size per datastream at the current point of time.
The goal of that issue is to describe the UI scope for the datastreams usage visualization. The Kibana API which will serve it is described as a separate ticket #192965

Extend Data section cards with the new link to the Data Usage page:
Image

The page components:

  • 2 custom Time series charts show the ingested data and retained data over a period of time (with ability to switch between line and bar)
  • time range filter to select from and to dates
  • chart should has the legend which reflects the displayed datastreams and could work as a filter to show/hide the data per datastream
  • control to manage which time scale to use - hour/day/week/month

Image

All the interactive components will call the internal Kibana API here #192965

Mockups: /// TODO
@botelastic botelastic bot added the needs-team Issues missing a team label label Sep 16, 2024
@YulNaumenko YulNaumenko mentioned this issue Sep 16, 2024
Closed
@lukasolson lukasolson added Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more and removed needs-team Issues missing a team label labels Sep 18, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-management (Team:Kibana Management)

@neptunian neptunian mentioned this issue Sep 19, 2024
Merged
@alisonelizabeth alisonelizabeth added the enhancement New value added to drive a business result label Sep 19, 2024
@MikePaquette
Copy link

Based on several inquiries today, I think we can focus our design work by prioritizing the classes of use cases we want to support with this visualization.

We can classify these use cases into three buckets as summarized below. There may be more.

I propose that we prioritize bucket 1, "Find Heavy Hitters" because this bucket is most closely related the usage and billing transparency we seek to provide to our serverless customers. Buckets 2 and 3 are indeed useful, but if we treat them as secondary priorities, we may be able to make good design decisions quickly.

  1. Find Heavy Hitters - determine the Top N data streams that are ingesting at highest rates and/or retaining the highest data volumes to answer questions like:
  • Heya data engineer, your project monthly charge is getting pretty high, can you trim down your retention settings, and get rid of some old data?
  • Heya analytics-person, your dashboard is really slow, how much data is in those indices that you’re querying?
  • Heya platform engineer, what’s your average daily ingest volume, in GB/Day for all your windows data streams?
  1. View Ingest rate patterns to answer questions like:
  • does this/these/all/any data streams have a periodicity, perhaps day/night or weekday/weekend
  • What’s the current ingest rate right now for this/these/all data streams
  1. View Ingest rate anomalies to answer questions like
  • Are we ingesting more EDR logs today than we were at this time last week?
  • Is there an unusually high rate of ingest on this/these/any/all data streams
  • Is there an unusually low rate of ingest on this/these/any/all data streams

neptunian added a commit that referenced this issue Sep 20, 2024
@neptunian @kibanamachine
[Data Usage] New plugin (#193466)
bda0859 
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://github.com/user-attachments/assets/705e3866-bc88-436a-8532-2af53167f7b1">


#192965
#192966

---------

Co-authored-by: kibanamachine <[email protected]>
neptunian added a commit to neptunian/kibana that referenced this issue Sep 20, 2024
@neptunian @kibanamachine
[Data Usage] New plugin (elastic#193466)
480e549 
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://github.com/user-attachments/assets/705e3866-bc88-436a-8532-2af53167f7b1">

elastic#192965
elastic#192966

---------

Co-authored-by: kibanamachine <[email protected]>
@neptunian neptunian mentioned this issue Sep 20, 2024
Merged
10 tasks
jbudz pushed a commit that referenced this issue Sep 20, 2024
@neptunian @kibanamachine
[8.x][Data Usage] New plugin (#193466) (#193597)
3d72870 
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://github.com/user-attachments/assets/705e3866-bc88-436a-8532-2af53167f7b1">

#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.

- [ ] 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/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] 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 renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### 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&mdash;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&mdash;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](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

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

neptunian commented Sep 24, 2024 •
edited
Loading

Thanks @MikePaquette I think this would be useful for design as I'm not sure these issues are addressed and the design is still in flux. This design is outdated and I think the new one is still being worked on.

@ashokaditya ashokaditya self-assigned this Oct 3, 2024
@neptunian neptunian mentioned this issue Oct 4, 2024
Closed
@ashokaditya
Copy link
Member

ashokaditya commented Oct 9, 2024 •
edited
Loading

#193966
#195556
#196559

@ashokaditya
Copy link
Member

ashokaditya commented Oct 25, 2024 •
edited
Loading

#197056

@ashokaditya
Copy link
Member

Test PR #198007

@ashokaditya
Copy link
Member

Date/Data stream filter fixes #200731

@ashokaditya
Copy link
Member

feature flag PR #201465

@ashokaditya
Copy link
Member

UX/API date validations PR #201638

@ashokaditya
Copy link
Member

another ux feedback PR #203465

@ashokaditya
Copy link
Member

functional tests PR #203166

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@neptunian neptunian

@ashokaditya ashokaditya

Labels
enhancement New value added to drive a business result Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@lukasolson @neptunian @ashokaditya @alisonelizabeth @elasticmachine @MikePaquette @YulNaumenko