@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
yaml 204 lines 6.66 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-filecheck
5 plugin_name: go.d.plugin
6 module_name: filecheck
7 monitored_instance:
8 name: Files and directories
9 link: ""
10 icon_filename: filesystem.svg
11 categories:
12 - data-collection.synthetic-testing
13 keywords:
14 - files
15 - directories
16 related_resources:
17 integrations:
18 list: []
19 info_provided_to_referring_integrations:
20 description: ""
21 overview:
22 data_collection:
23 metrics_description: |
24 This collector monitors the existence, last modification time, and size of arbitrary files and directories on the system.
25 method_description: ""
26 supported_platforms:
27 include: []
28 exclude: []
29 multi_instance: true
30 additional_permissions:
31 description: |
32 This collector requires the DAC_READ_SEARCH capability when monitoring files not normally accessible to the Netdata user, but it is set automatically during installation, so no manual configuration is needed.
33 default_behavior:
34 auto_detection:
35 description: ""
36 limits:
37 description: ""
38 performance_impact:
39 description: ""
40 setup:
41 prerequisites:
42 list: []
43 configuration:
44 file:
45 name: go.d/filecheck.conf
46 options:
47 description: |
48 The following options can be defined globally: update_every, autodetection_retry.
49 folding:
50 title: Config options
51 enabled: true
52 list:
53 - name: update_every
54 description: Data collection interval (seconds).
55 default_value: 10
56 required: false
57 group: Collection
58 - name: autodetection_retry
59 description: Autodetection retry interval (seconds). Set 0 to disable.
60 default_value: 0
61 required: false
62 group: Collection
63
64 - name: files
65 description: File selector. Defines which files to monitor.
66 default_value: ""
67 required: true
68 group: Target
69 detailed_description: |
70 Files matching the selector will be monitored.
71
72 - Logic: (pattern1 OR pattern2) AND !(pattern3 OR pattern4)
73 - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
74 - Syntax:
75
76 ```yaml
77 files:
78 includes:
79 - pattern1
80 - pattern2
81 excludes:
82 - pattern3
83 - pattern4
84 ```
85 - name: dirs
86 description: Directory selector. Defines which directories to monitor.
87 default_value: ""
88 required: true
89 group: Target
90 detailed_description: |
91 Directories matching the selector will be monitored.
92
93 - Logic: (pattern1 OR pattern2) AND !(pattern3 OR pattern4)
94 - Pattern syntax: [shell file name pattern](https://golang.org/pkg/path/filepath/#Match)
95 - Syntax:
96
97 ```yaml
98 dirs:
99 includes:
100 - pattern1
101 - pattern2
102 excludes:
103 - pattern3
104 - pattern4
105 ```
106
107 - name: discovery_every
108 description: Files and directories discovery interval (seconds).
109 default_value: 60
110 required: false
111 group: Discovery
112 examples:
113 folding:
114 title: Config
115 enabled: true
116 list:
117 - name: Files
118 description: Files monitoring example configuration.
119 config: |
120 jobs:
121 - name: files_example
122 files:
123 include:
124 - '/path/to/file1'
125 - '/path/to/file2'
126 - '/path/to/*.log'
127 - name: Directories
128 description: Directories monitoring example configuration.
129 config: |
130 jobs:
131 - name: files_example
132 dirs:
133 collect_dir_size: no
134 include:
135 - '/path/to/dir1'
136 - '/path/to/dir2'
137 - '/path/to/dir3*'
138 troubleshooting:
139 problems:
140 list: []
141 alerts: []
142 metrics:
143 folding:
144 title: Metrics
145 enabled: false
146 description: ""
147 availability: []
148 scopes:
149 - name: file
150 description: These metrics refer to the File.
151 labels:
152 - name: file_path
153 description: File absolute path
154 metrics:
155 - name: filecheck.file_existence_status
156 description: File existence
157 unit: status
158 chart_type: line
159 dimensions:
160 - name: exist
161 - name: not_exist
162 - name: filecheck.file_modification_time_ago
163 description: File time since the last modification
164 unit: seconds
165 chart_type: line
166 dimensions:
167 - name: mtime_ago
168 - name: filecheck.file_size_bytes
169 description: File size
170 unit: bytes
171 chart_type: line
172 dimensions:
173 - name: size
174 - name: directory
175 description: These metrics refer to the Directory.
176 labels:
177 - name: dir_path
178 description: Directory absolute path
179 metrics:
180 - name: filecheck.dir_existence_status
181 description: Directory existence
182 unit: status
183 chart_type: line
184 dimensions:
185 - name: exist
186 - name: not_exist
187 - name: filecheck.dir_modification_time_ago
188 description: Directory time since the last modification
189 unit: seconds
190 chart_type: line
191 dimensions:
192 - name: mtime_ago
193 - name: filecheck.dir_size_bytes
194 description: Directory size
195 unit: bytes
196 chart_type: line
197 dimensions:
198 - name: size
199 - name: filecheck.dir_files count
200 description: Directory files count
201 unit: files
202 chart_type: line
203 dimensions:
204 - name: files