Skip to content

feat(streams): add significant events and queries API #216221

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

Merged
kdelemme merged 44 commits into from
Apr 7, 2025
Merged

feat(streams): add significant events and queries API #216221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
ef5c2ef
[Significant events] Link queries to streams
dgieselaar Mar 18, 2025
a3844f0
Add sig events tests
kdelemme Mar 19, 2025
b09d1df
poc: execute saved queries and return occurrences
kdelemme Mar 20, 2025
1882b0d
poc: execute saved queries and return occurrences
kdelemme Mar 20, 2025
f70cc05
Add basic table with significant events
kdelemme Mar 20, 2025
d8ff2fd
Handle empty query assets
kdelemme Mar 20, 2025
81b3b00
Add date picker
kdelemme Mar 20, 2025
53de6f4
Add change point detection
kdelemme Mar 21, 2025
7569e2f
Use similar approach as dashboard
kdelemme Mar 25, 2025
20a1472
Add /queries API
kdelemme Mar 25, 2025
5f9f84d
Add empty change_points
kdelemme Mar 25, 2025
19c73d3
Add queries api tests
kdelemme Mar 25, 2025
29e43c7
Extract significant events service from route
kdelemme Mar 27, 2025
c6a5a9e
Merge branch 'main' into significant-events-api
kdelemme Mar 27, 2025
276d97d
reset UI work
kdelemme Mar 27, 2025
3e6cc0f
[CI] Auto-commit changed files from 'node scripts/styled_components_m…
kibanamachine Mar 27, 2025
444f320
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Mar 27, 2025
3b4ec64
Fix content routes usage of dashboard asset types
kdelemme Mar 27, 2025
87cf396
Fix type in dashboard suggestion route
kdelemme Mar 27, 2025
bb4d0b5
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Mar 27, 2025
586a713
fix type
kdelemme Mar 27, 2025
7adaf74
fix type
kdelemme Mar 27, 2025
e83528b
Revert BooleanFromString zod type
kdelemme Mar 28, 2025
1cbfc12
throws 404 on deleting asset not found
kdelemme Mar 28, 2025
f3aafad
Make discoverPlugin required
kdelemme Mar 28, 2025
1d58402
fix type
kdelemme Mar 28, 2025
d4435c1
Move dateFromString to zod-helper plugin
kdelemme Mar 28, 2025
bf56029
[CI] Auto-commit changed files from 'node scripts/styled_components_m…
kibanamachine Mar 28, 2025
29fe474
Remove significant events tab
kdelemme Mar 31, 2025
cc2aa4d
Remove artifact from initial branch
kdelemme Mar 31, 2025
b2637c8
Merge branch 'main' into significant-events-api
kdelemme Mar 31, 2025
ddc124f
Merge branch 'main' into significant-events-api
kdelemme Apr 1, 2025
2d59f18
fix type
kdelemme Apr 1, 2025
3287983
Merge branch 'main' into significant-events-api
kdelemme Apr 1, 2025
512e56e
fix type
kdelemme Apr 2, 2025
92aa5f1
Use z.coerce.date
kdelemme Apr 4, 2025
8af8af8
Merge branch 'main' into significant-events-api
kdelemme Apr 4, 2025
68497eb
[CI] Auto-commit changed files from 'node scripts/styled_components_m…
kibanamachine Apr 4, 2025
44202b3
Add zod date
kdelemme Apr 4, 2025
d79d6d4
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Apr 4, 2025
660c002
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Apr 4, 2025
0fc0c02
Fix type
kdelemme Apr 4, 2025
1e50ce9
Merge branch 'main' into significant-events-api
kdelemme Apr 4, 2025
94cee73
Merge branch 'main' into significant-events-api
elasticmachine Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
523 changes: 520 additions & 3 deletions oas_docs/bundle.json
View file
Open in desktop

Large diffs are not rendered by default.

523 changes: 520 additions & 3 deletions oas_docs/bundle.serverless.json
View file
Open in desktop

Large diffs are not rendered by default.

324 changes: 324 additions & 0 deletions oas_docs/output/kibana.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43064,8 +43064,37 @@ paths:
minLength: 1
type: string
type: array
queries:
items:
allOf:
- type: object
properties:
id:
minLength: 1
type: string
title:
minLength: 1
type: string
required:
- id
- title
- type: object
properties:
kql:
additionalProperties: false
type: object
properties:
query:
minLength: 1
type: string
required:
- query
required:
- kql
type: array
required:
- dashboards
- queries
- type: object
properties:
stream:
Expand Down Expand Up @@ -44124,8 +44153,37 @@ paths:
minLength: 1
type: string
type: array
queries:
items:
allOf:
- type: object
properties:
id:
minLength: 1
type: string
title:
minLength: 1
type: string
required:
- id
- title
- type: object
properties:
kql:
additionalProperties: false
type: object
properties:
query:
minLength: 1
type: string
required:
- query
required:
- kql
type: array
required:
- dashboards
- queries
- type: object
properties:
stream:
Expand Down Expand Up @@ -45037,8 +45095,37 @@ paths:
minLength: 1
type: string
type: array
queries:
items:
allOf:
- type: object
properties:
id:
minLength: 1
type: string
title:
minLength: 1
type: string
required:
- id
- title
- type: object
properties:
kql:
additionalProperties: false
type: object
properties:
query:
minLength: 1
type: string
required:
- query
required:
- kql
type: array
required:
- dashboards
- queries
- type: object
properties:
stream:
Expand Down Expand Up @@ -47480,6 +47567,243 @@ paths:
tags:
- streams
x-state: Technical Preview
/api/streams/{name}/queries:
get:
description: Fetches all queries linked to a stream that are visible to the current user in the current space.
operationId: get-streams-name-queries
parameters:
- in: path
name: name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
anyOf:
- additionalProperties: false
type: object
properties: {}
- enum:
- 'null'
nullable: true
- not: {}
responses: {}
summary: Get stream queries
tags:
- streams
x-state: Technical Preview
/api/streams/{name}/queries/_bulk:
post:
description: Bulk update queries of a stream. Can add new queries and delete existing ones.
operationId: post-streams-name-queries-bulk
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- in: path
name: name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
operations:
items:
anyOf:
- additionalProperties: false
type: object
properties:
index:
allOf:
- type: object
properties:
id:
minLength: 1
type: string
title:
minLength: 1
type: string
required:
- id
- title
- type: object
properties:
kql:
additionalProperties: false
type: object
properties:
query:
minLength: 1
type: string
required:
- query
required:
- kql
required:
- index
- additionalProperties: false
type: object
properties:
delete:
additionalProperties: false
type: object
properties:
id:
type: string
required:
- id
required:
- delete
type: array
required:
- operations
responses: {}
summary: Bulk update queries
tags:
- streams
x-state: Technical Preview
/api/streams/{name}/queries/{queryId}:
delete:
description: Remove a query from a stream. Noop if the query is not found on the stream.
operationId: delete-streams-name-queries-queryid
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- in: path
name: name
required: true
schema:
type: string
- in: path
name: queryId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
anyOf:
- additionalProperties: false
type: object
properties: {}
- enum:
- 'null'
nullable: true
- not: {}
responses: {}
summary: Remove a query from a stream
tags:
- streams
x-state: Technical Preview
put:
description: Adds a query to a stream. Noop if the query is already present on the stream.
operationId: put-streams-name-queries-queryid
parameters:
- description: A required header to protect against CSRF attacks
in: header
name: kbn-xsrf
required: true
schema:
example: 'true'
type: string
- in: path
name: name
required: true
schema:
type: string
- in: path
name: queryId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
kql:
additionalProperties: false
type: object
properties:
query:
minLength: 1
type: string
required:
- query
title:
minLength: 1
type: string
required:
- title
- kql
responses: {}
summary: Upsert a query to a stream
tags:
- streams
x-state: Technical Preview
/api/streams/{name}/significant_events:
get:
description: Read the significant events
operationId: get-streams-name-significant-events
parameters:
- in: path
name: name
required: true
schema:
type: string
- in: query
name: from
required: true
schema:
format: date-time
type: string
- in: query
name: to
required: true
schema:
format: date-time
type: string
- in: query
name: bucketSize
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
anyOf:
- additionalProperties: false
type: object
properties: {}
- enum:
- 'null'
nullable: true
- not: {}
responses: {}
summary: Read the significant events
tags:
- streams
x-state: Technical Preview
/api/task_manager/_health:
get:
description: |
Expand Down
Loading