/**
* collectd - src/zfs_arc.c
* Copyright (C) 2009 Anthony Dewhurst
+ * Copyright (C) 2012 Aurelien Rougemont
+ * Copyright (C) 2013 Xin Li
+ * Copyright (C) 2014 Marc Fournier
+ * Copyright (C) 2014 Wilfried Goesgens
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
*
* Authors:
* Anthony Dewhurst <dewhurst at gmail>
+ * Aurelien Rougemont <beorn at gandi.net>
+ * Xin Li <delphij at FreeBSD.org>
+ * Marc Fournier <marc.fournier at camptocamp.com>
+ * Wilfried Goesgens <dothebart at citadel.org>
**/
#include "collectd.h"
/*
* Global variables
*/
-static kstat_t *ksp;
+
+#if defined(KERNEL_LINUX)
+#include "utils_llist.h"
+#define ZOL_ARCSTATS_FILE "/proc/spl/kstat/zfs/arcstats"
+
+typedef llist_t kstat_t;
+
+static int put_zfs_value (kstat_t *ksp, char const *k, value_t v)
+{
+ llentry_t *e;
+ char *k_copy;
+ value_t *v_copy;
+
+ k_copy = strdup (k);
+ if (k_copy == NULL)
+ return ENOMEM;
+
+ v_copy = malloc (sizeof (*v_copy));
+ if (v_copy == NULL)
+ {
+ sfree (k_copy);
+ return ENOMEM;
+ }
+ *v_copy = v;
+
+ e = llentry_create (k_copy, v_copy);
+ if (e == NULL)
+ {
+ sfree (v_copy);
+ sfree (k_copy);
+ return ENOMEM;
+ }
+
+ llist_append (ksp, e);
+ return 0;
+}
+
+static long long get_zfs_value(kstat_t *ksp, char *key)
+{
+ llentry_t *e;
+ value_t *v;
+
+ e = llist_search (ksp, key);
+ if (e == NULL)
+ {
+ ERROR ("zfs_arc plugin: `llist_search` failed for key: '%s'.", key);
+ return (-1);
+ }
+
+ v = e->value;
+ return ((long long) v->derive);
+}
+
+static void free_zfs_values (kstat_t *ksp)
+{
+ llentry_t *e;
+
+ if (ksp == NULL)
+ return;
+
+ for (e = llist_head (ksp); e != NULL; e = e->next)
+ {
+ sfree (e->key);
+ sfree (e->value);
+ }
+
+ llist_destroy (ksp);
+}
+
+#elif !defined(__FreeBSD__) // Solaris
extern kstat_ctl_t *kc;
-static void za_submit (const char* type, const char* type_instance, value_t values[], int values_len)
+static long long get_zfs_value(kstat_t *ksp, char *name)
+{
+
+ return (get_kstat_value(ksp, name));
+}
+#else // FreeBSD
+#include <sys/types.h>
+#include <sys/sysctl.h>
+
+const char zfs_arcstat[] = "kstat.zfs.misc.arcstats.";
+
+#if !defined(kstat_t)
+typedef void kstat_t;
+#endif
+
+static long long get_zfs_value(kstat_t *dummy __attribute__((unused)),
+ char const *name)
+{
+ char buffer[256];
+ long long value;
+ size_t valuelen = sizeof(value);
+ int rv;
+
+ ssnprintf (buffer, sizeof (buffer), "%s%s", zfs_arcstat, name);
+ rv = sysctlbyname (buffer, (void *) &value, &valuelen,
+ /* new value = */ NULL, /* new length = */ (size_t) 0);
+ if (rv == 0)
+ return (value);
+
+ return (-1);
+}
+#endif
+
+static void za_submit (const char* type, const char* type_instance, value_t* values, int values_len)
{
value_list_t vl = VALUE_LIST_INIT;
sstrncpy (vl.host, hostname_g, sizeof (vl.host));
sstrncpy (vl.plugin, "zfs_arc", sizeof (vl.plugin));
sstrncpy (vl.type, type, sizeof (vl.type));
- sstrncpy (vl.type_instance, type_instance, sizeof (vl.type));
+ sstrncpy (vl.type_instance, type_instance, sizeof (vl.type_instance));
plugin_dispatch_values (&vl);
}
static void za_submit_gauge (const char* type, const char* type_instance, gauge_t value)
{
- value_t values[1];
-
- values[0].gauge = value;
+ value_t vv;
- za_submit (type, type_instance, values, STATIC_ARRAY_SIZE(values));
+ vv.gauge = value;
+ za_submit (type, type_instance, &vv, 1);
}
-static void za_submit_size (gauge_t size, gauge_t size_target, gauge_t limit_min, gauge_t limit_max)
+static int za_read_derive (kstat_t *ksp, const char *kstat_value,
+ const char *type, const char *type_instance)
{
- value_t values[4];
-
- values[0].gauge = size;
- values[1].gauge = size_target;
- values[2].gauge = limit_min;
- values[3].gauge = limit_max;
-
- za_submit ("arc_size", "", values, STATIC_ARRAY_SIZE(values));
+ long long tmp;
+ value_t v;
+
+ tmp = get_zfs_value (ksp, (char *)kstat_value);
+ if (tmp == -1LL)
+ {
+ WARNING ("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
+ return (-1);
+ }
+
+ v.derive = (derive_t) tmp;
+ za_submit (type, type_instance, /* values = */ &v, /* values_num = */ 1);
+ return (0);
}
-static void za_submit_bytes (counter_t read, counter_t write)
+static int za_read_gauge (kstat_t *ksp, const char *kstat_value,
+ const char *type, const char *type_instance)
{
- value_t values[2];
-
- values[0].counter = read;
- values[1].counter = write;
-
- za_submit ("arc_l2_bytes", "", values, STATIC_ARRAY_SIZE(values));
+ long long tmp;
+ value_t v;
+
+ tmp = get_zfs_value (ksp, (char *)kstat_value);
+ if (tmp == -1LL)
+ {
+ WARNING ("zfs_arc plugin: Reading kstat value \"%s\" failed.", kstat_value);
+ return (-1);
+ }
+
+ v.gauge = (gauge_t) tmp;
+ za_submit (type, type_instance, /* values = */ &v, /* values_num = */ 1);
+ return (0);
}
-static void za_submit_counts (char *type_instance, counter_t demand_data, counter_t demand_metadata,
- counter_t prefetch_data, counter_t prefetch_metadata)
+static void za_submit_ratio (const char* type_instance, gauge_t hits, gauge_t misses)
{
- value_t values[4];
+ gauge_t ratio = NAN;
- values[0].counter = demand_data;
- values[1].counter = demand_metadata;
- values[2].counter = prefetch_data;
- values[3].counter = prefetch_metadata;
+ if (!isfinite (hits) || (hits < 0.0))
+ hits = 0.0;
+ if (!isfinite (misses) || (misses < 0.0))
+ misses = 0.0;
- za_submit ("arc_counts", type_instance, values, STATIC_ARRAY_SIZE(values));
+ if ((hits != 0.0) || (misses != 0.0))
+ ratio = hits / (hits + misses);
+
+ za_submit_gauge ("cache_ratio", type_instance, ratio);
}
static int za_read (void)
{
- gauge_t arcsize, targetsize, minlimit, maxlimit, hits, misses, l2_size, l2_hits, l2_misses;
- counter_t demand_data_hits, demand_metadata_hits, prefetch_data_hits, prefetch_metadata_hits;
- counter_t demand_data_misses, demand_metadata_misses, prefetch_data_misses, prefetch_metadata_misses;
- counter_t l2_read_bytes, l2_write_bytes;
+ gauge_t arc_hits, arc_misses, l2_hits, l2_misses;
+ value_t l2_io[2];
+ kstat_t *ksp = NULL;
- get_kstat (&ksp, "zfs", 0, "arcstats");
- if (ksp == NULL)
+#if KERNEL_LINUX
+ FILE *fh;
+ char buffer[1024];
+
+ fh = fopen (ZOL_ARCSTATS_FILE, "r");
+ if (fh == NULL)
{
- ERROR ("zfs_arc plugin: Cannot find zfs:0:arcstats kstat.");
+ char errbuf[1024];
+ ERROR ("zfs_arc plugin: Opening \"%s\" failed: %s", ZOL_ARCSTATS_FILE,
+ sstrerror (errno, errbuf, sizeof (errbuf)));
return (-1);
}
- arcsize = get_kstat_value(ksp, "size");
- targetsize = get_kstat_value(ksp, "c");
- minlimit = get_kstat_value(ksp, "c_min");
- maxlimit = get_kstat_value(ksp, "c_max");
-
- demand_data_hits = get_kstat_value(ksp, "demand_data_hits");
- demand_metadata_hits = get_kstat_value(ksp, "demand_metadata_hits");
- prefetch_data_hits = get_kstat_value(ksp, "prefetch_data_hits");
- prefetch_metadata_hits = get_kstat_value(ksp, "prefetch_metadata_hits");
-
- demand_data_misses = get_kstat_value(ksp, "demand_data_misses");
- demand_metadata_misses = get_kstat_value(ksp, "demand_metadata_misses");
- prefetch_data_misses = get_kstat_value(ksp, "prefetch_data_misses");
- prefetch_metadata_misses = get_kstat_value(ksp, "prefetch_metadata_misses");
-
- hits = get_kstat_value(ksp, "hits");
- misses = get_kstat_value(ksp, "misses");
+ ksp = llist_create ();
+ if (ksp == NULL)
+ {
+ ERROR ("zfs_arc plugin: `llist_create' failed.");
+ fclose (fh);
+ return (-1);
+ }
- l2_size = get_kstat_value(ksp, "l2_size");
- l2_read_bytes = get_kstat_value(ksp, "l2_read_bytes");
- l2_write_bytes = get_kstat_value(ksp, "l2_write_bytes");
- l2_hits = get_kstat_value(ksp, "l2_hits");
- l2_misses = get_kstat_value(ksp, "l2_misses");
+ while (fgets (buffer, sizeof (buffer), fh) != NULL)
+ {
+ char *fields[3];
+ value_t v;
+ int status;
+ status = strsplit (buffer, fields, STATIC_ARRAY_SIZE (fields));
+ if (status != 3)
+ continue;
- za_submit_size (arcsize, targetsize, minlimit, maxlimit);
- za_submit_gauge ("arc_l2_size", "", l2_size);
+ status = parse_value (fields[2], &v, DS_TYPE_DERIVE);
+ if (status != 0)
+ continue;
- za_submit_counts ("hits", demand_data_hits, demand_metadata_hits,
- prefetch_data_hits, prefetch_metadata_hits);
- za_submit_counts ("misses", demand_data_misses, demand_metadata_misses,
- prefetch_data_misses, prefetch_metadata_misses);
+ put_zfs_value (ksp, fields[0], v);
+ }
- za_submit_gauge ("arc_ratio", "L1", hits / (hits + misses));
- za_submit_gauge ("arc_ratio", "L2", l2_hits / (l2_hits + l2_misses));
+ fclose (fh);
- za_submit_bytes (l2_read_bytes, l2_write_bytes);
+#elif !defined(__FreeBSD__) // Solaris
+ get_kstat (&ksp, "zfs", 0, "arcstats");
+ if (ksp == NULL)
+ {
+ ERROR ("zfs_arc plugin: Cannot find zfs:0:arcstats kstat.");
+ return (-1);
+ }
+#endif
+
+ /* Sizes */
+ za_read_gauge (ksp, "size", "cache_size", "arc");
+ za_read_gauge (ksp, "c", "cache_size", "c");
+ za_read_gauge (ksp, "c_min", "cache_size", "c_min");
+ za_read_gauge (ksp, "c_max", "cache_size", "c_max");
+
+ /* The "l2_size" value has disappeared from Solaris some time in
+ * early 2013, and has only reappeared recently in Solaris 11.2.
+ * Stop trying if we ever fail to read it, so we don't spam the log.
+ */
+ static int l2_size_avail = 1;
+ if (l2_size_avail && za_read_gauge (ksp, "l2_size", "cache_size", "L2") != 0)
+ l2_size_avail = 0;
+
+ /* Operations */
+ za_read_derive (ksp, "deleted", "cache_operation", "deleted");
+#if __FreeBSD__
+ za_read_derive (ksp, "allocated","cache_operation", "allocated");
+ za_read_derive (ksp, "stolen", "cache_operation", "stolen");
+#endif
+
+ /* Issue indicators */
+ za_read_derive (ksp, "mutex_miss", "mutex_operations", "miss");
+ za_read_derive (ksp, "hash_collisions", "hash_collisions", "");
+
+ /* Evictions */
+ za_read_derive (ksp, "evict_l2_cached", "cache_eviction", "cached");
+ za_read_derive (ksp, "evict_l2_eligible", "cache_eviction", "eligible");
+ za_read_derive (ksp, "evict_l2_ineligible", "cache_eviction", "ineligible");
+
+ /* Hits / misses */
+ za_read_derive (ksp, "demand_data_hits", "cache_result", "demand_data-hit");
+ za_read_derive (ksp, "demand_metadata_hits", "cache_result", "demand_metadata-hit");
+ za_read_derive (ksp, "prefetch_data_hits", "cache_result", "prefetch_data-hit");
+ za_read_derive (ksp, "prefetch_metadata_hits", "cache_result", "prefetch_metadata-hit");
+ za_read_derive (ksp, "demand_data_misses", "cache_result", "demand_data-miss");
+ za_read_derive (ksp, "demand_metadata_misses", "cache_result", "demand_metadata-miss");
+ za_read_derive (ksp, "prefetch_data_misses", "cache_result", "prefetch_data-miss");
+ za_read_derive (ksp, "prefetch_metadata_misses", "cache_result", "prefetch_metadata-miss");
+
+ /* Ratios */
+ arc_hits = (gauge_t) get_zfs_value(ksp, "hits");
+ arc_misses = (gauge_t) get_zfs_value(ksp, "misses");
+ l2_hits = (gauge_t) get_zfs_value(ksp, "l2_hits");
+ l2_misses = (gauge_t) get_zfs_value(ksp, "l2_misses");
+
+ za_submit_ratio ("arc", arc_hits, arc_misses);
+ za_submit_ratio ("L2", l2_hits, l2_misses);
+
+ /* I/O */
+ l2_io[0].derive = get_zfs_value(ksp, "l2_read_bytes");
+ l2_io[1].derive = get_zfs_value(ksp, "l2_write_bytes");
+
+ za_submit ("io_octets", "L2", l2_io, /* num values = */ 2);
+
+#if defined(KERNEL_LINUX)
+ free_zfs_values (ksp);
+#endif
return (0);
-}
+} /* int za_read */
static int za_init (void) /* {{{ */
{
- ksp = NULL;
-
+#if !defined(__FreeBSD__) && !defined(KERNEL_LINUX) // Solaris
/* kstats chain already opened by update_kstat (using *kc), verify everything went fine. */
if (kc == NULL)
{
ERROR ("zfs_arc plugin: kstat chain control structure not available.");
return (-1);
}
+#endif
return (0);
} /* }}} int za_init */