Skip to content

[8.x] [Streams 🌊] Introduce GroupStreams (#208126)#209871

Merged
simianhacker merged 3 commits intoelastic:8.xfrom
simianhacker:backport/8.x/pr-208126
Feb 6, 2025
Merged

[8.x] [Streams 🌊] Introduce GroupStreams (#208126)#209871
simianhacker merged 3 commits intoelastic:8.xfrom
simianhacker:backport/8.x/pr-208126

Conversation

@simianhacker
Copy link
Member

Backport

This will backport the following commits from main to 8.x:

Questions ?

Please refer to the Backport tool documentation

\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com//pull/208126","number":208126,"mergeCommit":{"message":"[Streams 🌊] Introduce GroupStreams (#208126)\n\n## 🍒 Summary\r\n \r\nThis PR adds support to `/api/streams` endpoints for the\r\n`GroupStreamDefinition` type. Group streams are simply a list of member\r\nstreams along with dashboards. An example of the definition looks like:\r\n\r\n```JSON\r\n{\r\n \"name\": \"nginx-logs\",\r\n \"stream\": {\r\n \"grouped\": {\r\n \"description\": \"A collection of streams for Nginx\",\r\n \"members\": [\r\n \"logs\",\r\n \"logs.nginx\"\r\n ]\r\n }\r\n },\r\n \"dashboards\": []\r\n}\r\n```\r\nThe following APIs support `GroupStreamDefinition`:\r\n\r\n- `GET /api/streams`\r\n- `GET /api/streams/{id}`\r\n- `PUT /api/streams/{id}`\r\n- `DELETE /api/streams/{id}`\r\n- `GET /api/streams/{id}/_details`\r\n\r\nThis PR only includes the support to the APIs, I will submit a follow PR\r\nfor the UI.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\r\nCo-authored-by: Joe Reuter ","sha":"2092c3d4ca2ae917420f992686fc7a704b393ea4"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->

## 🍒  Summary

This PR adds support to `/api/streams` endpoints for the
`GroupStreamDefinition` type. Group streams are simply a list of member
streams along with dashboards. An example of the definition looks like:

```JSON
{
  "name": "nginx-logs",
  "stream": {
    "grouped": {
      "description": "A collection of streams for Nginx",
      "members": [
        "logs",
        "logs.nginx"
      ]
    }
  },
  "dashboards": []
}
```
The following APIs support `GroupStreamDefinition`:

- `GET /api/streams`
- `GET /api/streams/{id}`
- `PUT /api/streams/{id}`
- `DELETE /api/streams/{id}`
- `GET /api/streams/{id}/_details`

This PR only includes the support to the APIs, I will submit a follow PR
for the UI.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Joe Reuter <johannes.reuter@elastic.co>
(cherry picked from commit 2092c3d)

# Conflicts:
#	api_docs/kbn_streams_schema.devdocs.json
@simianhacker simianhacker added the backport This PR is a backport of another PR label Feb 5, 2025
@simianhacker simianhacker enabled auto-merge (squash) February 5, 2025 18:45
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
streamsApp 291 294 +3

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/streams-schema 230 257 +27

Async chunks

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

id before after diff
streamsApp 283.0KB 283.9KB +836.0B

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id before after diff
@kbn/streams-schema 2 3 +1
Unknown metric groups

API count

id before after diff
@kbn/streams-schema 231 260 +29

@simianhacker simianhacker merged commit dd80846 into elastic:8.x Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport This PR is a backport of another PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants