Code

Merge pull request #647 from manuelluis/mlsr/threshold-missing_time
[collectd.git] / src / zfs_arc.c
1 /**
2  * collectd - src/zfs_arc.c
3  * Copyright (C) 2009  Anthony Dewhurst
4  * Copyright (C) 2012  Aurelien Rougemont
5  * Copyright (C) 2013  Xin Li
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the
9  * Free Software Foundation; only version 2 of the License is applicable.
10  *
11  * This program is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program; if not, write to the Free Software Foundation, Inc.,
18  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  *
20  * Authors:
21  *   Anthony Dewhurst <dewhurst at gmail>
22  *   Aurelien Rougemont <beorn at gandi.net>
23  *   Xin Li <delphij at FreeBSD.org>
24  **/
26 #include "collectd.h"
27 #include "common.h"
28 #include "plugin.h"
30 /*
31  * Global variables
32  */
34 #if !defined(__FreeBSD__)
35 extern kstat_ctl_t *kc;
37 static long long get_zfs_value(kstat_t *ksp, char *name)
38 {
40         return (get_kstat_value(ksp, name));
41 }
42 #else
43 #include <sys/types.h>
44 #include <sys/sysctl.h>
46 const char zfs_arcstat[] = "kstat.zfs.misc.arcstats.";
48 #if !defined(kstat_t)
49 typedef void kstat_t;
50 #endif
52 static long long get_zfs_value(kstat_t *dummy __attribute__((unused)),
53                 char const *name)
54 {
55         char buffer[256];
56         long long value;
57         size_t valuelen = sizeof(value);
58         int rv;
60         ssnprintf (buffer, sizeof (buffer), "%s%s", zfs_arcstat, name);
61         rv = sysctlbyname (buffer, (void *) &value, &valuelen,
62                         /* new value = */ NULL, /* new length = */ (size_t) 0);
63         if (rv == 0)
64                 return (value);
66         return (-1);
67 }
68 #endif
70 static void za_submit (const char* type, const char* type_instance, value_t* values, int values_len)
71 {
72         value_list_t vl = VALUE_LIST_INIT;
74         vl.values = values;
75         vl.values_len = values_len;
77         sstrncpy (vl.host, hostname_g, sizeof (vl.host));
78         sstrncpy (vl.plugin, "zfs_arc", sizeof (vl.plugin));
79         sstrncpy (vl.type, type, sizeof (vl.type));
80         sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
82         plugin_dispatch_values (&vl);
83 }
85 static void za_submit_gauge (const char* type, const char* type_instance, gauge_t value)
86 {
87         value_t vv;
89         vv.gauge = value;
90         za_submit (type, type_instance, &vv, 1);
91 }
93 static int za_read_derive (kstat_t *ksp, const char *kstat_value,
94     const char *type, const char *type_instance)
95 {
96   long long tmp;
97   value_t v;
99   tmp = get_zfs_value (ksp, (char *)kstat_value);
100   if (tmp == -1LL)
101   {
102     WARNING ("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
103     return (-1);
104   }
106   v.derive = (derive_t) tmp;
107   za_submit (type, type_instance, /* values = */ &v, /* values_num = */ 1);
108   return (0);
111 static int za_read_gauge (kstat_t *ksp, const char *kstat_value,
112     const char *type, const char *type_instance)
114   long long tmp;
115   value_t v;
117   tmp = get_zfs_value (ksp, (char *)kstat_value);
118   if (tmp == -1LL)
119   {
120     WARNING ("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
121     return (-1);
122   }
124   v.gauge = (gauge_t) tmp;
125   za_submit (type, type_instance, /* values = */ &v, /* values_num = */ 1);
126   return (0);
129 static void za_submit_ratio (const char* type_instance, gauge_t hits, gauge_t misses)
131         gauge_t ratio = NAN;
133         if (!isfinite (hits) || (hits < 0.0))
134                 hits = 0.0;
135         if (!isfinite (misses) || (misses < 0.0))
136                 misses = 0.0;
138         if ((hits != 0.0) || (misses != 0.0))
139                 ratio = hits / (hits + misses);
141         za_submit_gauge ("cache_ratio", type_instance, ratio);
144 static int za_read (void)
146         gauge_t  arc_hits, arc_misses, l2_hits, l2_misses;
147         value_t  l2_io[2];
148         kstat_t  *ksp   = NULL;
150 #if !defined(__FreeBSD__)
151         get_kstat (&ksp, "zfs", 0, "arcstats");
152         if (ksp == NULL)
153         {
154                 ERROR ("zfs_arc plugin: Cannot find zfs:0:arcstats kstat.");
155                 return (-1);
156         }
157 #endif
159         /* Sizes */
160         za_read_gauge (ksp, "size",    "cache_size", "arc");
161         za_read_gauge (ksp, "l2_size", "cache_size", "L2");
163         /* Operations */
164         za_read_derive (ksp, "deleted",  "cache_operation", "deleted");
165 #if __FreeBSD__
166         za_read_derive (ksp, "allocated","cache_operation", "allocated");
167         za_read_derive (ksp, "stolen",   "cache_operation", "stolen");
168 #endif
170         /* Issue indicators */
171         za_read_derive (ksp, "mutex_miss", "mutex_operations", "miss");
172         za_read_derive (ksp, "hash_collisions", "hash_collisions", "");
173         
174         /* Evictions */
175         za_read_derive (ksp, "evict_l2_cached",     "cache_eviction", "cached");
176         za_read_derive (ksp, "evict_l2_eligible",   "cache_eviction", "eligible");
177         za_read_derive (ksp, "evict_l2_ineligible", "cache_eviction", "ineligible");
179         /* Hits / misses */
180         za_read_derive (ksp, "demand_data_hits",         "cache_result", "demand_data-hit");
181         za_read_derive (ksp, "demand_metadata_hits",     "cache_result", "demand_metadata-hit");
182         za_read_derive (ksp, "prefetch_data_hits",       "cache_result", "prefetch_data-hit");
183         za_read_derive (ksp, "prefetch_metadata_hits",   "cache_result", "prefetch_metadata-hit");
184         za_read_derive (ksp, "demand_data_misses",       "cache_result", "demand_data-miss");
185         za_read_derive (ksp, "demand_metadata_misses",   "cache_result", "demand_metadata-miss");
186         za_read_derive (ksp, "prefetch_data_misses",     "cache_result", "prefetch_data-miss");
187         za_read_derive (ksp, "prefetch_metadata_misses", "cache_result", "prefetch_metadata-miss");
189         /* Ratios */
190         arc_hits   = (gauge_t) get_zfs_value(ksp, "hits");
191         arc_misses = (gauge_t) get_zfs_value(ksp, "misses");
192         l2_hits    = (gauge_t) get_zfs_value(ksp, "l2_hits");
193         l2_misses  = (gauge_t) get_zfs_value(ksp, "l2_misses");
195         za_submit_ratio ("arc", arc_hits, arc_misses);
196         za_submit_ratio ("L2", l2_hits, l2_misses);
198         /* I/O */
199         l2_io[0].derive = get_zfs_value(ksp, "l2_read_bytes");
200         l2_io[1].derive = get_zfs_value(ksp, "l2_write_bytes");
202         za_submit ("io_octets", "L2", l2_io, /* num values = */ 2);
204         return (0);
205 } /* int za_read */
207 static int za_init (void) /* {{{ */
209 #if !defined(__FreeBSD__)
210         /* kstats chain already opened by update_kstat (using *kc), verify everything went fine. */
211         if (kc == NULL)
212         {
213                 ERROR ("zfs_arc plugin: kstat chain control structure not available.");
214                 return (-1);
215         }
216 #endif
218         return (0);
219 } /* }}} int za_init */
221 void module_register (void)
223         plugin_register_init ("zfs_arc", za_init);
224         plugin_register_read ("zfs_arc", za_read);
225 } /* void module_register */
227 /* vmi: set sw=8 noexpandtab fdm=marker : */