@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
md 130 lines 3.05 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/integrations/vm.swap_info.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/metadata.yaml"
4 sidebar_label: "vm.swap_info"
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.swap_info
11
12
13 <img src="https://netdata.cloud/img/freebsd.svg" width="150"/>
14
15
16 Plugin: freebsd.plugin
17 Module: vm.swap_info
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 Collect information about SWAP memory.
24
25 The plugin calls `sysctlnametomib` function to collect necessary 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 | vm.swap_info | Enable or disable SWAP metrics. | yes | no |
66
67
68 </details>
69
70
71
72 #### via File
73
74 The configuration file name for this integration is `netdata.conf`.
75 Configuration for this specific integration is located in the `[plugin:freebsd]` section within that file.
76
77 The file format is a modified INI syntax. The general structure is:
78
79 ```ini
80 [section1]
81 option1 = some value
82 option2 = some other value
83
84 [section2]
85 option3 = some third value
86 ```
87 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
88 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
89
90 ```bash
91 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
92 sudo ./edit-config netdata.conf
93 ```
94
95 ##### Examples
96 There are no configuration examples.
97
98
99
100 ## Alerts
101
102
103 The following alerts are available:
104
105 | Alert name | On metric | Description |
106 |:------------|:----------|:------------|
107 | [ used_swap ](https://github.com/netdata/netdata/blob/master/src/health/health.d/swap.conf) | mem.swap | swap memory utilization |
108
109
110 ## Metrics
111
112 Metrics grouped by *scope*.
113
114 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
115
116
117
118 ### Per vm.swap_info instance
119
120 This metric shows the SWAP usage.
121
122 This scope has no labels.
123
124 Metrics:
125
126 | Metric | Dimensions | Unit |
127 |:------|:----------|:----|
128 | mem.swap | free, used | MiB |
129
130