@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
md 160 lines 4.87 KB
Rendered Raw
1 <!--startmeta
2 custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/integrations/devstat.md"
3 meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/metadata.yaml"
4 sidebar_label: "devstat"
5 learn_status: "Published"
6 learn_rel_path: "Collecting Metrics/Collectors/Storage and Filesystems"
7 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
8 endmeta-->
9
10 # devstat
11
12
13 <img src="https://netdata.cloud/img/hard-drive.svg" width="150"/>
14
15
16 Plugin: freebsd.plugin
17 Module: devstat
18
19 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
21 ## Overview
22
23 Collect information per hard disk available on host.
24
25 The plugin calls `sysctl` 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 | enable new disks detected at runtime | Enable or disable possibility to detect new disks. | auto | no |
66 | performance metrics for pass devices | Enable or disable metrics for disks with type `PASS`. | auto | no |
67 | total bandwidth for all disks | Enable or disable total bandwidth metric for all disks. | yes | no |
68 | bandwidth for all disks | Enable or disable bandwidth for all disks metric. | auto | no |
69 | operations for all disks | Enable or disable operations for all disks metric. | auto | no |
70 | queued operations for all disks | Enable or disable queued operations for all disks metric. | auto | no |
71 | utilization percentage for all disks | Enable or disable utilization percentage for all disks metric. | auto | no |
72 | i/o time for all disks | Enable or disable I/O time for all disks metric. | auto | no |
73 | average completed i/o time for all disks | Enable or disable average completed I/O time for all disks metric. | auto | no |
74 | average completed i/o bandwidth for all disks | Enable or disable average completed I/O bandwidth for all disks metric. | auto | no |
75 | average service time for all disks | Enable or disable average service time for all disks metric. | auto | no |
76 | disable by default disks matching | Do not create charts for disks listed. | | no |
77
78
79 </details>
80
81
82
83 #### via File
84
85 The configuration file name for this integration is `netdata.conf`.
86 Configuration for this specific integration is located in the `[plugin:freebsd:kern.devstat]` section within that file.
87
88 The file format is a modified INI syntax. The general structure is:
89
90 ```ini
91 [section1]
92 option1 = some value
93 option2 = some other value
94
95 [section2]
96 option3 = some third value
97 ```
98 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
99 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
100
101 ```bash
102 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
103 sudo ./edit-config netdata.conf
104 ```
105
106 ##### Examples
107 There are no configuration examples.
108
109
110
111 ## Alerts
112
113
114 The following alerts are available:
115
116 | Alert name | On metric | Description |
117 |:------------|:----------|:------------|
118 | [ 10min_disk_utilization ](https://github.com/netdata/netdata/blob/master/src/health/health.d/disks.conf) | disk.util | average percentage of time ${label:device} disk was busy over the last 10 minutes |
119
120
121 ## Metrics
122
123 Metrics grouped by *scope*.
124
125 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
126
127
128
129 ### Per devstat instance
130
131 These metrics give a general vision about I/O events on disks.
132
133 This scope has no labels.
134
135 Metrics:
136
137 | Metric | Dimensions | Unit |
138 |:------|:----------|:----|
139 | system.io | io, out | KiB/s |
140
141 ### Per disk
142
143
144
145 This scope has no labels.
146
147 Metrics:
148
149 | Metric | Dimensions | Unit |
150 |:------|:----------|:----|
151 | disk.io | reads, writes, frees | KiB/s |
152 | disk.ops | reads, writes, other, frees | operations/s |
153 | disk.qops | operations | operations |
154 | disk.util | utilization | % of time working |
155 | disk.iotime | reads, writes, other, frees | milliseconds/s |
156 | disk.await | reads, writes, other, frees | milliseconds/operation |
157 | disk.avgsz | reads, writes, frees | KiB/operation |
158 | disk.svctm | svctm | milliseconds/operation |
159
160