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
docs: pipeline: inputs: mem-metrics: fix formatting and style issues
- Fix 'Fluent Bit' casing (was 'fluent-bit') in body text
- Sort configuration parameters table alphabetically
- Fix classic config block indentation from 4 spaces to 2 spaces
- Fixed header for config param table
Applies to #1170
Signed-off-by: Eric D. Schabell <eric@schabell.org>
Copy file name to clipboardExpand all lines: pipeline/inputs/mem-metrics.md
+25-22Lines changed: 25 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,27 @@
1
1
# Memory metrics
2
2
3
-
The _mem_metrics_, or memory metrics plugin, generates metrics for memory statistics for processes using the `smaps_rollup` file for each process in /proc. This plugin works exclusively on Linux.
3
+
The `_mem_metrics_`, or memory metrics plugin, generates metrics for memory statistics for processes using the `smaps_rollup` file for each process in `/proc`. This plugin works exclusively on Linux.
|`proc_path`| The path of the proc pseudo filesystem. |`/proc`|
10
-
|`filter_exec`| Filter for a single executable by path. |**inactive**|
11
9
|`filter_cmd`| Filter by command line. |**inactive**|
12
-
|`filter_pid`| Filter by comma delimited list of PIDs. |**inactive**|
13
-
|`interval_sec`| Set the interval seconds between events generation. |`5`|
10
+
|`filter_exec`| Filter for a single executable by path. |**inactive**|
11
+
|`filter_pid`| Filter by comma delimited list of `PIDs`.|**inactive**|
14
12
|`interval_nsec`| Set the nanoseconds interval (sub seconds). |`0`|
13
+
|`interval_sec`| Set the interval seconds between events generation. |`5`|
14
+
|`proc_path`| The path of the proc pseudo filesystem. |`/proc`|
15
15
16
-
The `filter_pid` can include or be set to either `0` or `self` to refer to the fluent-bit process itself.
16
+
The `filter_pid` can include or be set to either `0` or `self` to refer to the Fluent Bit process itself.
17
17
18
18
## Get started
19
19
20
20
You can run the plugin from the command line or through a configuration file. By default metrics will be generated for all processes the current user can analyze.
21
21
22
22
### Command line
23
23
24
-
```bash
24
+
```shell
25
25
$ fluent-bit -i mem_metrics -o stdout
26
26
Fluent Bit v2.1.8
27
27
* Copyright (C) 2015-2022 The Fluent Bit Authors
@@ -55,36 +55,37 @@ Fluent Bit v2.1.8
55
55
56
56
Minimal pipeline for logging memory metrics to the console:
57
57
58
-
```ini
58
+
```text
59
59
[INPUT]
60
-
Name mem_metrics
61
-
Tag mem
60
+
Name mem_metrics
61
+
Tag mem
62
62
63
63
[OUTPUT]
64
-
Name stdout
65
-
Match mem
64
+
Name stdout
65
+
Match mem
66
66
```
67
67
68
68
Log all instances of Fluent Bit to Prometheus:
69
69
70
-
```ini
70
+
```text
71
71
[INPUT]
72
-
Name mem_metrics
73
-
Filter_cmd fluent-bit
74
-
Tag mem
72
+
Name mem_metrics
73
+
Filter_cmd fluent-bit
74
+
Tag mem
75
75
76
76
[OUTPUT]
77
-
Name prometheus_remote_write
78
-
Match mem
79
-
Host localhost
80
-
Port 9090
81
-
Uri /prometheus/v1/write?prometheus_server=mem
77
+
Name prometheus_remote_write
78
+
Match mem
79
+
Host localhost
80
+
Port 9090
81
+
Uri /prometheus/v1/write?prometheus_server=mem
82
82
```
83
83
84
84
### Exposed metrics
85
85
86
86
All metrics are logged as gauges since they can both increase and decrease. Supported gauges are:
87
87
88
+
```text
88
89
- node_smaps_rollup_rss
89
90
- node_smaps_rollup_pss
90
91
- type=clean
@@ -109,3 +110,5 @@ All metrics are logged as gauges since they can both increase and decrease. Supp
0 commit comments