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