You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: pipeline/outputs/plot.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,15 @@ description: Generate data file for GNU Plot
4
4
5
5
# Plot
6
6
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`.
8
8
9
9
## Configuration parameters
10
10
11
11
This plugin supports the following parameters:
12
12
13
13
| Key | Description | Default |
14
14
|:--- |:----------- |:------- |
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_|
16
16
|`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_|
17
17
18
18
## Output format
@@ -27,9 +27,9 @@ timestamp value
27
27
28
28
Where:
29
29
-`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)
31
31
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.
33
33
34
34
## Get started
35
35
@@ -120,12 +120,14 @@ plot "cpu_data.dat" using 1:2 with lines title "CPU Usage"
120
120
gnuplot plot.gp
121
121
```
122
122
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.
124
124
125
-
## Notes
125
+
{% hint style="info" %}
126
126
127
127
- The `Key` parameter is optional. If not specified, the plugin uses the first field from the record.
128
128
- 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.
130
130
- If the output file can't be opened (for example, due to permissions), the plugin automatically falls back to writing to STDOUT.
131
131
- The output file is opened in append mode, so new data is added to existing files.
0 commit comments