Skip to content

out_plot: small updates to output plugin docs #2291

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 1 commit into from
Dec 12, 2025
Merged

out_plot: small updates to output plugin docs #2291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 9 additions & 7 deletions pipeline/outputs/plot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ description: Generate data file for GNU Plot

# 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`.
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 lets you export your telemetry data for visualization and analysis using `gnuplot`.

## Configuration parameters

This plugin supports the following parameters:

| 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_ |
| `File` | Set filename to store the records. If not set, the filename will be the `tag` associated with the records. If the file can't be opened, the plugin falls back to writing to STDOUT. | _none_ |
| `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 @@ timestamp value

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)
- `value` is the numeric value extracted from the specified key (or the first field if `Key` isn't specified)

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.
The plugin only supports numeric values (integers or floats). If the specified key isn't found or the value isn't numeric, an error is logged and the record is skipped.

## Get started

Expand Down Expand Up @@ -120,12 +120,14 @@ plot "cpu_data.dat" using 1:2 with lines title "CPU Usage"
gnuplot plot.gp
```

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

## Notes
{% hint style="info" %}

- 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.
- If the specified `Key` isn't found in a record, an error is logged and that record is skipped.
- 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.

{% endhint %}
Loading