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