3 * Copyright (C) 2007-2009 Florian octo Forster
4 * Copyright (C) 2009 Doug MacEachern
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.
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.
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
20 * Florian octo Forster <octo at collectd.org>
21 * Doug MacEachern <dougm@hyperic.com>
27 #include "utils_cache.h"
32 static const char *config_keys[] =
37 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
39 static char *datadir = NULL;
40 static int store_rates = 0;
41 static int use_stdio = 0;
43 static int value_list_to_string (char *buffer, int buffer_len,
44 const data_set_t *ds, const value_list_t *vl)
49 gauge_t *rates = NULL;
51 assert (0 == strcmp (ds->type, vl->type));
53 memset (buffer, '\0', buffer_len);
55 status = ssnprintf (buffer, buffer_len, "%.3f",
56 CDTIME_T_TO_DOUBLE (vl->time));
57 if ((status < 1) || (status >= buffer_len))
61 for (i = 0; i < ds->ds_num; i++)
63 if ((ds->ds[i].type != DS_TYPE_COUNTER)
64 && (ds->ds[i].type != DS_TYPE_GAUGE)
65 && (ds->ds[i].type != DS_TYPE_DERIVE)
66 && (ds->ds[i].type != DS_TYPE_ABSOLUTE))
72 if (ds->ds[i].type == DS_TYPE_GAUGE)
74 status = ssnprintf (buffer + offset, buffer_len - offset,
75 ",%lf", vl->values[i].gauge);
77 else if (store_rates != 0)
80 rates = uc_get_rate (ds, vl);
83 WARNING ("csv plugin: "
84 "uc_get_rate failed.");
87 status = ssnprintf (buffer + offset,
91 else if (ds->ds[i].type == DS_TYPE_COUNTER)
93 status = ssnprintf (buffer + offset,
96 vl->values[i].counter);
98 else if (ds->ds[i].type == DS_TYPE_DERIVE)
100 status = ssnprintf (buffer + offset,
103 vl->values[i].derive);
105 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
107 status = ssnprintf (buffer + offset,
110 vl->values[i].absolute);
113 if ((status < 1) || (status >= (buffer_len - offset)))
120 } /* for ds->ds_num */
124 } /* int value_list_to_string */
126 static int value_list_to_filename (char *buffer, size_t buffer_size,
127 value_list_t const *vl)
132 size_t ptr_size = buffer_size;
138 size_t len = strlen (datadir) + 1;
143 memcpy (ptr, datadir, len);
149 status = FORMAT_VL (ptr, ptr_size, vl);
153 /* Skip all the time formatting stuff when printing to STDOUT or
158 ptr_size -= strlen (ptr);
161 /* "-2013-07-12" => 11 bytes */
164 ERROR ("csv plugin: Buffer too small.");
168 /* TODO: Find a way to minimize the calls to `localtime_r',
169 * since they are pretty expensive.. */
171 if (localtime_r (&now, &struct_tm) == NULL)
173 ERROR ("csv plugin: localtime_r failed");
177 status = strftime (ptr, ptr_size, "-%Y-%m-%d", &struct_tm);
178 if (status == 0) /* yep, it returns zero on error. */
180 ERROR ("csv plugin: strftime failed");
185 } /* int value_list_to_filename */
187 static int csv_create_file (const char *filename, const data_set_t *ds)
192 if (check_create_dir (filename))
195 csv = fopen (filename, "w");
199 ERROR ("csv plugin: fopen (%s) failed: %s",
201 sstrerror (errno, errbuf, sizeof (errbuf)));
205 fprintf (csv, "epoch");
206 for (i = 0; i < ds->ds_num; i++)
207 fprintf (csv, ",%s", ds->ds[i].name);
213 } /* int csv_create_file */
215 static int csv_config (const char *key, const char *value)
217 if (strcasecmp ("DataDir", key) == 0)
224 if (strcasecmp ("stdout", value) == 0)
229 else if (strcasecmp ("stderr", value) == 0)
234 datadir = strdup (value);
237 int len = strlen (datadir);
238 while ((len > 0) && (datadir[len - 1] == '/'))
250 else if (strcasecmp ("StoreRates", key) == 0)
262 } /* int csv_config */
264 static int csv_write (const data_set_t *ds, const value_list_t *vl,
265 user_data_t __attribute__((unused)) *user_data)
275 if (0 != strcmp (ds->type, vl->type)) {
276 ERROR ("csv plugin: DS type does not match value list type");
280 status = value_list_to_filename (filename, sizeof (filename), vl);
284 DEBUG ("csv plugin: csv_write: filename = %s;", filename);
286 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
293 escape_string (filename, sizeof (filename));
295 /* Replace commas by colons for PUTVAL compatible output. */
296 for (i = 0; i < sizeof (values); i++)
300 else if (values[i] == ',')
304 fprintf (use_stdio == 1 ? stdout : stderr,
305 "PUTVAL %s interval=%.3f %s\n",
307 CDTIME_T_TO_DOUBLE (vl->interval),
312 if (stat (filename, &statbuf) == -1)
316 if (csv_create_file (filename, ds))
322 ERROR ("stat(%s) failed: %s", filename,
323 sstrerror (errno, errbuf,
328 else if (!S_ISREG (statbuf.st_mode))
330 ERROR ("stat(%s): Not a regular file!",
335 csv = fopen (filename, "a");
339 ERROR ("csv plugin: fopen (%s) failed: %s", filename,
340 sstrerror (errno, errbuf, sizeof (errbuf)));
343 csv_fd = fileno (csv);
345 memset (&fl, '\0', sizeof (fl));
347 fl.l_len = 0; /* till end of file */
348 fl.l_pid = getpid ();
350 fl.l_whence = SEEK_SET;
352 status = fcntl (csv_fd, F_SETLK, &fl);
356 ERROR ("csv plugin: flock (%s) failed: %s", filename,
357 sstrerror (errno, errbuf, sizeof (errbuf)));
362 fprintf (csv, "%s\n", values);
364 /* The lock is implicitely released. I we don't release it explicitely
365 * because the `FILE *' may need to flush a cache first */
369 } /* int csv_write */
371 void module_register (void)
373 plugin_register_config ("csv", csv_config,
374 config_keys, config_keys_num);
375 plugin_register_write ("csv", csv_write, /* user_data = */ NULL);
376 } /* void module_register */