Skip to content

Commit 0113141

Browse files
authored
Fixed typos, sorted config table, moved a config option from metrics table. Fixes #2233 (#2234)
* Added PID to vale styles. Part of #2233. Signed-off-by: Eric D. Schabell <[email protected]> * Fixed typos, sorted config table, moved a config option from metrics table. Fixes #2233. Signed-off-by: Eric D. Schabell <[email protected]> * Fixed review request gramatical. Signed-off-by: Eric D. Schabell <[email protected]> --------- Signed-off-by: Eric D. Schabell <[email protected]>
1 parent 9c28f9e commit 0113141

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

pipeline/inputs/cpu-metrics.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,35 @@ The CPU metrics plugin creates metrics that are log-based, such as JSON payload.
99
| Key | Description |
1010
|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1111
| `cpu_p` | CPU usage of the overall system, this value is the summation of time spent on user and kernel space. The result takes in consideration the numbers of CPU cores in the system. |
12-
| `user_p` | CPU usage in User mode, for short it means the CPU usage by user space programs. The result of this value takes in consideration the numbers of CPU cores in the system. |
1312
| `system_p` | CPU usage in Kernel mode, for short it means the CPU usage by the Kernel. The result of this value takes in consideration the numbers of CPU cores in the system. |
14-
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. |
13+
| `user_p` | CPU usage in User mode, for short it means the CPU usage by user space programs. The result of this value takes in consideration the numbers of CPU cores in the system. |
1514

1615
In addition to the keys reported in the previous table, a similar content is created per CPU core. The cores are listed from `0` to `N` as the Kernel reports:
1716

1817
| Key | Description |
1918
|:----------------|:-----------------------------------------------------------------------------|
2019
| `cpuN.p_cpu` | Represents the total CPU usage by core `N`. |
21-
| `cpuN.p_user` | Total CPU spent in user mode or user space programs associated to this core. |
2220
| `cpuN.p_system` | Total CPU spent in system or kernel mode associated to this core. |
21+
| `cpuN.p_user` | Total CPU spent in user mode or user space programs associated to this core. |
2322

2423
## Configuration parameters
2524

2625
The plugin supports the following configuration parameters:
2726

28-
| Key | Description | Default |
29-
|:---------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
30-
| `Interval_Sec` | Polling interval in seconds. | `1` |
31-
| `Interval_NSec | Polling interval in nanoseconds` | `0` |
32-
| `PID` | Specify the `ID` (`PID`) of a running process in the system. By default, the plugin monitors the whole system but if this option is set, it will only monitor the given process ID. | _none_ |
27+
| Key | Description | Default |
28+
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
29+
| `interval_nsec` | Polling interval in nanoseconds. | `0` |
30+
| `interval_sec` | Polling interval in seconds. | `1` |
31+
| `pid` | Specify the process ID (PID) of a running process in the system. By default, the plugin monitors the whole system but if this option is set, it will only monitor the given process ID. | _none_ |
32+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
3333

3434
## Get started
3535

36-
In order to get the statistics of the CPU usage of your system, you can run the plugin from the command line or through the configuration file:
36+
To get the statistics of the CPU usage of your system, you can run the plugin from the command line or through the configuration file:
3737

3838
### Command line
3939

40-
You can run this filter from the command line using a command like the following:
40+
You can run this input plugin from the command line using a command like the following:
4141

4242
```shell
4343
build/bin/fluent-bit -i cpu -t my_cpu -o stdout -m '*'

vale-styles/FluentBit/Acronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ exceptions:
9999
- PATH
100100
- PEM
101101
- PDF
102+
- PID
102103
- PHP
103104
- POSIX
104105
- POST

0 commit comments

Comments
 (0)