Skip to content

pipeline: outputs: standard-output: general cleanup #1989

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.

Sign up for GitHub

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 2 commits into from
Jul 23, 2025
Merged

pipeline: outputs: standard-output: general cleanup #1989

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d201939
pipeline: outputs: standard-output: general cleanup
alexakreizinger Jul 23, 2025
66efcb2
Apply suggestions from code review
alexakreizinger Jul 23, 2025
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
28 changes: 15 additions & 13 deletions pipeline/outputs/standard-output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# Standard Output
# Standard output

The **stdout** output plugin allows to print to the standard output the data received through the _input_ plugin. Their usage is very simple as follows:
<!-- vale FluentBit.Repetition = NO -->

## Configuration Parameters
The _standard output_ output plugin prints ingested data to standard output.

| Key | Description | default |
|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
| Format | Specify the data format to be printed. Supported formats are _msgpack_, _json_, _json\_lines_ and _json\_stream_. | msgpack |
| json\_date\_key | Specify the name of the time key in the output record. To disable the time key just set the value to `false`. | date |
| json\_date\_format | Specify the format of the date. Supported formats are _double_, _epoch_, _iso8601_ (eg: _2018-05-30T09:39:52.000681Z_) and _java_sql_timestamp_ (eg: _2018-05-30 09:39:52.000681_) | double |
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |
<!-- vale FluentBit.Repetition = YES -->

### Command Line
## Configuration parameters

| Key | Description | Default |
| --- | ----------- | ------- |
| `Format` | Specify the data format to be printed. Supported formats are `msgpack`, `json`, `json_lines` and `json_stream`. | `msgpack` |
| `json_date_key`| Specify the name of the time key in the output record. To disable the time key set the value to `false`. | `date` |
| `json_date_format` | Specify the format of the date. Supported formats are `double`, `epoch`, `iso8601` (for example, `2018-05-30T09:39:52.000681Z`) and `java_sql_timestamp` (for example, `2018-05-30 09:39:52.000681`). | `double` |
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |

### Command line

```shell
fluent-bit -i cpu -o stdout -v
```

We have specified to gather [CPU](https://github.com/fluent/fluent-bit-docs/tree/ddc1cf3d996966b9db39f8784596c8b7132b4d5b/pipeline/input/cpu.md) usage metrics and print them out to the standard output in a human-readable way:
This example directs the plugin to gather [CPU](https://github.com/fluent/fluent-bit-docs/tree/ddc1cf3d996966b9db39f8784596c8b7132b4d5b/pipeline/input/cpu.md) usage metrics and print them out to the standard output in a human-readable way:

```shell
$ fluent-bit -i cpu -o stdout -p format=msgpack -v
Expand All @@ -29,5 +33,3 @@ $ fluent-bit -i cpu -o stdout -p format=msgpack -v
[3] cpu.0: [1475898724, {"cpu_p"=>1.000000, "user_p"=>0.750000, "system_p"=>0.250000, "cpu0.p_cpu"=>1.000000, "cpu0.p_user"=>1.000000, "cpu0.p_system"=>0.000000, "cpu1.p_cpu"=>2.000000, "cpu1.p_user"=>1.000000, "cpu1.p_system"=>1.000000, "cpu2.p_cpu"=>1.000000, "cpu2.p_user"=>1.000000, "cpu2.p_system"=>0.000000, "cpu3.p_cpu"=>1.000000, "cpu3.p_user"=>1.000000, "cpu3.p_system"=>0.000000}]
...
```

No more, no less, it just works.