src/plugin_proc_diskspace.c

   1 #include "common.h"
   2
   3 #define DELAULT_EXLUDED_PATHS "/proc/* /sys/* /var/run/user/* /run/user/*"
   4 #define DEFAULT_EXCLUDED_FILESYSTEMS ""
   5 #define CONFIG_SECTION_DISKSPACE "plugin:proc:diskspace"
   6
   7 static struct mountinfo *disk_mountinfo_root = NULL;
   8 static int check_for_new_mountpoints_every = 15;
   9
  10 static inline void mountinfo_reload(int force) {
  11     static time_t last_loaded = 0;
  12     time_t now = now_realtime_sec();
  13
  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);
  17
  18         // re-read mountinfo in case something changed
  19         disk_mountinfo_root = mountinfo_read(0);
  20
  21         last_loaded = now;
  22     }
  23 }
  24
  25 // Data to be stored in DICTIONARY mount_points 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 {
  28     int do_space;
  29     int do_inodes;
  30
  31     size_t collected; // the number of times this has been collected
  32
  33     RRDSET *st_space;
  34     RRDDIM *rd_space_used;
  35     RRDDIM *rd_space_avail;
  36     RRDDIM *rd_space_reserved;
  37
  38     RRDSET *st_inodes;
  39     RRDDIM *rd_inodes_used;
  40     RRDDIM *rd_inodes_avail;
  41     RRDDIM *rd_inodes_reserved;
  42 };
  43
  44 static inline void do_disk_space_stats(struct mountinfo *mi, int update_every) {
  45     const char *family = mi->mount_point;
  46     const char *disk = mi->persistent_id;
  47
  48     static DICTIONARY *mount_points = NULL;
  49     static SIMPLE_PATTERN *excluded_mountpoints = NULL;
  50     static SIMPLE_PATTERN *excluded_filesystems = NULL;
  51     int do_space, do_inodes;
  52
  53     if(unlikely(!mount_points)) {
  54         SIMPLE_PREFIX_MODE mode = SIMPLE_PATTERN_EXACT;
  55
  56         if(config_move("plugin:proc:/proc/diskstats", "exclude space metrics on paths", CONFIG_SECTION_DISKSPACE, "exclude space metrics on paths") != -1) {
  57             // old configuration, enable backwards compatibility
  58             mode = SIMPLE_PATTERN_PREFIX;
  59         }
  60
  61         excluded_mountpoints = simple_pattern_create(
  62                 config_get(CONFIG_SECTION_DISKSPACE, "exclude space metrics on paths", DELAULT_EXLUDED_PATHS),
  63                 mode
  64         );
  65
  66         excluded_filesystems = simple_pattern_create(
  67                 config_get(CONFIG_SECTION_DISKSPACE, "exclude space metrics on filesystems", DEFAULT_EXCLUDED_FILESYSTEMS),
  68                 SIMPLE_PATTERN_EXACT
  69         );
  70
  71         mount_points = dictionary_create(DICTIONARY_FLAG_SINGLE_THREADED);
  72     }
  73
  74     struct mount_point_metadata *m = dictionary_get(mount_points, mi->mount_point);
  75     if(unlikely(!m)) {
  76         char var_name[4096 + 1];
  77         snprintfz(var_name, 4096, "plugin:proc:diskspace:%s", mi->mount_point);
  78
  79         int def_space = config_get_boolean_ondemand(CONFIG_SECTION_DISKSPACE, "space usage for all disks", CONFIG_BOOLEAN_AUTO);
  80         int def_inodes = config_get_boolean_ondemand(CONFIG_SECTION_DISKSPACE, "inodes usage for all disks", CONFIG_BOOLEAN_AUTO);
  81
  82         if(unlikely(simple_pattern_matches(excluded_mountpoints, mi->mount_point))) {
  83             def_space = CONFIG_BOOLEAN_NO;
  84             def_inodes = CONFIG_BOOLEAN_NO;
  85         }
  86
  87         if(unlikely(simple_pattern_matches(excluded_filesystems, mi->filesystem))) {
  88             def_space = CONFIG_BOOLEAN_NO;
  89             def_inodes = CONFIG_BOOLEAN_NO;
  90         }
  91
  92         do_space = config_get_boolean_ondemand(var_name, "space usage", def_space);
  93         do_inodes = config_get_boolean_ondemand(var_name, "inodes usage", def_inodes);
  94
  95         struct mount_point_metadata mp = {
  96                 .do_space = do_space,
  97                 .do_inodes = do_inodes,
  98
  99                 .collected = 0,
 100
 101                 .st_space = NULL,
 102                 .rd_space_avail = NULL,
 103                 .rd_space_used = NULL,
 104                 .rd_space_reserved = NULL,
 105
 106                 .st_inodes = NULL,
 107                 .rd_inodes_avail = NULL,
 108                 .rd_inodes_used = NULL,
 109                 .rd_inodes_reserved = NULL
 110         };
 111
 112         m = dictionary_set(mount_points, mi->mount_point, &mp, sizeof(struct mount_point_metadata));
 113     }
 114     else {
 115         do_space = m->do_space;
 116         do_inodes = m->do_inodes;
 117     }
 118
 119     if(unlikely(do_space == CONFIG_BOOLEAN_NO && do_inodes == CONFIG_BOOLEAN_NO))
 120         return;
 121
 122     if(unlikely(mi->flags & MOUNTINFO_READONLY && !m->collected))
 123         return;
 124
 125     struct statvfs buff_statvfs;
 126     if (statvfs(mi->mount_point, &buff_statvfs) < 0) {
 127         error("Failed statvfs() for '%s' (disk '%s')", mi->mount_point, disk);
 128         return;
 129     }
 130
 131     // logic found at get_fs_usage() in coreutils
 132     unsigned long bsize = (buff_statvfs.f_frsize) ? buff_statvfs.f_frsize : buff_statvfs.f_bsize;
 133
 134     fsblkcnt_t bavail         = buff_statvfs.f_bavail;
 135     fsblkcnt_t btotal         = buff_statvfs.f_blocks;
 136     fsblkcnt_t bavail_root    = buff_statvfs.f_bfree;
 137     fsblkcnt_t breserved_root = bavail_root - bavail;
 138     fsblkcnt_t bused;
 139     if(likely(btotal >= bavail_root))
 140         bused = btotal - bavail_root;
 141     else
 142         bused = bavail_root - btotal;
 143
 144 #ifdef NETDATA_INTERNAL_CHECKS
 145     if(unlikely(btotal != bavail + breserved_root + bused))
 146         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);
 147 #endif
 148
 149     // --------------------------------------------------------------------------
 150
 151     fsfilcnt_t favail         = buff_statvfs.f_favail;
 152     fsfilcnt_t ftotal         = buff_statvfs.f_files;
 153     fsfilcnt_t favail_root    = buff_statvfs.f_ffree;
 154     fsfilcnt_t freserved_root = favail_root - favail;
 155     fsfilcnt_t fused          = ftotal - favail_root;
 156
 157 #ifdef NETDATA_INTERNAL_CHECKS
 158     if(unlikely(btotal != bavail + breserved_root + bused))
 159         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);
 160 #endif
 161
 162     // --------------------------------------------------------------------------
 163
 164     int rendered = 0;
 165
 166     if(do_space == CONFIG_BOOLEAN_YES || (do_space == CONFIG_BOOLEAN_AUTO && (bavail || breserved_root || bused))) {
 167         if(unlikely(!m->st_space)) {
 168             m->do_space = CONFIG_BOOLEAN_YES;
 169             m->st_space = rrdset_find_bytype_localhost("disk_space", disk);
 170             if(unlikely(!m->st_space)) {
 171                 char title[4096 + 1];
 172                 snprintfz(title, 4096, "Disk Space Usage for %s [%s]", family, mi->mount_source);
 173                 m->st_space = rrdset_create_localhost(
 174                         "disk_space"
 175                         , disk
 176                         , NULL
 177                         , family
 178                         , "disk.space"
 179                         , title
 180                         , "GB"
 181                         , 2023
 182                         , update_every
 183                         , RRDSET_TYPE_STACKED
 184                 );
 185             }
 186
 187             m->rd_space_avail    = rrddim_add(m->st_space, "avail", NULL, (collected_number)bsize, 1024 * 1024 * 1024, RRD_ALGORITHM_ABSOLUTE);
 188             m->rd_space_used     = rrddim_add(m->st_space, "used", NULL, (collected_number)bsize, 1024 * 1024 * 1024, RRD_ALGORITHM_ABSOLUTE);
 189             m->rd_space_reserved = rrddim_add(m->st_space, "reserved_for_root", "reserved for root", (collected_number)bsize, 1024 * 1024 * 1024, RRD_ALGORITHM_ABSOLUTE);
 190         }
 191         else
 192             rrdset_next(m->st_space);
 193
 194         rrddim_set_by_pointer(m->st_space, m->rd_space_avail,    (collected_number)bavail);
 195         rrddim_set_by_pointer(m->st_space, m->rd_space_used,     (collected_number)bused);
 196         rrddim_set_by_pointer(m->st_space, m->rd_space_reserved, (collected_number)breserved_root);
 197         rrdset_done(m->st_space);
 198
 199         rendered++;
 200     }
 201
 202     // --------------------------------------------------------------------------
 203
 204     if(do_inodes == CONFIG_BOOLEAN_YES || (do_inodes == CONFIG_BOOLEAN_AUTO && (favail || freserved_root || fused))) {
 205         if(unlikely(!m->st_inodes)) {
 206             m->do_inodes = CONFIG_BOOLEAN_YES;
 207             m->st_inodes = rrdset_find_bytype_localhost("disk_inodes", disk);
 208             if(unlikely(!m->st_inodes)) {
 209                 char title[4096 + 1];
 210                 snprintfz(title, 4096, "Disk Files (inodes) Usage for %s [%s]", family, mi->mount_source);
 211                 m->st_inodes = rrdset_create_localhost(
 212                         "disk_inodes"
 213                         , disk
 214                         , NULL
 215                         , family
 216                         , "disk.inodes"
 217                         , title
 218                         , "Inodes"
 219                         , 2024
 220                         , update_every
 221                         , RRDSET_TYPE_STACKED
 222                 );
 223             }
 224
 225             m->rd_inodes_avail    = rrddim_add(m->st_inodes, "avail", NULL, 1, 1, RRD_ALGORITHM_ABSOLUTE);
 226             m->rd_inodes_used     = rrddim_add(m->st_inodes, "used", NULL, 1, 1, RRD_ALGORITHM_ABSOLUTE);
 227             m->rd_inodes_reserved = rrddim_add(m->st_inodes, "reserved_for_root", "reserved for root", 1, 1, RRD_ALGORITHM_ABSOLUTE);
 228         }
 229         else
 230             rrdset_next(m->st_inodes);
 231
 232         rrddim_set_by_pointer(m->st_inodes, m->rd_inodes_avail,    (collected_number)favail);
 233         rrddim_set_by_pointer(m->st_inodes, m->rd_inodes_used,     (collected_number)fused);
 234         rrddim_set_by_pointer(m->st_inodes, m->rd_inodes_reserved, (collected_number)freserved_root);
 235         rrdset_done(m->st_inodes);
 236
 237         rendered++;
 238     }
 239
 240     // --------------------------------------------------------------------------
 241
 242     if(likely(rendered))
 243         m->collected++;
 244 }
 245
 246 void *proc_diskspace_main(void *ptr) {
 247     struct netdata_static_thread *static_thread = (struct netdata_static_thread *)ptr;
 248
 249     info("DISKSPACE thread created with task id %d", gettid());
 250
 251     if(pthread_setcanceltype(PTHREAD_CANCEL_DEFERRED, NULL) != 0)
 252         error("Cannot set pthread cancel type to DEFERRED.");
 253
 254     if(pthread_setcancelstate(PTHREAD_CANCEL_ENABLE, NULL) != 0)
 255         error("Cannot set pthread cancel state to ENABLE.");
 256
 257     int vdo_cpu_netdata = config_get_boolean("plugin:proc", "netdata server resources", 1);
 258
 259     int update_every = (int)config_get_number(CONFIG_SECTION_DISKSPACE, "update every", localhost->rrd_update_every);
 260     if(update_every < localhost->rrd_update_every)
 261         update_every = localhost->rrd_update_every;
 262
 263     check_for_new_mountpoints_every = (int)config_get_number(CONFIG_SECTION_DISKSPACE, "check for new mount points every", check_for_new_mountpoints_every);
 264     if(check_for_new_mountpoints_every < update_every)
 265         check_for_new_mountpoints_every = update_every;
 266
 267     struct rusage thread;
 268
 269     usec_t duration = 0;
 270     usec_t step = update_every * USEC_PER_SEC;
 271     heartbeat_t hb;
 272     heartbeat_init(&hb);
 273     for(;;) {
 274         duration = heartbeat_dt_usec(&hb);
 275         /* usec_t hb_dt = */ heartbeat_next(&hb, step);
 276
 277         if(unlikely(netdata_exit)) break;
 278
 279
 280         // --------------------------------------------------------------------------
 281         // this is smart enough not to reload it every time
 282
 283         mountinfo_reload(0);
 284
 285
 286         // --------------------------------------------------------------------------
 287         // disk space metrics
 288
 289         struct mountinfo *mi;
 290         for(mi = disk_mountinfo_root; mi; mi = mi->next) {
 291
 292             if(unlikely(mi->flags & (MOUNTINFO_IS_DUMMY | MOUNTINFO_IS_BIND | MOUNTINFO_IS_SAME_DEV | MOUNTINFO_NO_STAT | MOUNTINFO_NO_SIZE)))
 293                 continue;
 294
 295             do_disk_space_stats(mi, update_every);
 296             if(unlikely(netdata_exit)) break;
 297         }
 298
 299         if(unlikely(netdata_exit)) break;
 300
 301         if(vdo_cpu_netdata) {
 302             static RRDSET *stcpu_thread = NULL, *st_duration = NULL;
 303             static RRDDIM *rd_user = NULL, *rd_system = NULL, *rd_duration = NULL;
 304
 305             // ----------------------------------------------------------------
 306
 307             getrusage(RUSAGE_THREAD, &thread);
 308
 309             if(!stcpu_thread) {
 310                 stcpu_thread = rrdset_find_localhost("netdata.plugin_diskspace");
 311                 if(!stcpu_thread)
 312                     stcpu_thread = rrdset_create_localhost(
 313                             "netdata"
 314                             , "plugin_diskspace"
 315                             , NULL
 316                             , "diskspace"
 317                             , NULL
 318                             , "NetData Disk Space Plugin CPU usage"
 319                             , "milliseconds/s"
 320                             , 132020
 321                             , update_every
 322                             , RRDSET_TYPE_STACKED
 323                     );
 324
 325                 rd_user   = rrddim_add(stcpu_thread, "user", NULL, 1, 1000, RRD_ALGORITHM_INCREMENTAL);
 326                 rd_system = rrddim_add(stcpu_thread, "system", NULL, 1, 1000, RRD_ALGORITHM_INCREMENTAL);
 327             }
 328             else
 329                 rrdset_next(stcpu_thread);
 330
 331             rrddim_set_by_pointer(stcpu_thread, rd_user, thread.ru_utime.tv_sec * 1000000ULL + thread.ru_utime.tv_usec);
 332             rrddim_set_by_pointer(stcpu_thread, rd_system, thread.ru_stime.tv_sec * 1000000ULL + thread.ru_stime.tv_usec);
 333             rrdset_done(stcpu_thread);
 334
 335             // ----------------------------------------------------------------
 336
 337             if(!st_duration) {
 338                 st_duration = rrdset_find_localhost("netdata.plugin_diskspace_dt");
 339                 if(!st_duration)
 340                     st_duration = rrdset_create_localhost(
 341                             "netdata"
 342                             , "plugin_diskspace_dt"
 343                             , NULL
 344                             , "diskspace"
 345                             , NULL
 346                             , "NetData Disk Space Plugin Duration"
 347                             , "milliseconds/run"
 348                             , 132021
 349                             , update_every
 350                             , RRDSET_TYPE_AREA
 351                     );
 352
 353                 rd_duration = rrddim_add(st_duration, "duration", NULL, 1, 1000, RRD_ALGORITHM_ABSOLUTE);
 354             }
 355             else
 356                 rrdset_next(st_duration);
 357
 358             rrddim_set_by_pointer(st_duration, rd_duration, duration);
 359             rrdset_done(st_duration);
 360
 361             // ----------------------------------------------------------------
 362
 363             if(unlikely(netdata_exit)) break;
 364         }
 365     }
 366
 367     info("DISKSPACE thread exiting");
 368
 369     static_thread->enabled = 0;
 370     pthread_exit(NULL);
 371     return NULL;
 372 }