update(api): Add value offset support #103
Merged
Conversation
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
poiana
added
kind/feature
There was a problem hiding this comment.
Pull Request Overview
This PR extends the SDK's extraction API by adding support for a new field type, FieldMetaTypeSlice, which allows extractor plugins to report field metadata (i.e. the start and end positions of fields).
- Updated the extract request interface and its SetValue method to support a two-element uint32 pair for metadata.
- Added new symbols and tests in the info and extract test files to validate the metadata extraction capability.
- Enhanced the plugin Info structure and documentation to reflect the new metadata capability.
Reviewed Changes
Copilot reviewed 8 out of 15 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pkg/sdk/extract.go | Extended SetValue to support FieldMetaTypeSlice |
| pkg/sdk/symbols/info/info.go | Added get_extract_metadata_capability symbol |
| pkg/sdk/symbols/info/info_test.go | Added tests for extracting metadata capability |
| pkg/sdk/sdk.go | Defined new constant FieldMetaTypeSlice |
| pkg/sdk/extract_test.go | Added helper and tests for the metadata slice extraction |
| pkg/sdk/plugins/plugins.go | Updated Info struct to include metadata capability |
| pkg/sdk/symbols/doc.go | Updated documentation to list get_extract_metadata_capability |
Files not reviewed (7)
- Makefile: Language not supported
- pkg/loader/plugin_api_include.patch: Language not supported
- pkg/loader/plugin_loader.c: Language not supported
- pkg/loader/plugin_loader.h: Language not supported
- pkg/loader/strlcpy.patch: Language not supported
- pkg/sdk/plugin_types.h: Language not supported
- pkg/sdk/plugin_types_include.patch: Language not supported
Comments suppressed due to low confidence (1)
pkg/sdk/extract.go:362
- [nitpick] The panic message for unsupported lists of slices is terse. Consider enhancing it with additional context about the memory layout restriction that prevents lists of slices from being supported.
case FieldMetaTypeSlice:
|
/hold depend on falcosecurity/libs#2322 |
geraldcombs
force-pushed
the
slice-ftype
branch
12 times, most recently
from
3210c82 to
f1e688d
Compare
geraldcombs
force-pushed
the
slice-ftype
branch
4 times, most recently
from
3fb7eeb to
918aacb
Compare
geraldcombs
force-pushed
the
slice-ftype
branch
from
918aacb to
b36359e
Compare
geraldcombs
changed the title
geraldcombs
force-pushed
the
slice-ftype
branch
from
b36359e to
63792cd
Compare
geraldcombs
force-pushed
the
slice-ftype
branch
2 times, most recently
from
b919b5e to
b02a6c2
Compare
leogr
reviewed
May 29, 2025
geraldcombs
force-pushed
the
slice-ftype
branch
3 times, most recently
from
f334e6b to
41e2df3
Compare
Add support for setting value offsets during extraction. Signed-off-by: Gerald Combs <[email protected]>
Signed-off-by: Leonardo Grasso <[email protected]>
Signed-off-by: Leonardo Grasso <[email protected]>
Co-authored-by: Gerald Combs <[email protected]> Co-authored-by: Leonardo Di Giovanna <[email protected]> Signed-off-by: Leonardo Grasso <[email protected]>
Signed-off-by: Gerald Combs <[email protected]>
Signed-off-by: Gerald Combs <[email protected]>
leogr
reviewed
Jun 9, 2025
pkg/sdk/extract.go
Outdated
Comment on lines
185
to
186
| C.free(e.startArrayPtr) | ||
| C.free(e.lengthArrayPtr) |
There was a problem hiding this comment.
This is precisely what I wanted to do from the beginning. Unfortunately, it's not enough since memory is allocated multiple times here by calloc in plugin_extract_fields_sync() (which is invoked on every extraction request) and freed only once here (when the extractRequestPool gets cleaned up by plugin_close()).
Signed-off-by: Leonardo Grasso <[email protected]>
jasondellaluce
approved these changes
Jun 10, 2025
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: geraldcombs, jasondellaluce The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
LGTM label has been added. Git tree hash: 77cb41db82471aabc4a8ad85006dedb50bc2d0a0
|
|
/hold cancel |
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.
Add support for setting value offsets during extraction.
What type of PR is this?
/kind feature
Any specific area of the project related to this PR?
/area plugin-sdk
What this PR does / why we need it:
This makes it possible to extend extractor plugins so that they can provide the location of each field in each event or log message.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: