1 /**
2 * collectd - src/csv.c
3 * Copyright (C) 2007-2009 Florian octo Forster
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 * Florian octo Forster <octo at verplant.org>
20 **/
22 #include "collectd.h"
23 #include "plugin.h"
24 #include "common.h"
25 #include "utils_cache.h"
26 #include "utils_parse_option.h"
28 /*
29 * Private variables
30 */
31 static const char *config_keys[] =
32 {
33 "DataDir",
34 "StoreRates"
35 };
36 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
38 static char *datadir = NULL;
39 static int store_rates = 0;
40 static int use_stdio = 0;
42 static int value_list_to_string (char *buffer, int buffer_len,
43 const data_set_t *ds, const value_list_t *vl)
44 {
45 int offset;
46 int status;
47 int i;
48 gauge_t *rates = NULL;
50 assert (0 == strcmp (ds->type, vl->type));
52 memset (buffer, '\0', buffer_len);
54 status = ssnprintf (buffer, buffer_len, "%u", (unsigned int) vl->time);
55 if ((status < 1) || (status >= buffer_len))
56 return (-1);
57 offset = status;
59 for (i = 0; i < ds->ds_num; i++)
60 {
61 if ((ds->ds[i].type != DS_TYPE_COUNTER)
62 && (ds->ds[i].type != DS_TYPE_GAUGE))
63 return (-1);
65 if (ds->ds[i].type == DS_TYPE_COUNTER)
66 {
67 if (store_rates == 0)
68 {
69 status = ssnprintf (buffer + offset,
70 buffer_len - offset,
71 ",%llu",
72 vl->values[i].counter);
73 }
74 else /* if (store_rates == 1) */
75 {
76 if (rates == NULL)
77 rates = uc_get_rate (ds, vl);
78 if (rates == NULL)
79 {
80 WARNING ("csv plugin: "
81 "uc_get_rate failed.");
82 return (-1);
83 }
84 status = ssnprintf (buffer + offset,
85 buffer_len - offset,
86 ",%lf", rates[i]);
87 }
88 }
89 else /* if (ds->ds[i].type == DS_TYPE_GAUGE) */
90 {
91 status = ssnprintf (buffer + offset, buffer_len - offset,
92 ",%lf", vl->values[i].gauge);
93 }
95 if ((status < 1) || (status >= (buffer_len - offset)))
96 {
97 sfree (rates);
98 return (-1);
99 }
101 offset += status;
102 } /* for ds->ds_num */
104 sfree (rates);
105 return (0);
106 } /* int value_list_to_string */
108 static int value_list_to_filename (char *buffer, int buffer_len,
109 const data_set_t *ds, const value_list_t *vl)
110 {
111 int offset = 0;
112 int status;
114 assert (0 == strcmp (ds->type, vl->type));
116 if (datadir != NULL)
117 {
118 status = ssnprintf (buffer + offset, buffer_len - offset,
119 "%s/", datadir);
120 if ((status < 1) || (status >= buffer_len - offset))
121 return (-1);
122 offset += status;
123 }
125 status = ssnprintf (buffer + offset, buffer_len - offset,
126 "%s/", vl->host);
127 if ((status < 1) || (status >= buffer_len - offset))
128 return (-1);
129 offset += status;
131 if (strlen (vl->plugin_instance) > 0)
132 status = ssnprintf (buffer + offset, buffer_len - offset,
133 "%s-%s/", vl->plugin, vl->plugin_instance);
134 else
135 status = ssnprintf (buffer + offset, buffer_len - offset,
136 "%s/", vl->plugin);
137 if ((status < 1) || (status >= buffer_len - offset))
138 return (-1);
139 offset += status;
141 if (strlen (vl->type_instance) > 0)
142 status = ssnprintf (buffer + offset, buffer_len - offset,
143 "%s-%s", vl->type, vl->type_instance);
144 else
145 status = ssnprintf (buffer + offset, buffer_len - offset,
146 "%s", vl->type);
147 if ((status < 1) || (status >= buffer_len - offset))
148 return (-1);
149 offset += status;
151 if (!use_stdio)
152 {
153 time_t now;
154 struct tm stm;
156 /* TODO: Find a way to minimize the calls to `localtime_r',
157 * since they are pretty expensive.. */
158 now = time (NULL);
159 if (localtime_r (&now, &stm) == NULL)
160 {
161 ERROR ("csv plugin: localtime_r failed");
162 return (1);
163 }
165 strftime (buffer + offset, buffer_len - offset,
166 "-%Y-%m-%d", &stm);
167 }
169 return (0);
170 } /* int value_list_to_filename */
172 static int csv_create_file (const char *filename, const data_set_t *ds)
173 {
174 FILE *csv;
175 int i;
177 if (check_create_dir (filename))
178 return (-1);
180 csv = fopen (filename, "w");
181 if (csv == NULL)
182 {
183 char errbuf[1024];
184 ERROR ("csv plugin: fopen (%s) failed: %s",
185 filename,
186 sstrerror (errno, errbuf, sizeof (errbuf)));
187 return (-1);
188 }
190 fprintf (csv, "epoch");
191 for (i = 0; i < ds->ds_num; i++)
192 fprintf (csv, ",%s", ds->ds[i].name);
194 fprintf (csv, "\n");
195 fclose (csv);
197 return 0;
198 } /* int csv_create_file */
200 static int csv_config (const char *key, const char *value)
201 {
202 if (strcasecmp ("DataDir", key) == 0)
203 {
204 if (datadir != NULL)
205 free (datadir);
206 if (strcasecmp ("stdout", value) == 0)
207 {
208 use_stdio = 1;
209 return (0);
210 }
211 else if (strcasecmp ("stderr", value) == 0)
212 {
213 use_stdio = 2;
214 return (0);
215 }
216 datadir = strdup (value);
217 if (datadir != NULL)
218 {
219 int len = strlen (datadir);
220 while ((len > 0) && (datadir[len - 1] == '/'))
221 {
222 len--;
223 datadir[len] = '\0';
224 }
225 if (len <= 0)
226 {
227 free (datadir);
228 datadir = NULL;
229 }
230 }
231 }
232 else if (strcasecmp ("StoreRates", key) == 0)
233 {
234 if ((strcasecmp ("True", value) == 0)
235 || (strcasecmp ("Yes", value) == 0)
236 || (strcasecmp ("On", value) == 0))
237 {
238 store_rates = 1;
239 }
240 else
241 {
242 store_rates = 0;
243 }
244 }
245 else
246 {
247 return (-1);
248 }
249 return (0);
250 } /* int csv_config */
252 static int csv_write (const data_set_t *ds, const value_list_t *vl)
253 {
254 struct stat statbuf;
255 char filename[512];
256 char values[512];
257 FILE *csv;
258 int csv_fd;
259 struct flock fl;
260 int status;
262 if (0 != strcmp (ds->type, vl->type)) {
263 ERROR ("csv plugin: DS type does not match value list type");
264 return -1;
265 }
267 if (value_list_to_filename (filename, sizeof (filename), ds, vl) != 0)
268 return (-1);
270 DEBUG ("csv plugin: csv_write: filename = %s;", filename);
272 if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
273 return (-1);
275 if (use_stdio)
276 {
277 size_t i;
279 escape_string (filename, sizeof (filename));
281 /* Replace commas by colons for PUTVAL compatible output. */
282 for (i = 0; i < sizeof (values); i++)
283 {
284 if (values[i] == 0)
285 break;
286 else if (values[i] == ',')
287 values[i] = ':';
288 }
290 fprintf (use_stdio == 1 ? stdout : stderr,
291 "PUTVAL %s interval=%i %s\n",
292 filename, interval_g, values);
293 return (0);
294 }
296 if (stat (filename, &statbuf) == -1)
297 {
298 if (errno == ENOENT)
299 {
300 if (csv_create_file (filename, ds))
301 return (-1);
302 }
303 else
304 {
305 char errbuf[1024];
306 ERROR ("stat(%s) failed: %s", filename,
307 sstrerror (errno, errbuf,
308 sizeof (errbuf)));
309 return (-1);
310 }
311 }
312 else if (!S_ISREG (statbuf.st_mode))
313 {
314 ERROR ("stat(%s): Not a regular file!",
315 filename);
316 return (-1);
317 }
319 csv = fopen (filename, "a");
320 if (csv == NULL)
321 {
322 char errbuf[1024];
323 ERROR ("csv plugin: fopen (%s) failed: %s", filename,
324 sstrerror (errno, errbuf, sizeof (errbuf)));
325 return (-1);
326 }
327 csv_fd = fileno (csv);
329 memset (&fl, '\0', sizeof (fl));
330 fl.l_start = 0;
331 fl.l_len = 0; /* till end of file */
332 fl.l_pid = getpid ();
333 fl.l_type = F_WRLCK;
334 fl.l_whence = SEEK_SET;
336 status = fcntl (csv_fd, F_SETLK, &fl);
337 if (status != 0)
338 {
339 char errbuf[1024];
340 ERROR ("csv plugin: flock (%s) failed: %s", filename,
341 sstrerror (errno, errbuf, sizeof (errbuf)));
342 fclose (csv);
343 return (-1);
344 }
346 fprintf (csv, "%s\n", values);
348 /* The lock is implicitely released. I we don't release it explicitely
349 * because the `FILE *' may need to flush a cache first */
350 fclose (csv);
352 return (0);
353 } /* int csv_write */
355 void module_register (void)
356 {
357 plugin_register_config ("csv", csv_config,
358 config_keys, config_keys_num);
359 plugin_register_write ("csv", csv_write);
360 } /* void module_register */