3 #define DELAULT_EXLUDED_PATHS "/proc/* /sys/* /var/run/user/* /run/user/* /snap/*"
4 #define DEFAULT_EXCLUDED_FILESYSTEMS ""
5 #define CONFIG_SECTION_DISKSPACE "plugin:proc:diskspace"
7 static struct mountinfo *disk_mountinfo_root = NULL;
8 static int check_for_new_mountpoints_every = 15;
10 static inline void mountinfo_reload(int force) {
11 static time_t last_loaded = 0;
12 time_t now = now_realtime_sec();
14 if(force || now - last_loaded >= check_for_new_mountpoints_every) {
15 // mountinfo_free() can be called with NULL disk_mountinfo_root
16 mountinfo_free(disk_mountinfo_root);
18 // re-read mountinfo in case something changed
19 disk_mountinfo_root = mountinfo_read(0);
25 // Data to be stored in DICTIONARY dict_mountpoints used by do_disk_space_stats().
26 // This DICTIONARY is used to lookup the settings of the mount point on each iteration.
27 struct mount_point_metadata {
33 size_t collected; // the number of times this has been collected
36 RRDDIM *rd_space_used;
37 RRDDIM *rd_space_avail;
38 RRDDIM *rd_space_reserved;
41 RRDDIM *rd_inodes_used;
42 RRDDIM *rd_inodes_avail;
43 RRDDIM *rd_inodes_reserved;
46 static DICTIONARY *dict_mountpoints = NULL;
48 #define rrdset_obsolete_and_pointer_null(st) do { if(st) { rrdset_flag_set(st, RRDSET_FLAG_OBSOLETE); st = NULL; } } while(st)
50 int mount_point_cleanup(void *entry, void *data) {
53 struct mount_point_metadata *mp = (struct mount_point_metadata *)entry;
56 if(likely(mp->updated)) {
61 if(likely(mp->collected)) {
66 mp->rd_space_avail = NULL;
67 mp->rd_space_used = NULL;
68 mp->rd_space_reserved = NULL;
70 mp->rd_inodes_avail = NULL;
71 mp->rd_inodes_used = NULL;
72 mp->rd_inodes_reserved = NULL;
74 rrdset_obsolete_and_pointer_null(mp->st_space);
75 rrdset_obsolete_and_pointer_null(mp->st_inodes);
81 static inline void do_disk_space_stats(struct mountinfo *mi, int update_every) {
82 const char *family = mi->mount_point;
83 const char *disk = mi->persistent_id;
85 static SIMPLE_PATTERN *excluded_mountpoints = NULL;
86 static SIMPLE_PATTERN *excluded_filesystems = NULL;
87 int do_space, do_inodes;
89 if(unlikely(!dict_mountpoints)) {
90 SIMPLE_PREFIX_MODE mode = SIMPLE_PATTERN_EXACT;
92 if(config_move("plugin:proc:/proc/diskstats", "exclude space metrics on paths", CONFIG_SECTION_DISKSPACE, "exclude space metrics on paths") != -1) {
93 // old configuration, enable backwards compatibility
94 mode = SIMPLE_PATTERN_PREFIX;
97 excluded_mountpoints = simple_pattern_create(
98 config_get(CONFIG_SECTION_DISKSPACE, "exclude space metrics on paths", DELAULT_EXLUDED_PATHS),
102 excluded_filesystems = simple_pattern_create(
103 config_get(CONFIG_SECTION_DISKSPACE, "exclude space metrics on filesystems", DEFAULT_EXCLUDED_FILESYSTEMS),
107 dict_mountpoints = dictionary_create(DICTIONARY_FLAG_SINGLE_THREADED);
110 struct mount_point_metadata *m = dictionary_get(dict_mountpoints, mi->mount_point);
112 char var_name[4096 + 1];
113 snprintfz(var_name, 4096, "plugin:proc:diskspace:%s", mi->mount_point);
115 int def_space = config_get_boolean_ondemand(CONFIG_SECTION_DISKSPACE, "space usage for all disks", CONFIG_BOOLEAN_AUTO);
116 int def_inodes = config_get_boolean_ondemand(CONFIG_SECTION_DISKSPACE, "inodes usage for all disks", CONFIG_BOOLEAN_AUTO);
118 if(unlikely(simple_pattern_matches(excluded_mountpoints, mi->mount_point))) {
119 def_space = CONFIG_BOOLEAN_NO;
120 def_inodes = CONFIG_BOOLEAN_NO;
123 if(unlikely(simple_pattern_matches(excluded_filesystems, mi->filesystem))) {
124 def_space = CONFIG_BOOLEAN_NO;
125 def_inodes = CONFIG_BOOLEAN_NO;
128 do_space = config_get_boolean_ondemand(var_name, "space usage", def_space);
129 do_inodes = config_get_boolean_ondemand(var_name, "inodes usage", def_inodes);
131 struct mount_point_metadata mp = {
132 .do_space = do_space,
133 .do_inodes = do_inodes,
140 .rd_space_avail = NULL,
141 .rd_space_used = NULL,
142 .rd_space_reserved = NULL,
145 .rd_inodes_avail = NULL,
146 .rd_inodes_used = NULL,
147 .rd_inodes_reserved = NULL
150 m = dictionary_set(dict_mountpoints, mi->mount_point, &mp, sizeof(struct mount_point_metadata));
155 if(unlikely(m->do_space == CONFIG_BOOLEAN_NO && m->do_inodes == CONFIG_BOOLEAN_NO))
158 if(unlikely(mi->flags & MOUNTINFO_READONLY && !m->collected))
161 struct statvfs buff_statvfs;
162 if (statvfs(mi->mount_point, &buff_statvfs) < 0) {
163 if(!m->shown_error) {
164 error("Failed statvfs() for '%s' (disk '%s', filesystem '%s', root '%s')"
167 , mi->filesystem?mi->filesystem:""
168 , mi->root?mi->root:""
176 // logic found at get_fs_usage() in coreutils
177 unsigned long bsize = (buff_statvfs.f_frsize) ? buff_statvfs.f_frsize : buff_statvfs.f_bsize;
179 fsblkcnt_t bavail = buff_statvfs.f_bavail;
180 fsblkcnt_t btotal = buff_statvfs.f_blocks;
181 fsblkcnt_t bavail_root = buff_statvfs.f_bfree;
182 fsblkcnt_t breserved_root = bavail_root - bavail;
184 if(likely(btotal >= bavail_root))
185 bused = btotal - bavail_root;
187 bused = bavail_root - btotal;
189 #ifdef NETDATA_INTERNAL_CHECKS
190 if(unlikely(btotal != bavail + breserved_root + bused))
191 error("Disk block statistics for '%s' (disk '%s') do not sum up: total = %llu, available = %llu, reserved = %llu, used = %llu", mi->mount_point, disk, (unsigned long long)btotal, (unsigned long long)bavail, (unsigned long long)breserved_root, (unsigned long long)bused);
194 // --------------------------------------------------------------------------
196 fsfilcnt_t favail = buff_statvfs.f_favail;
197 fsfilcnt_t ftotal = buff_statvfs.f_files;
198 fsfilcnt_t favail_root = buff_statvfs.f_ffree;
199 fsfilcnt_t freserved_root = favail_root - favail;
200 fsfilcnt_t fused = ftotal - favail_root;
202 #ifdef NETDATA_INTERNAL_CHECKS
203 if(unlikely(btotal != bavail + breserved_root + bused))
204 error("Disk inode statistics for '%s' (disk '%s') do not sum up: total = %llu, available = %llu, reserved = %llu, used = %llu", mi->mount_point, disk, (unsigned long long)ftotal, (unsigned long long)favail, (unsigned long long)freserved_root, (unsigned long long)fused);
207 // --------------------------------------------------------------------------
211 if(m->do_space == CONFIG_BOOLEAN_YES || (m->do_space == CONFIG_BOOLEAN_AUTO && (bavail || breserved_root || bused))) {
212 if(unlikely(!m->st_space)) {
213 m->do_space = CONFIG_BOOLEAN_YES;
214 m->st_space = rrdset_find_bytype_localhost("disk_space", disk);
215 if(unlikely(!m->st_space)) {
216 char title[4096 + 1];
217 snprintfz(title, 4096, "Disk Space Usage for %s [%s]", family, mi->mount_source);
218 m->st_space = rrdset_create_localhost(
228 , RRDSET_TYPE_STACKED
232 m->rd_space_avail = rrddim_add(m->st_space, "avail", NULL, (collected_number)bsize, 1024 * 1024 * 1024, RRD_ALGORITHM_ABSOLUTE);
233 m->rd_space_used = rrddim_add(m->st_space, "used", NULL, (collected_number)bsize, 1024 * 1024 * 1024, RRD_ALGORITHM_ABSOLUTE);
234 m->rd_space_reserved = rrddim_add(m->st_space, "reserved_for_root", "reserved for root", (collected_number)bsize, 1024 * 1024 * 1024, RRD_ALGORITHM_ABSOLUTE);
237 rrdset_next(m->st_space);
239 rrddim_set_by_pointer(m->st_space, m->rd_space_avail, (collected_number)bavail);
240 rrddim_set_by_pointer(m->st_space, m->rd_space_used, (collected_number)bused);
241 rrddim_set_by_pointer(m->st_space, m->rd_space_reserved, (collected_number)breserved_root);
242 rrdset_done(m->st_space);
247 // --------------------------------------------------------------------------
249 if(m->do_inodes == CONFIG_BOOLEAN_YES || (m->do_inodes == CONFIG_BOOLEAN_AUTO && (favail || freserved_root || fused))) {
250 if(unlikely(!m->st_inodes)) {
251 m->do_inodes = CONFIG_BOOLEAN_YES;
252 m->st_inodes = rrdset_find_bytype_localhost("disk_inodes", disk);
253 if(unlikely(!m->st_inodes)) {
254 char title[4096 + 1];
255 snprintfz(title, 4096, "Disk Files (inodes) Usage for %s [%s]", family, mi->mount_source);
256 m->st_inodes = rrdset_create_localhost(
266 , RRDSET_TYPE_STACKED
270 m->rd_inodes_avail = rrddim_add(m->st_inodes, "avail", NULL, 1, 1, RRD_ALGORITHM_ABSOLUTE);
271 m->rd_inodes_used = rrddim_add(m->st_inodes, "used", NULL, 1, 1, RRD_ALGORITHM_ABSOLUTE);
272 m->rd_inodes_reserved = rrddim_add(m->st_inodes, "reserved_for_root", "reserved for root", 1, 1, RRD_ALGORITHM_ABSOLUTE);
275 rrdset_next(m->st_inodes);
277 rrddim_set_by_pointer(m->st_inodes, m->rd_inodes_avail, (collected_number)favail);
278 rrddim_set_by_pointer(m->st_inodes, m->rd_inodes_used, (collected_number)fused);
279 rrddim_set_by_pointer(m->st_inodes, m->rd_inodes_reserved, (collected_number)freserved_root);
280 rrdset_done(m->st_inodes);
285 // --------------------------------------------------------------------------
291 void *proc_diskspace_main(void *ptr) {
292 struct netdata_static_thread *static_thread = (struct netdata_static_thread *)ptr;
294 info("DISKSPACE thread created with task id %d", gettid());
296 if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
297 error("Cannot set pthread cancel type to DEFERRED.");
299 if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
300 error("Cannot set pthread cancel state to ENABLE.");
302 int vdo_cpu_netdata = config_get_boolean("plugin:proc", "netdata server resources", 1);
304 int update_every = (int)config_get_number(CONFIG_SECTION_DISKSPACE, "update every", localhost->rrd_update_every);
305 if(update_every < localhost->rrd_update_every)
306 update_every = localhost->rrd_update_every;
308 check_for_new_mountpoints_every = (int)config_get_number(CONFIG_SECTION_DISKSPACE, "check for new mount points every", check_for_new_mountpoints_every);
309 if(check_for_new_mountpoints_every < update_every)
310 check_for_new_mountpoints_every = update_every;
312 struct rusage thread;
315 usec_t step = update_every * USEC_PER_SEC;
319 duration = heartbeat_dt_usec(&hb);
320 /* usec_t hb_dt = */ heartbeat_next(&hb, step);
322 if(unlikely(netdata_exit)) break;
325 // --------------------------------------------------------------------------
326 // this is smart enough not to reload it every time
331 // --------------------------------------------------------------------------
332 // disk space metrics
334 struct mountinfo *mi;
335 for(mi = disk_mountinfo_root; mi; mi = mi->next) {
337 if(unlikely(mi->flags & (MOUNTINFO_IS_DUMMY | MOUNTINFO_IS_BIND | MOUNTINFO_IS_SAME_DEV | MOUNTINFO_NO_STAT | MOUNTINFO_NO_SIZE)))
340 do_disk_space_stats(mi, update_every);
341 if(unlikely(netdata_exit)) break;
344 if(unlikely(netdata_exit)) break;
346 dictionary_get_all(dict_mountpoints, mount_point_cleanup, NULL);
348 if(vdo_cpu_netdata) {
349 static RRDSET *stcpu_thread = NULL, *st_duration = NULL;
350 static RRDDIM *rd_user = NULL, *rd_system = NULL, *rd_duration = NULL;
352 // ----------------------------------------------------------------
354 getrusage(RUSAGE_THREAD, &thread);
357 stcpu_thread = rrdset_find_localhost("netdata.plugin_diskspace");
359 stcpu_thread = rrdset_create_localhost(
365 , "NetData Disk Space Plugin CPU usage"
369 , RRDSET_TYPE_STACKED
372 rd_user = rrddim_add(stcpu_thread, "user", NULL, 1, 1000, RRD_ALGORITHM_INCREMENTAL);
373 rd_system = rrddim_add(stcpu_thread, "system", NULL, 1, 1000, RRD_ALGORITHM_INCREMENTAL);
376 rrdset_next(stcpu_thread);
378 rrddim_set_by_pointer(stcpu_thread, rd_user, thread.ru_utime.tv_sec * 1000000ULL + thread.ru_utime.tv_usec);
379 rrddim_set_by_pointer(stcpu_thread, rd_system, thread.ru_stime.tv_sec * 1000000ULL + thread.ru_stime.tv_usec);
380 rrdset_done(stcpu_thread);
382 // ----------------------------------------------------------------
385 st_duration = rrdset_find_localhost("netdata.plugin_diskspace_dt");
387 st_duration = rrdset_create_localhost(
389 , "plugin_diskspace_dt"
393 , "NetData Disk Space Plugin Duration"
400 rd_duration = rrddim_add(st_duration, "duration", NULL, 1, 1000, RRD_ALGORITHM_ABSOLUTE);
403 rrdset_next(st_duration);
405 rrddim_set_by_pointer(st_duration, rd_duration, duration);
406 rrdset_done(st_duration);
408 // ----------------------------------------------------------------
410 if(unlikely(netdata_exit)) break;
414 info("DISKSPACE thread exiting");
416 static_thread->enabled = 0;