@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 134 lines 3.34 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/integrations/vm.vmtotal.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/metadata.yaml"
4 sidebar_label: "vm.vmtotal"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Operating Systems"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 endmeta-->
9
10 # vm.vmtotal
11
12
13 <img src="https://netdata.cloud/img/memory.svg" width="150"/>
14
15
16 Plugin: freebsd.plugin
17 Module: vm.vmtotal
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 Collect Virtual Memory information from host.
24
25 The plugin calls function `sysctl` to collect data.
26
27 This collector is supported on all platforms.
28
29 This collector supports collecting metrics from multiple instances of this integration, including remote instances.
30
31
32 ### Default Behavior
33
34 #### Auto-Detection
35
36 This integration doesn't support auto-detection.
37
38 #### Limits
39
40 The default configuration for this integration does not impose any limits on data collection.
41
42 #### Performance Impact
43
44 The default configuration for this integration is not expected to impose a significant performance impact on the system.
45
46 ## Setup
47
48
49 ### Prerequisites
50
51 No action required.
52
53 ### Configuration
54
55 #### Options
56
57
58
59 <details open><summary>Config Options</summary>
60
61
62
63 | Option | Description | Default | Required |
64 |:-----|:------------|:--------|:---------:|
65 | enable total processes | Number of active processes. | yes | no |
66 | processes running | Show number of processes running or blocked. | yes | no |
67 | real memory | Memeory used on host. | yes | no |
68
69
70 </details>
71
72
73
74 #### via File
75
76 The configuration file name for this integration is `netdata.conf`.
77 Configuration for this specific integration is located in the `[plugin:freebsd:vm.vmtotal]` section within that file.
78
79 The file format is a modified INI syntax. The general structure is:
80
81 ```ini
82 [section1]
83 option1 = some value
84 option2 = some other value
85
86 [section2]
87 option3 = some third value
88 ```
89 You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
90 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
91
92 ```bash
93 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
94 sudo ./edit-config netdata.conf
95 ```
96
97 ##### Examples
98 There are no configuration examples.
99
100
101
102 ## Alerts
103
104
105 The following alerts are available:
106
107 | Alert name | On metric | Description |
108 |:------------|:----------|:------------|
109 | [ active_processes ](https://github.com/netdata/netdata/blob/master/src/health/health.d/processes.conf) | system.active_processes | system process IDs (PID) space utilization |
110
111
112 ## Metrics
113
114 Metrics grouped by *scope*.
115
116 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
117
118
119
120 ### Per vm.vmtotal instance
121
122 These metrics show an overall vision about processes running.
123
124 This scope has no labels.
125
126 Metrics:
127
128 | Metric | Dimensions | Unit |
129 |:------|:----------|:----|
130 | system.active_processes | active | processes |
131 | system.processes | running, blocked | processes |
132 | mem.real | used | MiB |
133
134