Update yaml description (diskspace) (#15527)
* diskspace_yaml: Update yaml description * Update collectors/diskspace.plugin/metadata.yaml Co-authored-by: Andrew Maguire <andrewm4894@gmail.com> * diskspace_yaml: Address suggestions --------- Co-authored-by: Shyam Sreevalsan <shyam@netdata.cloud> Co-authored-by: Andrew Maguire <andrewm4894@gmail.com>
thiagoftsm committed
Jul 26, 2023 at 07:29 UTC
b89a63731ff92df1747de70d169a060401cdce4f
1 file changed
+50
-11
collectors/diskspace.plugin/metadata.yaml
+50
-11
@@ -9,10 +9,16 @@ meta:
9
icon_filename: 'hard-drive.svg'
10
related_resources:
11
integrations:
12
- list: []
12
+ list: |
13
+ - plugin_name: ebpf.plugin
14
+ module_name: disk
15
info_provided_to_referring_integrations:
16
description: ''
15
- keywords: []
17
+ keywords: |
18
+ - disk
19
+ - I/O
20
+ - space
21
+ - inode
22
most_popular: false
23
overview:
24
data_collection:
@@ -26,7 +32,7 @@ overview:
32
description: ''
33
default_behavior:
34
auto_detection:
29
- description: ''
35
+ description: 'The plugin reads data from `/proc/self/mountinfo` and `/proc/diskstats file`.'
36
limits:
37
description: ''
38
performance_impact:
@@ -36,14 +42,47 @@ setup:
42
list: []
43
configuration:
44
file:
39
- name: ''
40
- description: ''
45
+ name: 'netdata.conf'
46
+ section_name: '[plugin:proc:diskspace]'
47
+ description: 'This is netdata main configuration file'
48
options:
42
- description: ''
49
+ description: 'You can also specify per mount point `[plugin:proc:diskspace:mountpoint]`'
50
folding:
44
- title: ''
51
+ title: 'Config options'
52
enabled: true
46
- list: []
53
+ list: |
54
+ - name: update every
55
+ description: Data collection frequency.
56
+ default_value: 1
57
+ required: false
58
+ - name: remove charts of unmounted disks
59
+ description: Remove chart when a device is unmounted on host.
60
+ default_value: yes
61
+ required: false
62
+ - name: check for new mount points every
63
+ description: Parse proc files frequency.
64
+ default_value: 15
65
+ required: false
66
+ - name: exclude space metrics on paths
67
+ description: Do not show metrics (charts) for listed paths. This option accepts netdata simple pattern.
68
+ default_value: /proc/* /sys/* /var/run/user/* /run/user/* /snap/* /var/lib/docker/*
69
+ required: false
70
+ - name: exclude space metrics on filesystems
71
+ description: Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern.
72
+ default_value: *gvfs *gluster* *s3fs *ipfs *davfs2 *httpfs *sshfs *gdfs *moosefs fusectl autofs
73
+ required: false
74
+ - name: exclude inode metrics on filesystems
75
+ description: Do not show metrics (charts) for listed filesystems. This option accepts netdata simple pattern.
76
+ default_value: msdosfs msdos vfat overlayfs aufs* *unionfs
77
+ required: false
78
+ - name: space usage for all disks
79
+ description: Define if plugin will show metrics for space usage. When value is set to `auto` plugin will try to access information to display if filesystem or path was not discarded with previous option.
80
+ default_value: auto
81
+ required: false
82
+ - name: inodes usage for all disks
83
+ description: Define if plugin will show metrics for inode usage. When value is set to `auto` plugin will try to access information to display if filesystem or path was not discarded with previous option.
84
+ default_value: auto
85
+ required: false
86
examples:
87
folding:
88
enabled: true
@@ -74,11 +113,11 @@ metrics:
113
description: ""
114
labels:
115
- name: mount_point
77
- description: TBD
116
+ description: Path used to mount a filesystem
117
- name: filesystem
79
- description: TBD
118
+ description: The filesystem used to format a partition.
119
- name: mount_root
81
- description: TBD
120
+ description: Root directory where mount points are present.
121
metrics:
122
- name: disk.space
123
description: Disk Space Usage