63957f6d98638c0f1a6a63102b1519ea23d1262b
[collectd.git] / 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 int za_read (void)
79 {
80         gauge_t  arc_size, l2_size;
81         derive_t demand_data_hits,
82                  demand_metadata_hits,
83                  prefetch_data_hits,
84                  prefetch_metadata_hits,
85                  demand_data_misses,
86                  demand_metadata_misses,
87                  prefetch_data_misses,
88                  prefetch_metadata_misses;
89         gauge_t  arc_hits, arc_misses, arc_ratio, l2_hits, l2_misses, l2_ratio;
90         value_t  l2_io[2];
91
92         get_kstat (&ksp, "zfs", 0, "arcstats");
93         if (ksp == NULL)
94         {
95                 ERROR ("zfs_arc plugin: Cannot find zfs:0:arcstats kstat.");
96                 return (-1);
97         }
98
99         /* Sizes */
100         arc_size   = get_kstat_value(ksp, "size");
101         l2_size    = get_kstat_value(ksp, "l2_size");
102
103         za_submit_gauge ("cache_size", "arc", arc_size);
104         za_submit_gauge ("cache_size", "L2", l2_size);
105
106         /* Hits / misses */
107         demand_data_hits       = get_kstat_value(ksp, "demand_data_hits");
108         demand_metadata_hits   = get_kstat_value(ksp, "demand_metadata_hits");
109         prefetch_data_hits     = get_kstat_value(ksp, "prefetch_data_hits");
110         prefetch_metadata_hits = get_kstat_value(ksp, "prefetch_metadata_hits");
111
112         demand_data_misses       = get_kstat_value(ksp, "demand_data_misses");
113         demand_metadata_misses   = get_kstat_value(ksp, "demand_metadata_misses");
114         prefetch_data_misses     = get_kstat_value(ksp, "prefetch_data_misses");
115         prefetch_metadata_misses = get_kstat_value(ksp, "prefetch_metadata_misses");
116
117         za_submit_derive ("cache_result", "hit-demand_data",       demand_data_hits);
118         za_submit_derive ("cache_result", "hit-demand_metadata",   demand_metadata_hits);
119         za_submit_derive ("cache_result", "hit-prefetch_data",     prefetch_data_hits);
120         za_submit_derive ("cache_result", "hit-prefetch_metadata", prefetch_metadata_hits);
121
122         za_submit_derive ("cache_result", "miss-demand_data",       demand_data_misses);
123         za_submit_derive ("cache_result", "miss-demand_metadata",   demand_metadata_misses);
124         za_submit_derive ("cache_result", "miss-prefetch_data",     prefetch_data_misses);
125         za_submit_derive ("cache_result", "miss-prefetch_metadata", prefetch_metadata_misses);
126
127         /* Ratios */
128         arc_hits   = (gauge_t) get_kstat_value(ksp, "hits");
129         arc_misses = (gauge_t) get_kstat_value(ksp, "misses");
130         l2_hits    = (gauge_t) get_kstat_value(ksp, "l2_hits");
131         l2_misses  = (gauge_t) get_kstat_value(ksp, "l2_misses");
132
133         za_submit_ratio ("arc", arc_hits, arc_misses);
134         za_submit_ratio ("L2", l2_hits, l2_misses);
135
136         /* I/O */
137         l2_io[0].derive = get_kstat_value(ksp, "l2_read_bytes");
138         l2_io[1].derive = get_kstat_value(ksp, "l2_write_bytes");
139
140         za_submit ("io_octets", "L2", l2_io, /* num values = */ 2);
141
142         return (0);
143 } /* int za_read */
144
145 static int za_init (void) /* {{{ */
146 {
147         ksp = NULL;
148
149         /* kstats chain already opened by update_kstat (using *kc), verify everything went fine. */
150         if (kc == NULL)
151         {
152                 ERROR ("zfs_arc plugin: kstat chain control structure not available.");
153                 return (-1);
154         }
155
156         return (0);
157 } /* }}} int za_init */
158
159 void module_register (void)
160 {
161         plugin_register_init ("zfs_arc", za_init);
162         plugin_register_read ("zfs_arc", za_read);
163 } /* void module_register */
164
165 /* vmi: set sw=8 noexpandtab fdm=marker : */