Add missing kstat definitions
[collectd.git] / src / csv.c
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  **/
23
24 #include "collectd.h"
25 #include "plugin.h"
26 #include "common.h"
27 #include "utils_cache.h"
28
29 /*
30  * Private variables
31  */
32 static const char *config_keys[] =
33 {
34         "DataDir",
35         "StoreRates"
36 };
37 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
38
39 static char *datadir   = NULL;
40 static int store_rates = 0;
41 static int use_stdio   = 0;
42
43 static int value_list_to_string (char *buffer, int buffer_len,
44                 const data_set_t *ds, const value_list_t *vl)
45 {
46         int offset;
47         int status;
48         size_t i;
49         gauge_t *rates = NULL;
50
51         assert (0 == strcmp (ds->type, vl->type));
52
53         memset (buffer, '\0', buffer_len);
54
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;
60
61         for (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                         return (-1);
68
69                 if (ds->ds[i].type == DS_TYPE_GAUGE) 
70                 {
71                         status = ssnprintf (buffer + offset, buffer_len - offset,
72                                         ",%lf", vl->values[i].gauge);
73                 } 
74                 else if (store_rates != 0)
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                 else if (ds->ds[i].type == DS_TYPE_COUNTER)
89                 {
90                         status = ssnprintf (buffer + offset,
91                                         buffer_len - offset,
92                                         ",%llu",
93                                         vl->values[i].counter);
94                 }
95                 else if (ds->ds[i].type == DS_TYPE_DERIVE)
96                 {
97                         status = ssnprintf (buffer + offset,
98                                         buffer_len - offset,
99                                         ",%"PRIi64,
100                                         vl->values[i].derive);
101                 }
102                 else if (ds->ds[i].type == DS_TYPE_ABSOLUTE)
103                 {
104                         status = ssnprintf (buffer + offset,
105                                         buffer_len - offset,
106                                         ",%"PRIu64,
107                                         vl->values[i].absolute);
108                 }
109
110                 if ((status < 1) || (status >= (buffer_len - offset)))
111                 {
112                         sfree (rates);
113                         return (-1);
114                 }
115
116                 offset += status;
117         } /* for ds->ds_num */
118
119         sfree (rates);
120         return (0);
121 } /* int value_list_to_string */
122
123 static int value_list_to_filename (char *buffer, size_t buffer_size,
124                 value_list_t const *vl)
125 {
126         int status;
127
128         char *ptr = buffer;
129         size_t ptr_size = buffer_size;
130         time_t now;
131         struct tm struct_tm;
132
133         if (datadir != NULL)
134         {
135                 size_t len = strlen (datadir) + 1;
136
137                 if (len >= ptr_size)
138                         return (ENOBUFS);
139
140                 memcpy (ptr, datadir, len);
141                 ptr[len-1] = '/';
142                 ptr_size -= len;
143                 ptr += len;
144         }
145
146         status = FORMAT_VL (ptr, ptr_size, vl);
147         if (status != 0)
148                 return (status);
149
150         /* Skip all the time formatting stuff when printing to STDOUT or
151          * STDERR. */
152         if (use_stdio)
153                 return (0);
154
155         ptr_size -= strlen (ptr);
156         ptr +=  strlen (ptr);
157
158         /* "-2013-07-12" => 11 bytes */
159         if (ptr_size < 12)
160         {
161                 ERROR ("csv plugin: Buffer too small.");
162                 return (ENOMEM);
163         }
164
165         /* TODO: Find a way to minimize the calls to `localtime_r',
166          * since they are pretty expensive.. */
167         now = time (NULL);
168         if (localtime_r (&now, &struct_tm) == NULL)
169         {
170                 ERROR ("csv plugin: localtime_r failed");
171                 return (-1);
172         }
173
174         status = strftime (ptr, ptr_size, "-%Y-%m-%d", &struct_tm);
175         if (status == 0) /* yep, it returns zero on error. */
176         {
177                 ERROR ("csv plugin: strftime failed");
178                 return (-1);
179         }
180
181         return (0);
182 } /* int value_list_to_filename */
183
184 static int csv_create_file (const char *filename, const data_set_t *ds)
185 {
186         FILE *csv;
187         size_t i;
188
189         if (check_create_dir (filename))
190                 return (-1);
191
192         csv = fopen (filename, "w");
193         if (csv == NULL)
194         {
195                 char errbuf[1024];
196                 ERROR ("csv plugin: fopen (%s) failed: %s",
197                                 filename,
198                                 sstrerror (errno, errbuf, sizeof (errbuf)));
199                 return (-1);
200         }
201
202         fprintf (csv, "epoch");
203         for (i = 0; i < ds->ds_num; i++)
204                 fprintf (csv, ",%s", ds->ds[i].name);
205
206         fprintf (csv, "\n");
207         fclose (csv);
208
209         return 0;
210 } /* int csv_create_file */
211
212 static int csv_config (const char *key, const char *value)
213 {
214         if (strcasecmp ("DataDir", key) == 0)
215         {
216                 if (datadir != NULL)
217                 {
218                         free (datadir);
219                         datadir = NULL;
220                 }
221                 if (strcasecmp ("stdout", value) == 0)
222                 {
223                         use_stdio = 1;
224                         return (0);
225                 }
226                 else if (strcasecmp ("stderr", value) == 0)
227                 {
228                         use_stdio = 2;
229                         return (0);
230                 }
231                 datadir = strdup (value);
232                 if (datadir != NULL)
233                 {
234                         int len = strlen (datadir);
235                         while ((len > 0) && (datadir[len - 1] == '/'))
236                         {
237                                 len--;
238                                 datadir[len] = '\0';
239                         }
240                         if (len <= 0)
241                         {
242                                 free (datadir);
243                                 datadir = NULL;
244                         }
245                 }
246         }
247         else if (strcasecmp ("StoreRates", key) == 0)
248         {
249                 if (IS_TRUE (value))
250                         store_rates = 1;
251                 else
252                         store_rates = 0;
253         }
254         else
255         {
256                 return (-1);
257         }
258         return (0);
259 } /* int csv_config */
260
261 static int csv_write (const data_set_t *ds, const value_list_t *vl,
262                 user_data_t __attribute__((unused)) *user_data)
263 {
264         struct stat  statbuf;
265         char         filename[512];
266         char         values[4096];
267         FILE        *csv;
268         int          csv_fd;
269         struct flock fl;
270         int          status;
271
272         if (0 != strcmp (ds->type, vl->type)) {
273                 ERROR ("csv plugin: DS type does not match value list type");
274                 return -1;
275         }
276
277         status = value_list_to_filename (filename, sizeof (filename), vl);
278         if (status != 0)
279                 return (-1);
280
281         DEBUG ("csv plugin: csv_write: filename = %s;", filename);
282
283         if (value_list_to_string (values, sizeof (values), ds, vl) != 0)
284                 return (-1);
285
286         if (use_stdio)
287         {
288                 size_t i;
289
290                 escape_string (filename, sizeof (filename));
291
292                 /* Replace commas by colons for PUTVAL compatible output. */
293                 for (i = 0; i < sizeof (values); i++)
294                 {
295                         if (values[i] == 0)
296                                 break;
297                         else if (values[i] == ',')
298                                 values[i] = ':';
299                 }
300
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         }
308
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         }
331
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);
341
342         memset (&fl, '\0', sizeof (fl));
343         fl.l_start  = 0;
344         fl.l_len    = 0; /* till end of file */
345         fl.l_pid    = getpid ();
346         fl.l_type   = F_WRLCK;
347         fl.l_whence = SEEK_SET;
348
349         status = fcntl (csv_fd, F_SETLK, &fl);
350         if (status != 0)
351         {
352                 char errbuf[1024];
353                 ERROR ("csv plugin: flock (%s) failed: %s", filename,
354                                 sstrerror (errno, errbuf, sizeof (errbuf)));
355                 fclose (csv);
356                 return (-1);
357         }
358
359         fprintf (csv, "%s\n", values);
360
361         /* The lock is implicitely released. I we don't release it explicitely
362          * because the `FILE *' may need to flush a cache first */
363         fclose (csv);
364
365         return (0);
366 } /* int csv_write */
367
368 void module_register (void)
369 {
370         plugin_register_config ("csv", csv_config,
371                         config_keys, config_keys_num);
372         plugin_register_write ("csv", csv_write, /* user_data = */ NULL);
373 } /* void module_register */