[EDR Workflows] Endpoint Insights API #201521
Merged
+1,398
−9
Conversation
This file contains 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
Adds an SecurityConfigurationInsightsService that is setup during security solution plugin initialization. The service setup installs the component templates, index template, and datastream used by the service.
szwarckonrad
added
release_note:skip
…nto feature/endpoint-insights-api
Add create, update, and fetch methods for the SecurityWorkflowInsightsService.
… into feature/endpoint-insights-api
Add create, update, and fetch methods for the SecurityWorkflowInsightsService.
… into feature/endpoint-insights-api
szwarckonrad
added
backport:prev-minor
joeypoon
approved these changes
Dec 3, 2024
gergoabraham
approved these changes
Dec 4, 2024
x-pack/plugins/security_solution/common/api/endpoint/workflow_insights/workflow_insights.ts
Outdated
Show resolved
Hide resolved
.../server/assistant/tools/defend_insights/workflow_insights_builders/incompatible_antivirus.ts
Outdated
Show resolved
Hide resolved
x-pack/plugins/security_solution/server/endpoint/routes/workflow_insights/update_insight.ts
Show resolved
Hide resolved
tomsonpl
approved these changes
Dec 4, 2024
| minLength: 1, | ||
| validate: (id) => { | ||
| if (id.trim() === '') { | ||
| return `${field} can not be an empty string`; |
| minLength: 1, | ||
| validate: (id) => { | ||
| if (id.trim() === '') { | ||
| return 'insightId can not be an empty string'; |
| }, | ||
| }), | ||
| }), | ||
| body: schema.object({ |
There was a problem hiding this comment.
is this hitting our internal API? Do you think it makes sense to enable accepting unknown values too?
There was a problem hiding this comment.
I don’t see the need for it at the moment
|
|
||
| // ensure it waits for initialization first | ||
| expect(isInitializedSpy).toHaveBeenCalledTimes(1); | ||
| // updates the doc | ||
| expect(esClient.update).toHaveBeenCalledTimes(1); | ||
| expect(esClient.update).toHaveBeenCalledWith({ | ||
| index: DATA_STREAM_NAME, | ||
| index: indexName, |
There was a problem hiding this comment.
is this one different from DATA_STREAM_NAME that is still being used eg in line 213?
There was a problem hiding this comment.
The test on line 213 uses the data stream name, but the update method requires the name of the backing index, not the data stream itself.
|
Starting backport for target branches: 8.x https://github.com/elastic/kibana/actions/runs/12164140572 |
💚 Build Succeeded
Metrics [docs]
History
|
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Dec 4, 2024
### Summary
This PR introduces two internal API routes:
1. `/internal/api/endpoint/workflow_isnights`
2. `/internal/api/endpoint/workflow_isnights/{insightId}`
### Details
- The first route (`/internal/api/endpoint/workflow_isnights`) will be
used with the `securityWorkflowInsightsService.fetch` method to retrieve
stored insights.
- The second route
(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with
the `securityWorkflowInsightsService.update` method to update existing
insights.
---------
Co-authored-by: Joey F. Poon <[email protected]>
(cherry picked from commit 065738b)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Dec 4, 2024
# Backport This will backport the following commits from `main` to `8.x`: - [[EDR Workflows] Endpoint Insights API (#201521)](#201521) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Konrad Szwarc","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-04T16:31:54Z","message":"[EDR Workflows] Endpoint Insights API (#201521)\n\n### Summary\n\nThis PR introduces two internal API routes:\n\n1. `/internal/api/endpoint/workflow_isnights` \n2. `/internal/api/endpoint/workflow_isnights/{insightId}` \n\n### Details\n\n- The first route (`/internal/api/endpoint/workflow_isnights`) will be\nused with the `securityWorkflowInsightsService.fetch` method to retrieve\nstored insights.\n- The second route\n(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with\nthe `securityWorkflowInsightsService.update` method to update existing\ninsights.\n\n---------\n\nCo-authored-by: Joey F. Poon <[email protected]>","sha":"065738bd110c4eb85c131f089d3b308d8b1dec6d","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Defend Workflows","backport:prev-minor","v8.18.0"],"title":"[EDR Workflows] Endpoint Insights API","number":201521,"url":"https://github.com/elastic/kibana/pull/201521","mergeCommit":{"message":"[EDR Workflows] Endpoint Insights API (#201521)\n\n### Summary\n\nThis PR introduces two internal API routes:\n\n1. `/internal/api/endpoint/workflow_isnights` \n2. `/internal/api/endpoint/workflow_isnights/{insightId}` \n\n### Details\n\n- The first route (`/internal/api/endpoint/workflow_isnights`) will be\nused with the `securityWorkflowInsightsService.fetch` method to retrieve\nstored insights.\n- The second route\n(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with\nthe `securityWorkflowInsightsService.update` method to update existing\ninsights.\n\n---------\n\nCo-authored-by: Joey F. Poon <[email protected]>","sha":"065738bd110c4eb85c131f089d3b308d8b1dec6d"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/201521","number":201521,"mergeCommit":{"message":"[EDR Workflows] Endpoint Insights API (#201521)\n\n### Summary\n\nThis PR introduces two internal API routes:\n\n1. `/internal/api/endpoint/workflow_isnights` \n2. `/internal/api/endpoint/workflow_isnights/{insightId}` \n\n### Details\n\n- The first route (`/internal/api/endpoint/workflow_isnights`) will be\nused with the `securityWorkflowInsightsService.fetch` method to retrieve\nstored insights.\n- The second route\n(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with\nthe `securityWorkflowInsightsService.update` method to update existing\ninsights.\n\n---------\n\nCo-authored-by: Joey F. Poon <[email protected]>","sha":"065738bd110c4eb85c131f089d3b308d8b1dec6d"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Konrad Szwarc <[email protected]>
SoniaSanzV
pushed a commit
to SoniaSanzV/kibana
that referenced
this pull request
Dec 9, 2024
### Summary
This PR introduces two internal API routes:
1. `/internal/api/endpoint/workflow_isnights`
2. `/internal/api/endpoint/workflow_isnights/{insightId}`
### Details
- The first route (`/internal/api/endpoint/workflow_isnights`) will be
used with the `securityWorkflowInsightsService.fetch` method to retrieve
stored insights.
- The second route
(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with
the `securityWorkflowInsightsService.update` method to update existing
insights.
---------
Co-authored-by: Joey F. Poon <[email protected]>
SoniaSanzV
pushed a commit
to SoniaSanzV/kibana
that referenced
this pull request
Dec 9, 2024
### Summary
This PR introduces two internal API routes:
1. `/internal/api/endpoint/workflow_isnights`
2. `/internal/api/endpoint/workflow_isnights/{insightId}`
### Details
- The first route (`/internal/api/endpoint/workflow_isnights`) will be
used with the `securityWorkflowInsightsService.fetch` method to retrieve
stored insights.
- The second route
(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with
the `securityWorkflowInsightsService.update` method to update existing
insights.
---------
Co-authored-by: Joey F. Poon <[email protected]>
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this pull request
Dec 9, 2024
### Summary
This PR introduces two internal API routes:
1. `/internal/api/endpoint/workflow_isnights`
2. `/internal/api/endpoint/workflow_isnights/{insightId}`
### Details
- The first route (`/internal/api/endpoint/workflow_isnights`) will be
used with the `securityWorkflowInsightsService.fetch` method to retrieve
stored insights.
- The second route
(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with
the `securityWorkflowInsightsService.update` method to update existing
insights.
---------
Co-authored-by: Joey F. Poon <[email protected]>
Samiul-TheSoccerFan
pushed a commit
to Samiul-TheSoccerFan/kibana
that referenced
this pull request
Dec 10, 2024
### Summary
This PR introduces two internal API routes:
1. `/internal/api/endpoint/workflow_isnights`
2. `/internal/api/endpoint/workflow_isnights/{insightId}`
### Details
- The first route (`/internal/api/endpoint/workflow_isnights`) will be
used with the `securityWorkflowInsightsService.fetch` method to retrieve
stored insights.
- The second route
(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with
the `securityWorkflowInsightsService.update` method to update existing
insights.
---------
Co-authored-by: Joey F. Poon <[email protected]>
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this pull request
Dec 12, 2024
### Summary
This PR introduces two internal API routes:
1. `/internal/api/endpoint/workflow_isnights`
2. `/internal/api/endpoint/workflow_isnights/{insightId}`
### Details
- The first route (`/internal/api/endpoint/workflow_isnights`) will be
used with the `securityWorkflowInsightsService.fetch` method to retrieve
stored insights.
- The second route
(`/internal/api/endpoint/workflow_isnights/{insightId}`) will work with
the `securityWorkflowInsightsService.update` method to update existing
insights.
---------
Co-authored-by: Joey F. Poon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR introduces two internal API routes:
/internal/api/endpoint/workflow_isnights/internal/api/endpoint/workflow_isnights/{insightId}Details
/internal/api/endpoint/workflow_isnights) will be used with thesecurityWorkflowInsightsService.fetchmethod to retrieve stored insights./internal/api/endpoint/workflow_isnights/{insightId}) will work with thesecurityWorkflowInsightsService.updatemethod to update existing insights.