Skip to content

Commit 15fbd7e

Browse files
authored
out_plot: small updates to output plugin docs (#2291)
- Fix "let's" to "lets" (verb, not contraction) - Replace Notes heading with GitBook info hint block Fixes #2142. Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 4c66183 commit 15fbd7e

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

pipeline/outputs/plot.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ description: Generate data file for GNU Plot
44

55
# Plot
66

7-
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`.
7+
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`.
88

99
## Configuration parameters
1010

1111
This plugin supports the following parameters:
1212

1313
| Key | Description | Default |
1414
|:--- |:----------- |:------- |
15-
| `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_ |
15+
| `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_ |
1616
| `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_ |
1717

1818
## Output format
@@ -27,9 +27,9 @@ timestamp value
2727

2828
Where:
2929
- `timestamp` is a floating-point Unix timestamp
30-
- `value` is the numeric value extracted from the specified key (or the first field if `Key` is not specified)
30+
- `value` is the numeric value extracted from the specified key (or the first field if `Key` isn't specified)
3131

32-
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.
32+
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.
3333

3434
## Get started
3535

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

123-
This will generate a PNG image file showing the CPU usage over time.
123+
This will generate a `PNG` image file showing the CPU usage over time.
124124

125-
## Notes
125+
{% hint style="info" %}
126126

127127
- The `Key` parameter is optional. If not specified, the plugin uses the first field from the record.
128128
- Only numeric values (integers or floats) are supported. Non-numeric values will cause the record to be skipped with an error logged.
129-
- If the specified `Key` is not found in a record, an error is logged and that record is skipped.
129+
- If the specified `Key` isn't found in a record, an error is logged and that record is skipped.
130130
- If the output file can't be opened (for example, due to permissions), the plugin automatically falls back to writing to STDOUT.
131131
- The output file is opened in append mode, so new data is added to existing files.
132+
133+
{% endhint %}

0 commit comments

Comments
 (0)