src/apcups.c

   1 /*
   2  * collectd - src/apcups.c
   3  * Copyright (C) 2006 Anthony Gialluca <tonyabg at charter.net>
   4  * Copyright (C) 2000-2004 Kern Sibbald
   5  * Copyright (C) 1996-99 Andre M. Hedrick <andre at suse.com>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of version 2 of the GNU General
   9  * Public License as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public
  17  * License along with this program; if not, write to the Free
  18  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  19  * MA 02111-1307, USA.
  20  *
  21  * Authors:
  22  *   Anthony Gialluca <tonyabg at charter.net>
  23  **/
  24
  25 /*
  26  * FIXME: Don't know why but without this here atof() was not returning
  27  * correct values for me. This is behavior that I don't understand and
  28  * should be examined in closer detail.
  29  */
  30 #include <stdlib.h>
  31
  32 #include "collectd.h"
  33 #include "common.h"      /* rrd_update_file */
  34 #include "plugin.h"      /* plugin_register, plugin_submit */
  35 #include "configfile.h"  /* cf_register */
  36 #include "utils_debug.h"
  37
  38 #if HAVE_SYS_TYPES_H
  39 # include <sys/types.h>
  40 #endif
  41 #if HAVE_SYS_SOCKET_H
  42 # include <sys/socket.h>
  43 #endif
  44 #if HAVE_NETDB_H
  45 # include <netdb.h>
  46 #endif
  47
  48 #if HAVE_NETINET_IN_H
  49 # include <netinet/in.h>
  50 #endif
  51
  52 #ifndef APCMAIN
  53 # define APCMAIN 0
  54 #endif
  55
  56 #define NISPORT 3551
  57 #define MAXSTRING               256
  58 #define MODULE_NAME "apcups"
  59
  60 #define APCUPS_DEFAULT_HOST "localhost"
  61
  62 /* Default values for contacting daemon */
  63 static char *global_host = NULL;
  64 static int   global_port = NISPORT;
  65
  66 /*
  67  * The following are only if not compiled to test the module with its own main.
  68 */
  69 #if !APCMAIN
  70 static char *bvolt_file_template = "apcups/voltage-%s.rrd";
  71 static char *bvolt_ds_def[] =
  72 {
  73         "DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":0:U",
  74 };
  75 static int bvolt_ds_num = 1;
  76
  77 static char *load_file_template = "apcups/load_percent.rrd";
  78 static char *load_ds_def[] =
  79 {
  80         "DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:110",
  81 };
  82 static int load_ds_num = 1;
  83
  84 static char *charge_file_template = "apcups/charge_percent.rrd";
  85 static char *charge_ds_def[] =
  86 {
  87         "DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:110",
  88 };
  89 static int charge_ds_num = 1;
  90
  91 static char *time_file_template = "apcups/timeleft.rrd";
  92 static char *time_ds_def[] =
  93 {
  94         "DS:timeleft:GAUGE:"COLLECTD_HEARTBEAT":0:100",
  95 };
  96 static int time_ds_num = 1;
  97
  98 static char *temp_file_template = "apcups/temperature.rrd";
  99 static char *temp_ds_def[] =
 100 {
 101         /* -273.15 is absolute zero */
 102         "DS:value:GAUGE:"COLLECTD_HEARTBEAT":-274:U",
 103 };
 104 static int temp_ds_num = 1;
 105
 106 static char *freq_file_template = "apcups/frequency-%s.rrd";
 107 static char *freq_ds_def[] =
 108 {
 109         "DS:frequency:GAUGE:"COLLECTD_HEARTBEAT":0:U",
 110 };
 111 static int freq_ds_num = 1;
 112
 113 static char *config_keys[] =
 114 {
 115         "Host",
 116         "Port",
 117         NULL
 118 };
 119 static int config_keys_num = 2;
 120
 121 #endif /* if APCMAIN */
 122
 123 struct apc_detail_s
 124 {
 125         double linev;
 126         double loadpct;
 127         double bcharge;
 128         double timeleft;
 129         double outputv;
 130         double itemp;
 131         double battv;
 132         double linefreq;
 133 };
 134
 135 #define BIG_BUF 4096
 136
 137 #if APCMAIN
 138 /* Close the network connection */
 139 static void net_close (int *fd)
 140 {
 141         uint16_t packet_size = 0;
 142
 143         assert (*fd >= 0);
 144
 145         DBG ("Gracefully shutting down socket %i.", *fd);
 146
 147         /* send EOF sentinel */
 148         swrite (*fd, (void *) &packet_size, sizeof (packet_size));
 149
 150         close (*fd);
 151         *fd = -1;
 152 }
 153 #endif /* APCMAIN */
 154
 155 /*
 156  * Open a TCP connection to the UPS network server
 157  * Returns -1 on error
 158  * Returns socket file descriptor otherwise
 159  */
 160 static int net_open (char *host, char *service, int port)
 161 {
 162         int              sd;
 163         int              status;
 164         char             port_str[8];
 165         struct addrinfo  ai_hints;
 166         struct addrinfo *ai_return;
 167         struct addrinfo *ai_list;
 168
 169         assert ((port > 0x00000000) && (port <= 0x0000FFFF));
 170
 171         /* Convert the port to a string */
 172         snprintf (port_str, 8, "%i", port);
 173         port_str[7] = '\0';
 174
 175         /* Resolve name */
 176         memset ((void *) &ai_hints, '\0', sizeof (ai_hints));
 177         ai_hints.ai_family   = AF_INET; /* XXX: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
 178         ai_hints.ai_socktype = SOCK_STREAM;
 179
 180         status = getaddrinfo (host, port_str, &ai_hints, &ai_return);
 181         if (status != 0)
 182         {
 183                 DBG ("getaddrinfo failed: %s", status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
 184                 return (-1);
 185         }
 186
 187         /* Create socket */
 188         sd = -1;
 189         for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
 190         {
 191                 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
 192                 if (sd >= 0)
 193                         break;
 194         }
 195         /* `ai_list' still holds the current description of the socket.. */
 196
 197         if (sd < 0)
 198         {
 199                 DBG ("Unable to open a socket");
 200                 freeaddrinfo (ai_return);
 201                 return (-1);
 202         }
 203
 204         status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
 205
 206         freeaddrinfo (ai_return);
 207
 208         if (status != 0) /* `connect(2)' failed */
 209         {
 210                 DBG ("connect failed: %s", strerror (errno));
 211                 return (-1);
 212         }
 213
 214         DBG ("Done opening a socket %i", sd);
 215
 216         return (sd);
 217 } /* int net_open (char *host, char *service, int port) */
 218
 219 /*
 220  * Receive a message from the other end. Each message consists of
 221  * two packets. The first is a header that contains the size
 222  * of the data that follows in the second packet.
 223  * Returns number of bytes read
 224  * Returns 0 on end of file
 225  * Returns -1 on hard end of file (i.e. network connection close)
 226  * Returns -2 on error
 227  */
 228 static int net_recv (int *sockfd, char *buf, int buflen)
 229 {
 230         uint16_t packet_size;
 231
 232         /* get data size -- in short */
 233         if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
 234         {
 235                 *sockfd = -1;
 236                 return (-1);
 237         }
 238
 239         packet_size = ntohs (packet_size);
 240         if (packet_size > buflen)
 241         {
 242                 DBG ("record length too large");
 243                 return (-2);
 244         }
 245
 246         if (packet_size == 0)
 247                 return (0);
 248
 249         /* now read the actual data */
 250         if (sread (*sockfd, (void *) buf, packet_size) != 0)
 251         {
 252                 *sockfd = -1;
 253                 return (-1);
 254         }
 255
 256         return ((int) packet_size);
 257 } /* static int net_recv (int *sockfd, char *buf, int buflen) */
 258
 259 /*
 260  * Send a message over the network. The send consists of
 261  * two network packets. The first is sends a short containing
 262  * the length of the data packet which follows.
 263  * Returns zero on success
 264  * Returns non-zero on error
 265  */
 266 static int net_send (int *sockfd, char *buff, int len)
 267 {
 268         uint16_t packet_size;
 269
 270         assert (len > 0);
 271         assert (*sockfd >= 0);
 272
 273         /* send short containing size of data packet */
 274         packet_size = htons ((uint16_t) len);
 275
 276         if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
 277         {
 278                 *sockfd = -1;
 279                 return (-1);
 280         }
 281
 282         /* send data packet */
 283         if (swrite (*sockfd, (void *) buff, len) != 0)
 284         {
 285                 *sockfd = -1;
 286                 return (-2);
 287         }
 288
 289         return (0);
 290 }
 291
 292 /* Get and print status from apcupsd NIS server */
 293 static int apc_query_server (char *host, int port,
 294                 struct apc_detail_s *apcups_detail)
 295 {
 296         int     n;
 297         char    recvline[1024];
 298         char   *tokptr;
 299         char   *key;
 300         double  value;
 301
 302         static int sockfd   = -1;
 303         static unsigned int complain = 0;
 304
 305 #if APCMAIN
 306 # define PRINT_VALUE(name, val) printf("  Found property: name = %s; value = %f;\n", name, val)
 307 #else
 308 # define PRINT_VALUE(name, val) /**/
 309 #endif
 310
 311         if (sockfd < 0)
 312         {
 313                 if ((sockfd = net_open (host, NULL, port)) < 0)
 314                 {
 315                         /* Complain once every six hours. */
 316                         int complain_step = 21600 / atoi (COLLECTD_STEP);
 317
 318                         if ((complain % complain_step) == 0)
 319                                 syslog (LOG_ERR, "apcups plugin: Connecting to the apcupsd failed.");
 320                         complain++;
 321
 322                         return (-1);
 323                 }
 324                 else if (complain > 1)
 325                 {
 326                         syslog (LOG_NOTICE, "apcups plugin: Connection re-established to the apcupsd.");
 327                         complain = 0;
 328                 }
 329         }
 330
 331         if (net_send (&sockfd, "status", 6) < 0)
 332         {
 333                 syslog (LOG_ERR, "apcups plugin: Writing to the socket failed.");
 334                 return (-1);
 335         }
 336
 337         while ((n = net_recv (&sockfd, recvline, sizeof (recvline) - 1)) > 0)
 338         {
 339                 assert (n < sizeof (recvline));
 340                 recvline[n] = '\0';
 341 #if APCMAIN
 342                 printf ("net_recv = `%s';\n", recvline);
 343 #endif /* if APCMAIN */
 344
 345                 tokptr = strtok (recvline, " :\t");
 346                 while (tokptr != NULL)
 347                 {
 348                         key = tokptr;
 349                         if ((tokptr = strtok (NULL, " :\t")) == NULL)
 350                                 continue;
 351                         value = atof (tokptr);
 352
 353                         PRINT_VALUE (key, value);
 354
 355                         if (strcmp ("LINEV", key) == 0)
 356                                 apcups_detail->linev = value;
 357                         else if (strcmp ("BATTV", key) == 0)
 358                                 apcups_detail->battv = value;
 359                         else if (strcmp ("ITEMP", key) == 0)
 360                                 apcups_detail->itemp = value;
 361                         else if (strcmp ("LOADPCT", key) == 0)
 362                                 apcups_detail->loadpct = value;
 363                         else if (strcmp ("BCHARGE", key) == 0)
 364                                 apcups_detail->bcharge = value;
 365                         else if (strcmp ("OUTPUTV", key) == 0)
 366                                 apcups_detail->outputv = value;
 367                         else if (strcmp ("LINEFREQ", key) == 0)
 368                                 apcups_detail->linefreq = value;
 369                         else if (strcmp ("TIMELEFT", key) == 0)
 370                                 apcups_detail->timeleft = value;
 371
 372                         tokptr = strtok (NULL, ":");
 373                 } /* while (tokptr != NULL) */
 374         }
 375
 376         if (n < 0)
 377         {
 378                 syslog (LOG_WARNING, "apcups plugin: Error reading from socket");
 379                 return (-1);
 380         }
 381 #if APCMAIN
 382         else
 383         {
 384                 /* close the opened socket */
 385                 net_close (&sockfd);
 386         }
 387 #endif /* APCMAIN */
 388
 389         return (0);
 390 }
 391
 392 #if APCMAIN
 393 /*
 394  * This is used for testing apcups in a standalone mode.
 395  * Usefull for debugging.
 396  */
 397 int main (int argc, char **argv)
 398 {
 399         /* we are not really going to use this */
 400         struct apc_detail_s apcups_detail;
 401
 402         openlog ("apcups", LOG_PID | LOG_NDELAY | LOG_LOCAL1, LOG_USER);
 403
 404         if (global_host == NULL || strcmp (global_host, "0.0.0.0") == 0)
 405                 global_host = "localhost";
 406
 407         if(apc_query_server (global_host, global_port, &apcups_detail) < 0)
 408         {
 409                 printf("apcups: Failed...\n");
 410                 return(-1);
 411         }
 412
 413         return 0;
 414 }
 415 #else
 416 static int apcups_config (char *key, char *value)
 417 {
 418         if (strcasecmp (key, "host") == 0)
 419         {
 420                 if (global_host != NULL)
 421                 {
 422                         free (global_host);
 423                         global_host = NULL;
 424                 }
 425                 if ((global_host = strdup (value)) == NULL)
 426                         return (1);
 427         }
 428         else if (strcasecmp (key, "Port") == 0)
 429         {
 430                 int port_tmp = atoi (value);
 431                 if (port_tmp < 1 || port_tmp > 65535)
 432                 {
 433                         syslog (LOG_WARNING, "apcups plugin: Invalid port: %i", port_tmp);
 434                         return (1);
 435                 }
 436                 global_port = port_tmp;
 437         }
 438         else
 439         {
 440                 return (-1);
 441         }
 442         return (0);
 443 }
 444
 445 static void apcups_init (void)
 446 {
 447         return;
 448 }
 449
 450 static void apc_write_voltage (char *host, char *inst, char *val)
 451 {
 452         char file[512];
 453         int  status;
 454
 455         status = snprintf (file, 512, bvolt_file_template, inst);
 456         if ((status < 1) || (status >= 512))
 457                 return;
 458
 459         rrd_update_file (host, file, val, bvolt_ds_def, bvolt_ds_num);
 460 }
 461
 462 static void apc_write_charge (char *host, char *inst, char *val)
 463 {
 464         rrd_update_file (host, charge_file_template, val, charge_ds_def, charge_ds_num);
 465 }
 466
 467 static void apc_write_percent (char *host, char *inst, char *val)
 468 {
 469         rrd_update_file (host, load_file_template, val, load_ds_def, load_ds_num);
 470 }
 471
 472 static void apc_write_timeleft (char *host, char *inst, char *val)
 473 {
 474         rrd_update_file (host, time_file_template, val, time_ds_def, time_ds_num);
 475 }
 476
 477 static void apc_write_temperature (char *host, char *inst, char *val)
 478 {
 479         rrd_update_file (host, temp_file_template, val, temp_ds_def, temp_ds_num);
 480 }
 481
 482 static void apc_write_frequency (char *host, char *inst, char *val)
 483 {
 484         char file[512];
 485         int  status;
 486
 487         status = snprintf (file, 512, freq_file_template, inst);
 488         if ((status < 1) || (status >= 512))
 489                 return;
 490
 491         rrd_update_file (host, file, val, freq_ds_def, freq_ds_num);
 492 }
 493
 494 static void apc_submit_generic (char *type, char *inst,
 495                 double value)
 496 {
 497         char buf[512];
 498         int  status;
 499
 500         status = snprintf (buf, 512, "%u:%f",
 501                         (unsigned int) curtime, value);
 502         if ((status < 1) || (status >= 512))
 503                 return;
 504
 505         DBG ("plugin_submit (%s, %s, %s);", type, inst, buf);
 506         plugin_submit (type, inst, buf);
 507 }
 508
 509 static void apc_submit (struct apc_detail_s *apcups_detail)
 510 {
 511         apc_submit_generic ("apcups_voltage",    "input",   apcups_detail->linev);
 512         apc_submit_generic ("apcups_voltage",    "output",  apcups_detail->outputv);
 513         apc_submit_generic ("apcups_voltage",    "battery", apcups_detail->battv);
 514         apc_submit_generic ("apcups_charge",     "-",       apcups_detail->bcharge);
 515         apc_submit_generic ("apcups_charge_pct", "-",       apcups_detail->loadpct);
 516         apc_submit_generic ("apcups_timeleft",   "-",       apcups_detail->timeleft);
 517         apc_submit_generic ("apcups_temp",       "-",       apcups_detail->itemp);
 518         apc_submit_generic ("apcups_frequency",  "input",   apcups_detail->linefreq);
 519 }
 520
 521 static void apcups_read (void)
 522 {
 523         struct apc_detail_s apcups_detail;
 524         int status;
 525
 526         apcups_detail.linev    =   -1.0;
 527         apcups_detail.outputv  =   -1.0;
 528         apcups_detail.battv    =   -1.0;
 529         apcups_detail.loadpct  =   -1.0;
 530         apcups_detail.bcharge  =   -1.0;
 531         apcups_detail.timeleft =   -1.0;
 532         apcups_detail.itemp    = -300.0;
 533         apcups_detail.linefreq =   -1.0;
 534
 535         status = apc_query_server (global_host == NULL
 536                         ? APCUPS_DEFAULT_HOST
 537                         : global_host,
 538                         global_port, &apcups_detail);
 539
 540         /*
 541          * if we did not connect then do not bother submitting
 542          * zeros. We want rrd files to have NAN.
 543          */
 544         if (status != 0)
 545         {
 546                 DBG ("apc_query_server (%s, %i) = %i",
 547                                 global_host == NULL
 548                                 ? APCUPS_DEFAULT_HOST
 549                                 : global_host,
 550                                 global_port, status);
 551                 return;
 552         }
 553
 554         apc_submit (&apcups_detail);
 555 } /* apcups_read */
 556
 557 void module_register (void)
 558 {
 559         plugin_register (MODULE_NAME, apcups_init, apcups_read, NULL);
 560         plugin_register ("apcups_voltage",    NULL, NULL, apc_write_voltage);
 561         plugin_register ("apcups_charge",     NULL, NULL, apc_write_charge);
 562         plugin_register ("apcups_charge_pct", NULL, NULL, apc_write_percent);
 563         plugin_register ("apcups_timeleft",   NULL, NULL, apc_write_timeleft);
 564         plugin_register ("apcups_temp",       NULL, NULL, apc_write_temperature);
 565         plugin_register ("apcups_frequency",  NULL, NULL, apc_write_frequency);
 566         cf_register (MODULE_NAME, apcups_config, config_keys, config_keys_num);
 567 }
 568
 569 #endif /* if APCMAIN */
 570 #undef MODULE_NAME