Skip to content

Commit

Permalink
update docs for wasm filter and exec wasi input plugin
Browse files Browse the repository at this point in the history
Signed-off-by: jiuxia211 <[email protected]>
  • Loading branch information
jiuxia211 committed Sep 1, 2024
1 parent f0eebd9 commit fffe648
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/fluentbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,7 @@ InputSpec defines the desired state of ClusterInput
| tcp | TCP defines the TCP input plugin configuration | *[input.TCP](plugins/input/tcp.md) |
| udp | UDP defines the UDP input plugin configuration | *[input.UDP](plugins/input/udp.md) |
| kubernetesEvents | KubernetesEvents defines the KubernetesEvents input plugin configuration | *[input.KubernetesEvents](plugins/input/kubernetesevents.md) |
| execWasi | ExecWasi defines the exec wasi input plugin configuration | *[input.ExecWasi](plugins/input/execwasi.md) |
| processors | Processors defines the processors configuration | *plugins.Config |

[Back to TOC](#table-of-contents)
Expand Down
7 changes: 3 additions & 4 deletions docs/plugins/fluentbit/filter/wasm.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# WASM
# Wasm

The Wasm Filter allows you to modify the incoming records using Wasm technology. <br /> **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/wasm**
Wasm Filter allows you to modify the incoming records using Wasm technology. **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/filters/wasm**


| Field | Description | Scheme |
| ----- | ----------- | ------ |
| wasmPath | Path to the built Wasm program that will be used. This can be a relative path against the main configuration file. | string |
| eventFormat | Define event format to interact with Wasm programs: msgpack or json. Default: json | string |
| functionName | Wasm function name that will be triggered to do filtering. It's assumed that the function is built inside the Wasm program specified above. | string |
| accessiblePaths | Specify the whitelist of paths to be able to access paths from WASM programs. | string |
| accessiblePaths | Specify the whitelist of paths to be able to access paths from WASM programs. | []string |
| wasmHeapSize | Size of the heap size of Wasm execution. Review unit sizes for allowed values. | string |
| wasmStackSize | Size of the stack size of Wasm execution. Review unit sizes for allowed values. | string |

16 changes: 16 additions & 0 deletions docs/plugins/fluentbit/input/exec_wasi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# ExecWasi

The exec_wasi input plugin, allows to execute WASM program that is WASI target like as external program and collects event logs from there. **For full documentation, refer to https://docs.fluentbit.io/manual/pipeline/inputs/exec-wasi**


| Field | Description | Scheme |
| ----- | ----------- | ------ |
| wasiPath | The place of a WASM program file. | string |
| parser | Specify the name of a parser to interpret the entry as a structured message. | string |
| accessiblePaths | Specify the whitelist of paths to be able to access paths from WASM programs. | []string |
| intervalSec | Polling interval (seconds). | *int32 |
| intervalNSec | Polling interval (nanoseconds). | *int64 |
| wasmHeapSize | | string |
| wasmStackSize | Size of the stack size of Wasm execution. Review unit sizes for allowed values. | string |
| bufSize | Size of the buffer (check unit sizes for allowed values) | string |
| threaded | Indicates whether to run this input in its own thread. Default: false. | *bool |

0 comments on commit fffe648

Please sign in to comment.