[Security Solution] Detection Engine health API: cluster health endpoint #165602
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
banderror
added
release_note:skip
banderror
force-pushed
the
detection-engine-health-api-enhancements
branch
4 times, most recently
from
b0ae005 to
9953b1d
Compare
|
buildkite test this |
banderror
force-pushed
the
detection-engine-health-api-enhancements
branch
3 times, most recently
from
95c29ae to
0ccb716
Compare
banderror
changed the title
banderror
force-pushed
the
detection-engine-health-api-enhancements
branch
6 times, most recently
from
19a939d to
4ad9e6b
Compare
banderror
force-pushed
the
detection-engine-health-api-enhancements
branch
4 times, most recently
from
e4b5676 to
f698b49
Compare
banderror
force-pushed
the
detection-engine-health-api-enhancements
branch
from
f698b49 to
b1efca5
Compare
|
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
|
Pinging @elastic/security-solution (Team: SecuritySolution) |
banderror
commented
Oct 2, 2023
Comment on lines
+44
to
+46
| { term: { [f.EVENT_PROVIDER]: ALERTING_PROVIDER } }, | ||
| { term: { [f.EVENT_ACTION]: 'execute' } }, | ||
| { term: { [f.EVENT_CATEGORY]: 'siem' } }, |
There was a problem hiding this comment.
By adding { term: { [f.EVENT_CATEGORY]: 'siem' } } we make sure we don't aggregate those rules that are not detection rules.
banderror
commented
Oct 2, 2023
Comment on lines
+51
to
+55
| totalExecutions: { | ||
| cardinality: { | ||
| field: f.RULE_EXECUTION_UUID, | ||
| }, | ||
| }, |
There was a problem hiding this comment.
Moving this cardinality aggregation under executeEvents is also important to correctly calculate the number of executions of detection rules.
banderror
force-pushed
the
detection-engine-health-api-enhancements
branch
2 times, most recently
from
b322ff3 to
48224dc
Compare
banderror
force-pushed
the
detection-engine-health-api-enhancements
branch
from
48224dc to
93a67fb
Compare
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
nikitaindik
approved these changes
Oct 3, 2023
|
@elasticmachine merge upstream |
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: cc @banderror |
11 tasks
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.
Epic: #125642
Summary
This PR implements the
_clusterhealth endpoint. It returns the same metrics as the_spacehealth endpoint. The difference is that:_clusterhealth endpoint calculates its metrics on top of data from all Kibana spaces_spacehealth endpoint calculates its metrics on top of data from the current Kibana space (the one specified in the URL)Additionally, it fixes a few bugs in the existing health endpoints related to scoping. This PR ensures that we only aggregate detection rules in the saved objects and the
.kibana-event-log-*indices, and not any types of rules.RBAC
The
_clusterhealth endpoint can be called by any user with at least Read privilege to Security Solution.Documentation
I also updated the health API's README and added a new document describing what health data we return from what endpoints:
Checklist
Delete any items that are not applicable to this PR.