Skip to content

Commit 28d6f64

Browse files
authored
pipeline: filter: lua: add description about protected_mode (#303)
Signed-off-by: Takahiro YAMASHITA <nokute78@gmail.com>
1 parent 7343ee6 commit 28d6f64

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

pipeline/filters/lua.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The plugin supports the following configuration parameters:
1616
| Script | Path to the Lua script that will be used. |
1717
| Call | Lua function name that will be triggered to do filtering. It's assumed that the function is declared inside the Script defined above. |
1818
| Type\_int\_key | If these keys are matched, the fields are converted to integer. If more than one key, delimit by space |
19+
| Protected\_mode| If enabled, Lua script will be executed in protected mode. It prevents to crash when invalid Lua script is executed. Default is true.|
1920

2021
## Getting Started <a id="getting_started"></a>
2122

@@ -95,3 +96,7 @@ For functional examples of this interface, please refer to the code samples prov
9596

9697
In Lua, Fluent Bit treats number as double. It means an integer field \(e.g. IDs, log levels\) will be converted double. To avoid type conversion, **Type\_int\_key** property is available.
9798

99+
100+
### Protected Mode
101+
102+
Fluent Bit supports protected mode to prevent crash when executes invalid Lua script. See also [Error Handling in Application Code](https://www.lua.org/pil/24.3.1.html).

0 commit comments

Comments
 (0)