Skip to content

Added new entry for Plot output plugin doc. Fixes #2142. #2193

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
eschabell merged 8 commits into from
Nov 24, 2025
Merged

Added new entry for Plot output plugin doc. Fixes #2142. #2193

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
84265b1
Updated to include new input plugin doc for Windows System Statistics…
eschabell Nov 24, 2025
8b9641d
Updated to include new input plugin doc for Windows System Statistics…
eschabell Nov 24, 2025
2bdfa9a
Lint fix for winstat input plugin doc fix.
eschabell Nov 24, 2025
3144255
Merge branch 'fluent:master' into master
eschabell Nov 24, 2025
027c913
Added new Plot output plugin doc. Applies to #2142.
eschabell Nov 24, 2025
e4dc7ed
Added new entry for Plot output plugin doc. Applies to #2142.
eschabell Nov 24, 2025
6cca26c
Fixed linting issues for plot output plugin doc.
eschabell Nov 24, 2025
7184d48
Fixed linting issues for plot output plugin doc.
eschabell Nov 24, 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
Prev Previous commit
Fixed linting issues for plot output plugin doc. 
Signed-off-by: Eric D. Schabell <[email protected]>
  • Loading branch information
@eschabell
eschabell committed Nov 24, 2025
commit 7184d48d4883f0b838b0d7d059dfb2c6da5d831a
2 changes: 1 addition & 1 deletion pipeline/outputs/plot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Plot

The _Plot_ output plugin generates data files in a format compatible with [GNU Plot](http://www.gnuplot.info/) (`gnuplot`), a command-line graphing tool. This plugin allows you to export your telemetry data for visualization and analysis using `gnuplot`.

Check warning on line 7 in pipeline/outputs/plot.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.WordList] Use 'lets you' instead of 'allows you to'.

Raw Output:
{"message": "[FluentBit.WordList] Use 'lets you' instead of 'allows you to'.", "location": {"path": "pipeline/outputs/plot.md", "range": {"start": {"line": 7, "column": 167}}}, "severity": "INFO"}

## Configuration parameters

Expand All @@ -12,7 +12,7 @@

| Key | Description | Default |
|:--- |:----------- |:------- |
| `File` | Set filename to store the records. If not set, the filename will be the `tag` associated with the records. If the file cannot be opened, the plugin falls back to writing to STDOUT. | _none_ |

Check warning on line 15 in pipeline/outputs/plot.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.Contractions] Feel free to use 'can't' instead of 'cannot'.

Raw Output:
{"message": "[FluentBit.Contractions] Feel free to use 'can't' instead of 'cannot'.", "location": {"path": "pipeline/outputs/plot.md", "range": {"start": {"line": 15, "column": 131}}}, "severity": "INFO"}
| `Key` | Specify the key name from the record to extract as the value. The value must be a numeric type (integer or float). If not specified, the plugin uses the first field from the record. | _none_ |

## Output format
Expand All @@ -27,9 +27,9 @@

Where:
- `timestamp` is a floating-point Unix timestamp
- `value` is the numeric value extracted from the specified key (or the first field if `Key` is not specified)

Check warning on line 30 in pipeline/outputs/plot.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.Contractions] Feel free to use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[FluentBit.Contractions] Feel free to use 'isn't' instead of 'is not'.", "location": {"path": "pipeline/outputs/plot.md", "range": {"start": {"line": 30, "column": 94}}}, "severity": "INFO"}

The plugin only supports numeric values (integers or floats). If the specified key is not found or the value is not numeric, an error is logged and the record is skipped.

Check warning on line 32 in pipeline/outputs/plot.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.Contractions] Feel free to use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[FluentBit.Contractions] Feel free to use 'isn't' instead of 'is not'.", "location": {"path": "pipeline/outputs/plot.md", "range": {"start": {"line": 32, "column": 110}}}, "severity": "INFO"}

Check warning on line 32 in pipeline/outputs/plot.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.Contractions] Feel free to use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[FluentBit.Contractions] Feel free to use 'isn't' instead of 'is not'.", "location": {"path": "pipeline/outputs/plot.md", "range": {"start": {"line": 32, "column": 84}}}, "severity": "INFO"}

## Get started

Expand Down Expand Up @@ -101,7 +101,7 @@
1704067202.123456 28.7
```

2. Create a `gnuplot` script (e.g., `plot.gp`):
2. Create a `gnuplot` script (for example, `plot.gp`):

```text
set terminal png
Expand All @@ -120,12 +120,12 @@
gnuplot plot.gp
```

This will generate a PNG image file showing the CPU usage over time.

Check warning on line 123 in pipeline/outputs/plot.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.Acronyms] Spell out 'PNG', if it's unfamiliar to the audience.

Raw Output:
{"message": "[FluentBit.Acronyms] Spell out 'PNG', if it's unfamiliar to the audience.", "location": {"path": "pipeline/outputs/plot.md", "range": {"start": {"line": 123, "column": 22}}}, "severity": "INFO"}

## Notes

- The `Key` parameter is optional. If not specified, the plugin uses the first field from the record.
- Only numeric values (integers or floats) are supported. Non-numeric values will cause the record to be skipped with an error logged.
- If the specified `Key` is not found in a record, an error is logged and that record is skipped.

Check warning on line 129 in pipeline/outputs/plot.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.Contractions] Feel free to use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[FluentBit.Contractions] Feel free to use 'isn't' instead of 'is not'.", "location": {"path": "pipeline/outputs/plot.md", "range": {"start": {"line": 129, "column": 26}}}, "severity": "INFO"}
- If the output file can't be opened (for example, due to permissions), the plugin automatically falls back to writing to STDOUT.
- The output file is opened in append mode, so new data is added to existing files.