src/lvm.c

   1 /**
   2  * collectd - src/lvm.c
   3  * Copyright (C) 2013       Chad Malfait
   4  * Copyright (C) 2014       Carnegie Mellon University
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; only version 2 of the License is applicable.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  *
  19  * Authors:
  20  *   Chad Malfait <malfaitc at yahoo.com>
  21  *   Benjamin Gilbert <bgilbert at backtick.net>
  22  **/
  23
  24 #include <lvm2app.h>
  25
  26 #include "collectd.h"
  27
  28 #include "common.h"
  29 #include "plugin.h"
  30
  31 #define NO_VALUE UINT64_MAX
  32 #define PERCENT_SCALE_FACTOR 1e-8
  33
  34 static uint64_t get_lv_property_int(lv_t lv, char const *property) {
  35   lvm_property_value_t v;
  36
  37   v = lvm_lv_get_property(lv, property);
  38   if (!v.is_valid || !v.is_integer)
  39     return NO_VALUE;
  40   /* May be NO_VALUE if @property does not apply to this LV */
  41   return v.value.integer;
  42 }
  43
  44 static char const *get_lv_property_string(lv_t lv, char const *property) {
  45   lvm_property_value_t v;
  46
  47   v = lvm_lv_get_property(lv, property);
  48   if (!v.is_valid || !v.is_string)
  49     return NULL;
  50   return v.value.string;
  51 }
  52
  53 static void lvm_submit(char const *plugin_instance, char const *type_instance,
  54                        uint64_t ivalue) {
  55   value_list_t vl = VALUE_LIST_INIT;
  56
  57   vl.values = &(value_t){.gauge = (gauge_t)ivalue};
  58   vl.values_len = 1;
  59
  60   sstrncpy(vl.plugin, "lvm", sizeof(vl.plugin));
  61   sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
  62   sstrncpy(vl.type, "df_complex", sizeof(vl.type));
  63   sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
  64
  65   plugin_dispatch_values(&vl);
  66 }
  67
  68 static void report_lv_utilization(lv_t lv, char const *vg_name,
  69                                   char const *lv_name, uint64_t lv_size,
  70                                   char const *used_percent_property) {
  71   uint64_t used_percent_unscaled;
  72   uint64_t used_bytes;
  73   char plugin_instance[DATA_MAX_NAME_LEN];
  74
  75   used_percent_unscaled = get_lv_property_int(lv, used_percent_property);
  76   if (used_percent_unscaled == NO_VALUE)
  77     return;
  78   used_bytes = lv_size * (used_percent_unscaled * PERCENT_SCALE_FACTOR);
  79
  80   snprintf(plugin_instance, sizeof(plugin_instance), "%s-%s", vg_name, lv_name);
  81   lvm_submit(plugin_instance, "used", used_bytes);
  82   lvm_submit(plugin_instance, "free", lv_size - used_bytes);
  83 }
  84
  85 static void report_thin_pool_utilization(lv_t lv, char const *vg_name,
  86                                          uint64_t lv_size) {
  87   char const *data_lv;
  88   char const *metadata_lv;
  89   uint64_t metadata_size;
  90
  91   data_lv = get_lv_property_string(lv, "data_lv");
  92   metadata_lv = get_lv_property_string(lv, "metadata_lv");
  93   metadata_size = get_lv_property_int(lv, "lv_metadata_size");
  94   if (data_lv == NULL || metadata_lv == NULL || metadata_size == NO_VALUE)
  95     return;
  96
  97   report_lv_utilization(lv, vg_name, data_lv, lv_size, "data_percent");
  98   report_lv_utilization(lv, vg_name, metadata_lv, metadata_size,
  99                         "metadata_percent");
 100 }
 101
 102 static void vg_read(vg_t vg, char const *vg_name) {
 103   struct dm_list *lvs;
 104   struct lvm_lv_list *lvl;
 105   char const *name;
 106   char const *attrs;
 107   uint64_t size;
 108
 109   lvm_submit(vg_name, "free", lvm_vg_get_free_size(vg));
 110
 111   lvs = lvm_vg_list_lvs(vg);
 112   if (!lvs) {
 113     /* no VGs are defined, which is not an error per se */
 114     return;
 115   }
 116
 117   dm_list_iterate_items(lvl, lvs) {
 118     name = lvm_lv_get_name(lvl->lv);
 119     attrs = get_lv_property_string(lvl->lv, "lv_attr");
 120     size = lvm_lv_get_size(lvl->lv);
 121     if (name == NULL || attrs == NULL || size == NO_VALUE)
 122       continue;
 123
 124     /* Condition on volume type.  We want the reported sizes in the
 125        volume group to sum to the size of the volume group, so we ignore
 126        virtual volumes.  */
 127     switch (attrs[0]) {
 128     case 's':
 129     case 'S':
 130       /* Snapshot.  Also report used/free space. */
 131       report_lv_utilization(lvl->lv, vg_name, name, size, "data_percent");
 132       break;
 133     case 't':
 134       /* Thin pool virtual volume.  We report the underlying data
 135          and metadata volumes, not this one.  Report used/free
 136          space, then ignore. */
 137       report_thin_pool_utilization(lvl->lv, vg_name, size);
 138       continue;
 139     case 'v':
 140       /* Virtual volume.  Ignore. */
 141       continue;
 142     case 'V':
 143       /* Thin volume or thin snapshot.  Ignore. */
 144       continue;
 145     }
 146     lvm_submit(vg_name, name, size);
 147   }
 148 }
 149
 150 static int lvm_read(void) {
 151   lvm_t lvm;
 152   struct dm_list *vg_names;
 153   struct lvm_str_list *name_list;
 154
 155   lvm = lvm_init(NULL);
 156   if (!lvm) {
 157     ERROR("lvm plugin: lvm_init failed.");
 158     return -1;
 159   }
 160
 161   vg_names = lvm_list_vg_names(lvm);
 162   if (!vg_names) {
 163     ERROR("lvm plugin lvm_list_vg_name failed %s", lvm_errmsg(lvm));
 164     lvm_quit(lvm);
 165     return -1;
 166   }
 167
 168   dm_list_iterate_items(name_list, vg_names) {
 169     vg_t vg;
 170
 171     vg = lvm_vg_open(lvm, name_list->str, "r", 0);
 172     if (!vg) {
 173       ERROR("lvm plugin: lvm_vg_open (%s) failed: %s", name_list->str,
 174             lvm_errmsg(lvm));
 175       continue;
 176     }
 177
 178     vg_read(vg, name_list->str);
 179     lvm_vg_close(vg);
 180   }
 181
 182   lvm_quit(lvm);
 183   return 0;
 184 } /*lvm_read */
 185
 186 void module_register(void) {
 187   plugin_register_read("lvm", lvm_read);
 188 } /* void module_register */