feat(auditserver): expose MatchFrame library API#28
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #28 +/- ##
==========================================
+ Coverage 96.07% 96.22% +0.15%
==========================================
Files 10 10
Lines 611 636 +25
==========================================
+ Hits 587 612 +25
Misses 19 19
Partials 5 5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
This pull request introduces a new library-mode API for evaluating audit log frames outside the event loop, and refactors the rule-group matching logic for improved testability and clarity. The main change is the addition of the
MatchFramemethod toAuditServer, which allows direct evaluation of raw audit log frames and returns detailed match results. The pull request also adds comprehensive documentation and tests for the new API.New library-mode API and documentation:
MatchFramemethod toAuditServer, enabling callers to evaluate raw audit log frames and receive a structuredMatchResultcontaining whether any rule group matched, the parsed log, and the names of matched groups.pkg/auditserver/doc.go, describing the library-mode usage and providing example code forMatchFrame.Refactoring and test coverage:
matchFramefunction, simplifying the event loop handling and improving separation of concerns. [1] [2]MatchFrame, covering matching, non-matching, error cases, multiple rule groups, and order preservation, as well as a usage example.MatchFrameto measure allocation and performance.