1 /**
2 * collectd - src/csv.c
3 * Copyright (C) 2007-2009 Florian octo Forster
4 * Copyright (C) 2009 Doug MacEachern
5 *
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.
9 *
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.
14 *
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
18 *
19 * Authors:
20 * Florian octo Forster <octo at collectd.org>
21 * Doug MacEachern <dougm@hyperic.com>
22 **/
24 #include "collectd.h"
26 #include "plugin.h"
27 #include "common.h"
28 #include "utils_cache.h"
30 /*
31 * Private variables
32 */
33 static const char *config_keys[] =
34 {
35 "DataDir",
36 "StoreRates"
37 };
38 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
40 static char *datadir = NULL;
41 static int store_rates = 0;
42 static int use_stdio = 0;
44 static int value_list_to_string (char *buffer, int buffer_len,
45 const data_set_t *ds, const value_list_t *vl)
46 {
47 int offset;
48 int status;
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))
58 return (-1);
59 offset = status;
61 for (size_t i = 0; i < ds->ds_num; i++)
62 {
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))
67 {
68 sfree (rates);
69 return (-1);
70 }
72 if (ds->ds[i].type == DS_TYPE_GAUGE)
73 {
74 status = ssnprintf (buffer + offset, buffer_len - offset,
75 ",%lf", vl->values[i].gauge);
76 }
77 else if (store_rates != 0)
78 {
79 if (rates == NULL)
80 rates = uc_get_rate (ds, vl);
81 if (rates == NULL)
82 {
83 WARNING ("csv plugin: "
84 "uc_get_rate failed.");
85 return (-1);
86 }
87 status = ssnprintf (buffer + offset,
88 buffer_len - offset,
89 ",%lf", rates[i]);
90 }
91 else if (ds->ds[i].type == DS_TYPE_COUNTER)
92 {
93 status = ssnprintf (buffer + offset,
94 buffer_len - offset,
95 ",%llu",
96 vl->values[i].counter);
97 }
98 else if (ds->ds[i].type == DS_TYPE_DERIVE)
99 {
100 status = ssnprintf (buffer + offset,
101 buffer_len - offset,
102 ",%"PRIi64,
103 vl->values[i].derive);
104 }
105 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
106 {
107 status = ssnprintf (buffer + offset,
108 buffer_len - offset,
109 ",%"PRIu64,
110 vl->values[i].absolute);
111 }
113 if ((status < 1) || (status >= (buffer_len - offset)))
114 {
115 sfree (rates);
116 return (-1);
117 }
119 offset += status;
120 } /* for ds->ds_num */
122 sfree (rates);
123 return (0);
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)
128 {
129 int status;
131 char *ptr = buffer;
132 size_t ptr_size = buffer_size;
133 time_t now;
134 struct tm struct_tm;
136 if (datadir != NULL)
137 {
138 size_t len = strlen (datadir) + 1;
140 if (len >= ptr_size)
141 return (ENOBUFS);
143 memcpy (ptr, datadir, len);
144 ptr[len-1] = '/';
145 ptr_size -= len;
146 ptr += len;
147 }
149 status = FORMAT_VL (ptr, ptr_size, vl);
150 if (status != 0)
151 return (status);
153 /* Skip all the time formatting stuff when printing to STDOUT or
154 * STDERR. */
155 if (use_stdio)
156 return (0);
158 ptr_size -= strlen (ptr);
159 ptr += strlen (ptr);
161 /* "-2013-07-12" => 11 bytes */
162 if (ptr_size < 12)
163 {
164 ERROR ("csv plugin: Buffer too small.");
165 return (ENOMEM);
166 }
168 /* TODO: Find a way to minimize the calls to `localtime_r',
169 * since they are pretty expensive.. */
170 now = time (NULL);
171 if (localtime_r (&now, &struct_tm) == NULL)
172 {
173 ERROR ("csv plugin: localtime_r failed");
174 return (-1);
175 }
177 status = strftime (ptr, ptr_size, "-%Y-%m-%d", &struct_tm);
178 if (status == 0) /* yep, it returns zero on error. */
179 {
180 ERROR ("csv plugin: strftime failed");
181 return (-1);
182 }
184 return (0);
185 } /* int value_list_to_filename */
187 static int csv_create_file (const char *filename, const data_set_t *ds)
188 {
189 FILE *csv;
191 if (check_create_dir (filename))
192 return (-1);
194 csv = fopen (filename, "w");
195 if (csv == NULL)
196 {
197 char errbuf[1024];
198 ERROR ("csv plugin: fopen (%s) failed: %s",
199 filename,
200 sstrerror (errno, errbuf, sizeof (errbuf)));
201 return (-1);
202 }
204 fprintf (csv, "epoch");
205 for (size_t i = 0; i < ds->ds_num; i++)
206 fprintf (csv, ",%s", ds->ds[i].name);
208 fprintf (csv, "\n");
209 fclose (csv);
211 return 0;
212 } /* int csv_create_file */
214 static int csv_config (const char *key, const char *value)
215 {
216 if (strcasecmp ("DataDir", key) == 0)
217 {
218 if (datadir != NULL)
219 {
220 free (datadir);
221 datadir = NULL;
222 }
223 if (strcasecmp ("stdout", value) == 0)
224 {
225 use_stdio = 1;
226 return (0);
227 }
228 else if (strcasecmp ("stderr", value) == 0)
229 {
230 use_stdio = 2;
231 return (0);
232 }
233 datadir = strdup (value);
234 if (datadir != NULL)
235 {
236 int len = strlen (datadir);
237 while ((len > 0) && (datadir[len - 1] == '/'))
238 {
239 len--;
240 datadir[len] = '\0';
241 }
242 if (len <= 0)
243 {
244 free (datadir);
245 datadir = NULL;
246 }
247 }
248 }
249 else if (strcasecmp ("StoreRates", key) == 0)
250 {
251 if (IS_TRUE (value))
252 store_rates = 1;
253 else
254 store_rates = 0;
255 }
256 else
257 {
258 return (-1);
259 }
260 return (0);
261 } /* int csv_config */
263 static int csv_write (const data_set_t *ds, const value_list_t *vl,
264 user_data_t __attribute__((unused)) *user_data)
265 {
266 struct stat statbuf;
267 char filename[512];
268 char values[4096];
269 FILE *csv;
270 int csv_fd;
271 struct flock fl = { 0 };
272 int status;
274 if (0 != strcmp (ds->type, vl->type)) {
275 ERROR ("csv plugin: DS type does not match value list type");
276 return -1;
277 }
279 status = value_list_to_filename (filename, sizeof (filename), vl);
280 if (status != 0)
281 return (-1);
283 DEBUG ("csv plugin: csv_write: filename = %s;", filename);
285 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
286 return (-1);
288 if (use_stdio)
289 {
290 escape_string (filename, sizeof (filename));
292 /* Replace commas by colons for PUTVAL compatible output. */
293 for (size_t i = 0; i < sizeof (values); i++)
294 {
295 if (values[i] == 0)
296 break;
297 else if (values[i] == ',')
298 values[i] = ':';
299 }
301 fprintf (use_stdio == 1 ? stdout : stderr,
302 "PUTVAL %s interval=%.3f %s\n",
303 filename,
304 CDTIME_T_TO_DOUBLE (vl->interval),
305 values);
306 return (0);
307 }
309 if (stat (filename, &statbuf) == -1)
310 {
311 if (errno == ENOENT)
312 {
313 if (csv_create_file (filename, ds))
314 return (-1);
315 }
316 else
317 {
318 char errbuf[1024];
319 ERROR ("stat(%s) failed: %s", filename,
320 sstrerror (errno, errbuf,
321 sizeof (errbuf)));
322 return (-1);
323 }
324 }
325 else if (!S_ISREG (statbuf.st_mode))
326 {
327 ERROR ("stat(%s): Not a regular file!",
328 filename);
329 return (-1);
330 }
332 csv = fopen (filename, "a");
333 if (csv == NULL)
334 {
335 char errbuf[1024];
336 ERROR ("csv plugin: fopen (%s) failed: %s", filename,
337 sstrerror (errno, errbuf, sizeof (errbuf)));
338 return (-1);
339 }
340 csv_fd = fileno (csv);
342 fl.l_pid = getpid ();
343 fl.l_type = F_WRLCK;
344 fl.l_whence = SEEK_SET;
346 status = fcntl (csv_fd, F_SETLK, &fl);
347 if (status != 0)
348 {
349 char errbuf[1024];
350 ERROR ("csv plugin: flock (%s) failed: %s", filename,
351 sstrerror (errno, errbuf, sizeof (errbuf)));
352 fclose (csv);
353 return (-1);
354 }
356 fprintf (csv, "%s\n", values);
358 /* The lock is implicitely released. I we don't release it explicitely
359 * because the `FILE *' may need to flush a cache first */
360 fclose (csv);
362 return (0);
363 } /* int csv_write */
365 void module_register (void)
366 {
367 plugin_register_config ("csv", csv_config,
368 config_keys, config_keys_num);
369 plugin_register_write ("csv", csv_write, /* user_data = */ NULL);
370 } /* void module_register */