src/zfs_arc.c

   1 /**
   2  * collectd - src/zfs_arc.c
   3  * Copyright (C) 2009  Anthony Dewhurst
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Anthony Dewhurst <dewhurst at gmail>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25
  26 /*
  27  * Global variables
  28  */
  29 static kstat_t *ksp;
  30 extern kstat_ctl_t *kc;
  31
  32 static void za_submit (const char* type, const char* type_instance, value_t* values, int values_len)
  33 {
  34         value_list_t vl = VALUE_LIST_INIT;
  35
  36         vl.values = values;
  37         vl.values_len = values_len;
  38
  39         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
  40         sstrncpy (vl.plugin, "zfs_arc", sizeof (vl.plugin));
  41         sstrncpy (vl.type, type, sizeof (vl.type));
  42         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
  43
  44         plugin_dispatch_values (&vl);
  45 }
  46
  47 static void za_submit_gauge (const char* type, const char* type_instance, gauge_t value)
  48 {
  49         value_t vv;
  50
  51         vv.gauge = value;
  52         za_submit (type, type_instance, &vv, 1);
  53 }
  54
  55 static void za_submit_derive (const char* type, const char* type_instance, derive_t dv)
  56 {
  57         value_t vv;
  58
  59         vv.derive = dv;
  60         za_submit (type, type_instance, &vv, 1);
  61 }
  62
  63 static void za_submit_ratio (const char* type_instance, gauge_t hits, gauge_t misses)
  64 {
  65         gauge_t ratio = NAN;
  66
  67         if (!isfinite (hits) || (hits < 0.0))
  68                 hits = 0.0;
  69         if (!isfinite (misses) || (misses < 0.0))
  70                 misses = 0.0;
  71
  72         if ((hits != 0.0) || (misses != 0.0))
  73                 ratio = hits / (hits + misses);
  74
  75         za_submit_gauge ("cache_ratio", type_instance, ratio);
  76 }
  77
  78 static void za_submit_deleted_counts (derive_t deleted)
  79 {
  80         value_t values[1];
  81
  82         values[0].counter = deleted;
  83
  84         za_submit ("deleted", "counts", values, STATIC_ARRAY_SIZE(values));
  85 }
  86
  87 static void za_submit_hash_counts (derive_t hash_collisions)
  88 {
  89         value_t values[1];
  90
  91         values[0].counter = hash_collisions;
  92
  93         za_submit ("hash", "counts", values, STATIC_ARRAY_SIZE(values));
  94 }
  95
  96 static int za_read (void)
  97 {
  98         gauge_t  arc_size, l2_size;
  99         derive_t demand_data_hits,
 100                  demand_metadata_hits,
 101                  prefetch_data_hits,
 102                  prefetch_metadata_hits,
 103                  demand_data_misses,
 104                  demand_metadata_misses,
 105                  prefetch_data_misses,
 106                  prefetch_metadata_misses;
 107         gauge_t  arc_hits, arc_misses, l2_hits, l2_misses;
 108         value_t  l2_io[2];
 109         derive_t mutex_miss;
 110         derive_t deleted;
 111         derive_t evict_l2_cached, evict_l2_eligible, evict_l2_ineligible;
 112         derive_t hash_collisions;
 113
 114         get_kstat (&ksp, "zfs", 0, "arcstats");
 115         if (ksp == NULL)
 116         {
 117                 ERROR ("zfs_arc plugin: Cannot find zfs:0:arcstats kstat.");
 118                 return (-1);
 119         }
 120
 121         /* Sizes */
 122         arc_size   = get_kstat_value(ksp, "size");
 123         l2_size    = get_kstat_value(ksp, "l2_size");
 124
 125         za_submit_gauge ("cache_size", "arc", arc_size);
 126         za_submit_gauge ("cache_size", "L2", l2_size);
 127
 128         mutex_miss = get_kstat_value (ksp, "mutex_miss");
 129         za_submit_derive ("mutex_operation", "miss", mutex_miss);
 130
 131         deleted                  = get_kstat_value(ksp, "deleted");
 132
 133         evict_l2_cached          = get_kstat_value(ksp, "evict_l2_cached");
 134         evict_l2_eligible        = get_kstat_value(ksp, "evict_l2_eligible");
 135         evict_l2_ineligible      = get_kstat_value(ksp, "evict_l2_ineligible");
 136
 137         za_submit_derive ("cache_eviction", "cached",     evict_l2_cached);
 138         za_submit_derive ("cache_eviction", "eligible",   evict_l2_eligible);
 139         za_submit_derive ("cache_eviction", "ineligible", evict_l2_ineligible);
 140
 141         hash_collisions          = get_kstat_value(ksp, "hash_collisions");
 142
 143         /* Hits / misses */
 144         demand_data_hits       = get_kstat_value(ksp, "demand_data_hits");
 145         demand_metadata_hits   = get_kstat_value(ksp, "demand_metadata_hits");
 146         prefetch_data_hits     = get_kstat_value(ksp, "prefetch_data_hits");
 147         prefetch_metadata_hits = get_kstat_value(ksp, "prefetch_metadata_hits");
 148
 149         demand_data_misses       = get_kstat_value(ksp, "demand_data_misses");
 150         demand_metadata_misses   = get_kstat_value(ksp, "demand_metadata_misses");
 151         prefetch_data_misses     = get_kstat_value(ksp, "prefetch_data_misses");
 152         prefetch_metadata_misses = get_kstat_value(ksp, "prefetch_metadata_misses");
 153
 154         za_submit_derive ("cache_result", "demand_data-hit",       demand_data_hits);
 155         za_submit_derive ("cache_result", "demand_metadata-hit",   demand_metadata_hits);
 156         za_submit_derive ("cache_result", "prefetch_data-hit",     prefetch_data_hits);
 157         za_submit_derive ("cache_result", "prefetch_metadata-hit", prefetch_metadata_hits);
 158
 159         za_submit_derive ("cache_result", "demand_data-miss",       demand_data_misses);
 160         za_submit_derive ("cache_result", "demand_metadata-miss",   demand_metadata_misses);
 161         za_submit_derive ("cache_result", "prefetch_data-miss",     prefetch_data_misses);
 162         za_submit_derive ("cache_result", "prefetch_metadata-miss", prefetch_metadata_misses);
 163
 164         /* Ratios */
 165         arc_hits   = (gauge_t) get_kstat_value(ksp, "hits");
 166         arc_misses = (gauge_t) get_kstat_value(ksp, "misses");
 167         l2_hits    = (gauge_t) get_kstat_value(ksp, "l2_hits");
 168         l2_misses  = (gauge_t) get_kstat_value(ksp, "l2_misses");
 169
 170         za_submit_ratio ("arc", arc_hits, arc_misses);
 171         za_submit_ratio ("L2", l2_hits, l2_misses);
 172
 173         /* I/O */
 174         l2_io[0].derive = get_kstat_value(ksp, "l2_read_bytes");
 175         l2_io[1].derive = get_kstat_value(ksp, "l2_write_bytes");
 176
 177         za_submit ("io_octets", "L2", l2_io, /* num values = */ 2);
 178
 179         za_submit_deleted_counts (deleted);
 180
 181         za_submit_hash_counts (hash_collisions);
 182
 183         return (0);
 184 } /* int za_read */
 185
 186 static int za_init (void) /* {{{ */
 187 {
 188         ksp = NULL;
 189
 190         /* kstats chain already opened by update_kstat (using *kc), verify everything went fine. */
 191         if (kc == NULL)
 192         {
 193                 ERROR ("zfs_arc plugin: kstat chain control structure not available.");
 194                 return (-1);
 195         }
 196
 197         return (0);
 198 } /* }}} int za_init */
 199
 200 void module_register (void)
 201 {
 202         plugin_register_init ("zfs_arc", za_init);
 203         plugin_register_read ("zfs_arc", za_read);
 204 } /* void module_register */
 205
 206 /* vmi: set sw=8 noexpandtab fdm=marker : */