[9.0] [Streams 🌊] Introduce GroupStreams (#208126)#209776
Merged
simianhacker merged 1 commit intoelastic:9.0from Feb 5, 2025
Merged
[9.0] [Streams 🌊] Introduce GroupStreams (#208126)#209776simianhacker merged 1 commit intoelastic:9.0from
simianhacker merged 1 commit intoelastic:9.0from
Conversation
## 🍒 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:
# x-pack/solutions/observability/plugins/streams_app/public/components/stream_detail_overview/index.tsx
# x-pack/solutions/observability/plugins/streams_app/public/components/stream_detail_view/index.tsx
# x-pack/test/api_integration/deployment_agnostic/apis/observability/streams/lifecycle.ts
tonyghiani
approved these changes
Feb 5, 2025
Contributor
💛 Build succeeded, but was flaky
Failed CI StepsTest Failures
Metrics [docs]Module Count
Public APIs missing comments
Async chunks
Public APIs missing exports
|
simianhacker
added a commit
that referenced
this pull request
Feb 6, 2025
# Backport This will backport the following commits from `main` to `8.x`: - [[Streams 🌊] Introduce GroupStreams (#208126)](#208126) <!--- Backport version: 9.6.4 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Chris Cowan","email":"chris@elastic.co"},"sourceCommit":{"committedDate":"2025-02-04T10:12:35Z","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 <johannes.reuter@elastic.co>","sha":"2092c3d4ca2ae917420f992686fc7a704b393ea4","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["v9.0.0","release_note:feature","backport:version","Feature:Streams","v9.1.0","v8.19.0"],"title":"[Streams 🌊] Introduce GroupStreams","number":208126,"url":"https://github.com/elastic/kibana/pull/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 <johannes.reuter@elastic.co>","sha":"2092c3d4ca2ae917420f992686fc7a704b393ea4"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/209776","number":209776,"state":"MERGED","mergeCommit":{"sha":"56e51b892b6fa6b21954afd61dd828cf80e1c262","message":"[9.0] [Streams 🌊] Introduce GroupStreams (#208126) (#209776)\n\n# Backport\n\nThis will backport the following commits from `main` to `9.0`:\n- [[Streams 🌊] Introduce GroupStreams\n(#208126)](https://github.com/elastic/kibana/pull/208126)\n\n<!--- Backport version: 9.6.4 -->\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n<!--BACKPORT [{\"author\":{\"name\":\"Chris\nCowan\",\"email\":\"chris@elastic.co\"},\"sourceCommit\":{\"committedDate\":\"2025-02-04T10:12:35Z\",\"message\":\"[Streams\n🌊] Introduce GroupStreams (#208126)\\n\\n## 🍒 Summary\\r\\n \\r\\nThis PR adds\nsupport to `/api/streams` endpoints for the\\r\\n`GroupStreamDefinition`\ntype. Group streams are simply a list of member\\r\\nstreams along with\ndashboards. An example of the definition looks\nlike:\\r\\n\\r\\n```JSON\\r\\n{\\r\\n \\\"name\\\": \\\"nginx-logs\\\",\\r\\n \\\"stream\\\":\n{\\r\\n \\\"grouped\\\": {\\r\\n \\\"description\\\": \\\"A collection of streams for\nNginx\\\",\\r\\n \\\"members\\\": [\\r\\n \\\"logs\\\",\\r\\n \\\"logs.nginx\\\"\\r\\n ]\\r\\n\n}\\r\\n },\\r\\n \\\"dashboards\\\": []\\r\\n}\\r\\n```\\r\\nThe following APIs\nsupport `GroupStreamDefinition`:\\r\\n\\r\\n- `GET /api/streams`\\r\\n- `GET\n/api/streams/{id}`\\r\\n- `PUT /api/streams/{id}`\\r\\n- `DELETE\n/api/streams/{id}`\\r\\n- `GET /api/streams/{id}/_details`\\r\\n\\r\\nThis PR\nonly includes the support to the APIs, I will submit a follow PR\\r\\nfor\nthe UI.\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<42973632+kibanamachine@users.noreply.github.com>\\r\\nCo-authored-by: Joe\nReuter\n<johannes.reuter@elastic.co>\",\"sha\":\"2092c3d4ca2ae917420f992686fc7a704b393ea4\",\"branchLabelMapping\":{\"^v9.1.0$\":\"main\",\"^v8.19.0$\":\"8.x\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"v9.0.0\",\"release_note:feature\",\"backport:version\",\"Feature:Streams\",\"v9.1.0\",\"v8.19.0\"],\"title\":\"[Streams\n🌊] Introduce\nGroupStreams\",\"number\":208126,\"url\":\"https://github.com/elastic/kibana/pull/208126\",\"mergeCommit\":{\"message\":\"[Streams\n🌊] Introduce GroupStreams (#208126)\\n\\n## 🍒 Summary\\r\\n \\r\\nThis PR adds\nsupport to `/api/streams` endpoints for the\\r\\n`GroupStreamDefinition`\ntype. Group streams are simply a list of member\\r\\nstreams along with\ndashboards. An example of the definition looks\nlike:\\r\\n\\r\\n```JSON\\r\\n{\\r\\n \\\"name\\\": \\\"nginx-logs\\\",\\r\\n \\\"stream\\\":\n{\\r\\n \\\"grouped\\\": {\\r\\n \\\"description\\\": \\\"A collection of streams for\nNginx\\\",\\r\\n \\\"members\\\": [\\r\\n \\\"logs\\\",\\r\\n \\\"logs.nginx\\\"\\r\\n ]\\r\\n\n}\\r\\n },\\r\\n \\\"dashboards\\\": []\\r\\n}\\r\\n```\\r\\nThe following APIs\nsupport `GroupStreamDefinition`:\\r\\n\\r\\n- `GET /api/streams`\\r\\n- `GET\n/api/streams/{id}`\\r\\n- `PUT /api/streams/{id}`\\r\\n- `DELETE\n/api/streams/{id}`\\r\\n- `GET /api/streams/{id}/_details`\\r\\n\\r\\nThis PR\nonly includes the support to the APIs, I will submit a follow PR\\r\\nfor\nthe UI.\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<42973632+kibanamachine@users.noreply.github.com>\\r\\nCo-authored-by: Joe\nReuter\n<johannes.reuter@elastic.co>\",\"sha\":\"2092c3d4ca2ae917420f992686fc7a704b393ea4\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[\"9.0\",\"8.x\"],\"targetPullRequestStates\":[{\"branch\":\"9.0\",\"label\":\"v9.0.0\",\"branchLabelMappingKey\":\"^v(\\\\d+).(\\\\d+).\\\\d+$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"},{\"branch\":\"main\",\"label\":\"v9.1.0\",\"branchLabelMappingKey\":\"^v9.1.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/208126\",\"number\":208126,\"mergeCommit\":{\"message\":\"[Streams\n🌊] Introduce GroupStreams (#208126)\\n\\n## 🍒 Summary\\r\\n \\r\\nThis PR adds\nsupport to `/api/streams` endpoints for the\\r\\n`GroupStreamDefinition`\ntype. Group streams are simply a list of member\\r\\nstreams along with\ndashboards. An example of the definition looks\nlike:\\r\\n\\r\\n```JSON\\r\\n{\\r\\n \\\"name\\\": \\\"nginx-logs\\\",\\r\\n \\\"stream\\\":\n{\\r\\n \\\"grouped\\\": {\\r\\n \\\"description\\\": \\\"A collection of streams for\nNginx\\\",\\r\\n \\\"members\\\": [\\r\\n \\\"logs\\\",\\r\\n \\\"logs.nginx\\\"\\r\\n ]\\r\\n\n}\\r\\n },\\r\\n \\\"dashboards\\\": []\\r\\n}\\r\\n```\\r\\nThe following APIs\nsupport `GroupStreamDefinition`:\\r\\n\\r\\n- `GET /api/streams`\\r\\n- `GET\n/api/streams/{id}`\\r\\n- `PUT /api/streams/{id}`\\r\\n- `DELETE\n/api/streams/{id}`\\r\\n- `GET /api/streams/{id}/_details`\\r\\n\\r\\nThis PR\nonly includes the support to the APIs, I will submit a follow PR\\r\\nfor\nthe UI.\\r\\n\\r\\n---------\\r\\n\\r\\nCo-authored-by: kibanamachine\n<42973632+kibanamachine@users.noreply.github.com>\\r\\nCo-authored-by: Joe\nReuter\n<johannes.reuter@elastic.co>\",\"sha\":\"2092c3d4ca2ae917420f992686fc7a704b393ea4\"}},{\"branch\":\"8.x\",\"label\":\"v8.19.0\",\"branchLabelMappingKey\":\"^v8.19.0$\",\"isSourceBranch\":false,\"state\":\"NOT_CREATED\"}]}]\nBACKPORT-->"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/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 <johannes.reuter@elastic.co>","sha":"2092c3d4ca2ae917420f992686fc7a704b393ea4"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: Milton Hultgren <milton.hultgren@elastic.co> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto9.0:Questions ?
Please refer to the Backport tool documentation