Skip to content

Commit 3ad93a0

Browse files
eschabelleschabell
authored
Updated exec input plugin doc config parameter table and general standardization. Fixes #2249. (#2250)
* Updated exec input pluing doc config parameter table and general standardization. Fixes #2249. Signed-off-by: Eric D. Schabell <[email protected]> * Grammer change per reviewer request. Signed-off-by: Eric D. Schabell <[email protected]> * Grammer change per reviewer request. Signed-off-by: Eric D. Schabell <[email protected]> --------- Signed-off-by: Eric D. Schabell <[email protected]>
1 parent d96332f commit 3ad93a0

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

‎pipeline/inputs/exec.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ The debug images use the same binaries so even though they have a shell, there i
1818

1919
The plugin supports the following configuration parameters:
2020

21-
| Key | Description |
22-
|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
23-
| `Command` | The command to execute, passed to [popen](https://man7.org/linux/man-pages/man3/popen.3.html) without any additional escaping or processing. Can include pipelines, redirection, command-substitution, or other information. |
24-
| `Parser` | Specify the name of a parser to interpret the entry as a structured message. |
25-
| `Interval_Sec` | Polling interval (seconds). |
26-
| `Interval_NSec` | Polling interval (nanosecond). |
27-
| `Buf_Size` | Size of the buffer. See [unit sizes](../../administration/configuring-fluent-bit.md#unit-sizes) for allowed values. |
28-
| `Oneshot` | Only run once at startup. This allows collection of data precedent to Fluent Bit startup (Boolean, default: `false`). |
29-
| `Exit_After_Oneshot` | Exit as soon as the one-shot command exits. This allows the `exec` plugin to be used as a wrapper for another command, sending the target command's output to any Fluent Bit sink, then exits. (Boolean, default: `false`). |
30-
| `Propagate_Exit_Code` | When exiting due to `Exit_After_Oneshot`, cause Fluent Bit to exit with the exit code of the command exited by this plugin. Follows [shell conventions for exit code propagation](https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html). (Boolean, default: `false`). |
31-
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. |
21+
| Key | Description | Default |
22+
|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
23+
| `buf_size` | Size of the buffer. See [unit sizes](../../administration/configuring-fluent-bit.md#unit-sizes) for allowed values. | `4096` |
24+
| `command` | The command to execute, passed to [popen](https://man7.org/linux/man-pages/man3/popen.3.html) without any additional escaping or processing. Can include pipelines, redirection, command-substitution, or other information. | _none_ |
25+
| `exit_after_oneshot` | Exit as soon as the one-shot command exits. This allows the `exec` plugin to be used as a wrapper for another command, sending the target command's output to any Fluent Bit sink, then exits. When enabled, `oneshot` is automatically set to `true`. | `false` |
26+
| `interval_nsec` | Polling interval (nanoseconds). | `0` |
27+
| `interval_sec` | Polling interval (seconds). | `1` |
28+
| `oneshot` | Only run once at startup. This allows collection of data before to Fluent Bit startup. | `false` |
29+
| `parser` | Specify the name of a parser to interpret the entry as a structured message. | _none_ |
30+
| `propagate_exit_code` | Cause Fluent Bit to exit with the exit code of the command exited by this plugin. Follows [shell conventions for exit code propagation](https://www.gnu.org/software/bash/manual/html_node/Exit-Status.html). Requires `exit_after_oneshot=true`. | `false` |
31+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
3232

3333
## Get started
3434

@@ -102,7 +102,7 @@ pipeline:
102102

103103
## Use as a command wrapper
104104

105-
To use Fluent Bit with the `exec` plugin to wrap another command, use the `Exit_After_Oneshot` and `Propagate_Exit_Code` options:
105+
To use Fluent Bit with the `exec` plugin to wrap another command, use the `exit_after_oneshot` and `propagate_exit_code` options:
106106

107107
{% tabs %}
108108
{% tab title="fluent-bit.yaml" %}
@@ -165,7 +165,7 @@ Translation of command exit codes to Fluent Bit exit code follows [the usual she
165165

166166
### Parsing command output
167167

168-
By default, the `exec` plugin emits one message per command output line, with a single field `exec` containing the full message. Use the `Parser` directive to specify the name of a parser configuration to use to process the command input.
168+
By default, the `exec` plugin emits one message per command output line, with a single field `exec` containing the full message. Use the `parser` option to specify the name of a parser configuration to use to process the command input.
169169

170170
### Security concerns
171171

0 commit comments

Comments
 (0)