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

[Index Management][Serverless] Add new internal Kibana API to fetch the data usage #192965

Open
YulNaumenko opened this issue Sep 16, 2024 · 18 comments
Assignees
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

In Serverless Security and Observability projects the users should be able to analyze how much data they are ingesting (daily/weekly/etc.) and retaining over the selected period of time.
Currently Kibana Index Management page shows only the storage size per datastream at the current point of time.
Image

The goal of the issue is to build the APIs which will help to extend the current Data Streams tab with the chart and the chart management logic referred in the UI part #192966 of the scope.

The requirements to the API:

  • reuse current Kibana Index Management plugin server side and ES client API to return the all available datastreams for the current user:
const getDataStreams = (client: IScopedClusterClient, name = '*') => {
  return client.asCurrentUser.indices.getDataStream({
    name,
    expand_wildcards: 'all',
  });
};
  • being able to fetch AutoOps API using mTLS authorization. AutoOps API definition:
POST /monitoring/serverless/v1/projects/{project_id}/metrics

Request Body:
{
	"from": 1725433672446,
        "to": 1725432672446,
        "size": 10,
        "sort":  "asc",
	"level": "datastream",
	"metric_types": ["storage_retained", "ingest_rate"],
	"allowed_indices": ["index-1", ..., "index-n"]
}
Parameter Required Description
from Yes The start time of the chosen time period since the UNIX epoch
to Yes The end time of the chosen time period since the UNIX epoch
size No(default: 10) The number of indices / data streams with the biggest resource usage to return
sort No(default: -) The metric type (as enumerated in metric_types) by which to sort the results (from highest to lowest). Note: for certain metric types, such as the *_vcu ones, this parameter doesn’t apply.
after No(default: -) When paginating indices or data streams from highest to lowest resource usage, the name of the index / data stream from which the next response should start. (Also see open point regarding pagination)
level Yes- project- datastream- index The level at which the usage for the allowed indices should be aggregated, i.e. at project-level (if project) or broken down by index (if index) or by data stream (if datastream)
metric_types[] Yes- storage_retained- ingest_rate- search_vcu- ingest_vcu- ml_vcu An enumeration indicating which metric types should be returned. Depending on project types, some metric types are not available, but this allows to return only what’s strictly required by the client instead of returning all metric types all the time.
allowed_indices[] No(default: _all) A list of indices and/or data stream names (or name patterns) for which to get the usage history. Ideally, this parameter should contain the same list of indices as in the indices.names array returned from the Get user privileges API.

AutoOps API response format:

{
  "metrics": {
    "storage_retained": [
      {
        "name": "ds-1",
        "data": [
          [
           "timestamp",
            "size"
          ],
   .....
      },
...,
    ],
    "ingest_rate": [
      {
        "name": "index-1",
        "data": [
          [
           "timestamp",
           "size"
          ],
          ...,
      },
	...
    ]
  }
}

Depending to the query from the Kibana client side the new API should return the response to display one or multiple datastreams in the time series bar chart as hourly/daily/monthly ingest size or/and retained size.

Kibana API params:

  • from - Required. The start time of the chosen time period
  • to - Required. The end time of the chosen time period
  • datastreams - Optional. Filter which datastreams to include.
  • usageTypes - Required. What usage types to include in the response: ingest, retained or both.
  • scaleTime - hourly/daily/weekly/monthly
@botelastic botelastic bot added the needs-team Issues missing a team label label Sep 16, 2024
@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)

@consulthys
Copy link
Contributor

If that helps, here is the OpenAPI spec of the Serverless Project Metrics API: https://github.com/elastic/autoops-services/blob/master/monitoring/service/specs/serverless_project_metrics_api.yaml

@alisonelizabeth alisonelizabeth added the enhancement New value added to drive a business result label Sep 19, 2024
neptunian added a commit that referenced this issue Sep 20, 2024
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 <42973632+kibanamachine@users.noreply.github.com>
neptunian added a commit to neptunian/kibana that referenced this issue Sep 20, 2024
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 <42973632+kibanamachine@users.noreply.github.com>
jbudz pushed a commit that referenced this issue Sep 20, 2024
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 <42973632+kibanamachine@users.noreply.github.com>
@neptunian
Copy link
Contributor

neptunian commented Sep 20, 2024

Hi @ashokaditya . I have a basic api contract I wanted to share with you. It doesn't take the overview metrics into consideration right now as I'd like to focus on the charts first, but feel free to add those/add placeholders how you see fit. Also feel free to change the names of things, this is just to illustrate structure.

Request

{
  "from": "2023-09-01T00:00:00Z",
  "to": "2023-09-30T23:59:59Z",
  "metricTypes": ["ingestedMax", "retainedMax"],  // Flexible to support multiple metric types
  "dataStreams": []  // Optional: If omitted or empty, return top N data streams
}
  • metricTypes I am assuming we are getting max values for the metrics so maybe that should be reflected in the names.
  • metricTypes I'll likely call one at a time, for each chart, to improve performance
  • I left out size because it sounds like we are going to get top N which can be hard coded on the server side. I'm not seeing a use case where I would need to specify the size.
  • by default the initial request, I'm going to assume, will be to get top n, therefore dataStreams will be empty, and I'll expect the N number of data streams to plot. Once the feature for the user searching and adding specific data streams happens, i'll expect those specific data streams. again size would not be needed here, it's the size of the dataStreams array if the array is not empty.

Response

{
  "charts": [
    {
      "key": "ingestedMax",
      "series": [
        {
          "streamName": "data_stream_1",
          "data": [
            { "x": 1726858530000, "y": 1000000 },
            { "x": 1726862130000, "y": 1200000 },
            { "x": 1726865730000, "y": 1100000 }
          ]
        },
        {
          "streamName": "data_stream_2",
          "data": [
            { "x": 1726858530000, "y": 950000 },
            { "x": 1726862130000, "y": 980000 },
            { "x": 1726865730000, "y": 990000 }
          ]
        }
      ]
    },
    {
      "key": "retainedMax",
      "series": [
        {
          "streamName": "data_stream_1",
          "data": [
            { "x": 1726858530000, "y": 800000 },
            { "x": 1726862130000, "y": 850000 },
            { "x": 1726865730000, "y": 870000 }
          ]
        },
        {
          "streamName": "data_stream_2",
          "data": [
            { "x": 1726858530000, "y": 700000 },
            { "x": 1726862130000, "y": 720000 },
            { "x": 1726865730000, "y": 750000 }
          ]
        }
      ]
    }
  ]
}

** Can you confirm with autoOps that the data streams could be different per chart? If we request top N data streams, I would expect they could be different based on the metric types and you would receive two separate sorted arrays.

@neptunian
Copy link
Contributor

@ashokaditya I removed the timeInterval as it looks like the charts can figure that out based on the mix and max ranges of the time series data. I also probably don't need the yUnit right now and can assume its bytes, maybe something we'd need later but could add later.

@ashokaditya
Copy link
Member

ashokaditya commented Sep 25, 2024

API/UX hooks PR #193966

@ashokaditya
Copy link
Member

ashokaditya commented Oct 9, 2024

Page enhancements PR #195556

@ashokaditya
Copy link
Member

ashokaditya commented Oct 17, 2024

Use auto ops service PR #196312

@neptunian neptunian self-assigned this Oct 18, 2024
@ashokaditya
Copy link
Member

ashokaditya commented Oct 25, 2024

Handling errors PR #197056

@ashokaditya
Copy link
Member

ashokaditya commented Nov 7, 2024

Integration tests PR #197112

@ashokaditya
Copy link
Member

ashokaditya commented Nov 7, 2024

Unit tests PR #198007

@ashokaditya
Copy link
Member

Integration with auto ops PR #200192

@ashokaditya
Copy link
Member

Enable autoops on DEv+QA PR https://github.com/elastic/serverless-gitops/pull/5188
Update URL on kibana-controller PR https://github.com/elastic/kibana-controller/pull/483

@ashokaditya
Copy link
Member

UX/API changes PR #200911

@ashokaditya
Copy link
Member

feature flag PR #201465 (review)

@ashokaditya
Copy link
Member

UX/API date validations PR #201638

@ashokaditya
Copy link
Member

ashokaditya commented Nov 28, 2024

zero size data streams PR #201817

@ashokaditya
Copy link
Member

more valiadions PR https://github.com/elastic/kibana/pull/202182/files

@ashokaditya
Copy link
Member

error handlning index errors #203006

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

No branches or pull requests

7 participants