Skip to content

filter_wasm: Add a description for event_format #1293

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.

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
merged 1 commit into from
Apr 17, 2024
Merged
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions pipeline/filters/wasm.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The plugin supports the following configuration parameters:
| Key | Description |
| :--- | :--- |
| Wasm\_Path | Path to the built Wasm program that will be used. This can be a relative path against the main configuration file. |
| Event\_Format | Define event format to interact with Wasm programs: msgpack or json. Default: json |
| Function\_Name | Wasm function name that will be triggered to do filtering. It's assumed that the function is built inside the Wasm program specified above. |
| Accessible\_Paths | Specify the whilelist of paths to be able to access paths from WASM programs. |

Expand All @@ -34,6 +35,7 @@ Here is a configuration example.
[FILTER]
Name wasm
Match dummy.*
Event_Format json # or msgpack
WASM_Path /path/to/wasm_program.wasm
Function_Name filter_function_name
Accessible_Paths .,/path/to/accessible
Expand Down