src/apcups.c

   1 /*
   2  * collectd - src/apcups.c
   3  * Copyright (C) 2006-2015  Florian octo Forster
   4  * Copyright (C) 2006       Anthony Gialluca <tonyabg at charter.net>
   5  * Copyright (C) 2000-2004  Kern Sibbald
   6  * Copyright (C) 1996-1999  Andre M. Hedrick <andre at suse.com>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of version 2 of the GNU General
  10  * Public License as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public
  18  * License along with this program; if not, write to the Free
  19  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA 02111-1307, USA.
  21  *
  22  * Authors:
  23  *   Anthony Gialluca <tonyabg at charter.net>
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"      /* rrd_update_file */
  30 #include "plugin.h"      /* plugin_register, plugin_submit */
  31
  32 #if HAVE_SYS_TYPES_H
  33 # include <sys/types.h>
  34 #endif
  35 #if HAVE_NETDB_H
  36 # include <netdb.h>
  37 #endif
  38
  39 #if HAVE_NETINET_IN_H
  40 # include <netinet/in.h>
  41 #endif
  42
  43 #ifndef APCUPS_SERVER_TIMEOUT
  44 # define APCUPS_SERVER_TIMEOUT 15.0
  45 #endif
  46
  47 #ifndef APCUPS_DEFAULT_NODE
  48 # define APCUPS_DEFAULT_NODE "localhost"
  49 #endif
  50
  51 #ifndef APCUPS_DEFAULT_SERVICE
  52 # define APCUPS_DEFAULT_SERVICE "3551"
  53 #endif
  54
  55 /*
  56  * Private data types
  57  */
  58 struct apc_detail_s
  59 {
  60         double linev;
  61         double loadpct;
  62         double bcharge;
  63         double timeleft;
  64         double outputv;
  65         double itemp;
  66         double battv;
  67         double linefreq;
  68 };
  69
  70 /*
  71  * Private variables
  72  */
  73 /* Default values for contacting daemon */
  74 static char *conf_node = NULL;
  75 static char *conf_service = NULL;
  76 /* Defaults to false for backwards compatibility. */
  77 static _Bool conf_report_seconds = 0;
  78 static _Bool conf_persistent_conn = 1;
  79
  80 static int global_sockfd = -1;
  81
  82 static int count_retries = 0;
  83 static int count_iterations = 0;
  84
  85 static int net_shutdown (int *fd)
  86 {
  87         uint16_t packet_size = 0;
  88
  89         if ((fd == NULL) || (*fd < 0))
  90                 return (EINVAL);
  91
  92         (void)swrite (*fd, (void *) &packet_size, sizeof (packet_size));
  93         close (*fd);
  94         *fd = -1;
  95
  96         return (0);
  97 } /* int net_shutdown */
  98
  99 /* Close the network connection */
 100 static int apcups_shutdown (void)
 101 {
 102         if (global_sockfd < 0)
 103                 return (0);
 104
 105         net_shutdown (&global_sockfd);
 106         return (0);
 107 } /* int apcups_shutdown */
 108
 109 /*
 110  * Open a TCP connection to the UPS network server
 111  * Returns -1 on error
 112  * Returns socket file descriptor otherwise
 113  */
 114 static int net_open (char const *node, char const *service)
 115 {
 116         int              sd;
 117         int              status;
 118         struct addrinfo *ai_return;
 119         struct addrinfo *ai_list;
 120
 121         /* TODO: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
 122         struct addrinfo ai_hints = {
 123                 .ai_family = AF_INET,
 124                 .ai_socktype = SOCK_STREAM
 125         };
 126
 127         status = getaddrinfo (node, service, &ai_hints, &ai_return);
 128         if (status != 0)
 129         {
 130                 char errbuf[1024];
 131                 INFO ("apcups plugin: getaddrinfo failed: %s",
 132                                 (status == EAI_SYSTEM)
 133                                 ? sstrerror (errno, errbuf, sizeof (errbuf))
 134                                 : gai_strerror (status));
 135                 return (-1);
 136         }
 137
 138         /* Create socket */
 139         sd = -1;
 140         for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
 141         {
 142                 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
 143                 if (sd >= 0)
 144                         break;
 145         }
 146         /* `ai_list' still holds the current description of the socket.. */
 147
 148         if (sd < 0)
 149         {
 150                 DEBUG ("apcups plugin: Unable to open a socket");
 151                 freeaddrinfo (ai_return);
 152                 return (-1);
 153         }
 154
 155         status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
 156
 157         freeaddrinfo (ai_return);
 158
 159         if (status != 0) /* `connect(2)' failed */
 160         {
 161                 char errbuf[1024];
 162                 INFO ("apcups plugin: connect failed: %s",
 163                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 164                 close (sd);
 165                 return (-1);
 166         }
 167
 168         DEBUG ("apcups plugin: Done opening a socket %i", sd);
 169
 170         return (sd);
 171 } /* int net_open */
 172
 173 /*
 174  * Receive a message from the other end. Each message consists of
 175  * two packets. The first is a header that contains the size
 176  * of the data that follows in the second packet.
 177  * Returns number of bytes read
 178  * Returns 0 on end of file
 179  * Returns -1 on hard end of file (i.e. network connection close)
 180  * Returns -2 on error
 181  */
 182 static int net_recv (int *sockfd, char *buf, int buflen)
 183 {
 184         uint16_t packet_size;
 185
 186         /* get data size -- in short */
 187         if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
 188         {
 189                 close (*sockfd);
 190                 *sockfd = -1;
 191                 return (-1);
 192         }
 193
 194         packet_size = ntohs (packet_size);
 195         if (packet_size > buflen)
 196         {
 197                 ERROR ("apcups plugin: Received %"PRIu16" bytes of payload "
 198                                 "but have only %i bytes of buffer available.",
 199                                 packet_size, buflen);
 200                 close (*sockfd);
 201                 *sockfd = -1;
 202                 return (-2);
 203         }
 204
 205         if (packet_size == 0)
 206                 return (0);
 207
 208         /* now read the actual data */
 209         if (sread (*sockfd, (void *) buf, packet_size) != 0)
 210         {
 211                 close (*sockfd);
 212                 *sockfd = -1;
 213                 return (-1);
 214         }
 215
 216         return ((int) packet_size);
 217 } /* static int net_recv (int *sockfd, char *buf, int buflen) */
 218
 219 /*
 220  * Send a message over the network. The send consists of
 221  * two network packets. The first is sends a short containing
 222  * the length of the data packet which follows.
 223  * Returns zero on success
 224  * Returns non-zero on error
 225  */
 226 static int net_send (int *sockfd, const char *buff, int len)
 227 {
 228         uint16_t packet_size;
 229
 230         assert (len > 0);
 231         assert (*sockfd >= 0);
 232
 233         /* send short containing size of data packet */
 234         packet_size = htons ((uint16_t) len);
 235
 236         if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
 237         {
 238                 close (*sockfd);
 239                 *sockfd = -1;
 240                 return (-1);
 241         }
 242
 243         /* send data packet */
 244         if (swrite (*sockfd, (void *) buff, len) != 0)
 245         {
 246                 close (*sockfd);
 247                 *sockfd = -1;
 248                 return (-2);
 249         }
 250
 251         return (0);
 252 }
 253
 254 /* Get and print status from apcupsd NIS server */
 255 static int apc_query_server (char const *node, char const *service,
 256                 struct apc_detail_s *apcups_detail)
 257 {
 258         int     n;
 259         char    recvline[1024];
 260         char   *tokptr;
 261         char   *toksaveptr;
 262         char   *key;
 263         double  value;
 264         _Bool retry = 1;
 265         int status;
 266
 267 #if APCMAIN
 268 # define PRINT_VALUE(name, val) printf("  Found property: name = %s; value = %f;\n", name, val)
 269 #else
 270 # define PRINT_VALUE(name, val) /**/
 271 #endif
 272
 273         while (retry)
 274         {
 275                 if (global_sockfd < 0)
 276                 {
 277                         global_sockfd = net_open (node, service);
 278                         if (global_sockfd < 0)
 279                         {
 280                                 ERROR ("apcups plugin: Connecting to the "
 281                                                 "apcupsd failed.");
 282                                 return (-1);
 283                         }
 284                 }
 285
 286
 287                 status = net_send (&global_sockfd, "status", strlen ("status"));
 288                 if (status != 0)
 289                 {
 290                         /* net_send is closing the socket on error. */
 291                         assert (global_sockfd < 0);
 292                         if (retry)
 293                         {
 294                                 retry = 0;
 295                                 count_retries++;
 296                                 continue;
 297                         }
 298
 299                         ERROR ("apcups plugin: Writing to the socket failed.");
 300                         return (-1);
 301                 }
 302
 303                 break;
 304         } /* while (retry) */
 305
 306         /* When collectd's collection interval is larger than apcupsd's
 307          * timeout, we would have to retry / re-connect each iteration. Try to
 308          * detect this situation and shut down the socket gracefully in that
 309          * case. Otherwise, keep the socket open to avoid overhead. */
 310         count_iterations++;
 311         if ((count_iterations == 10) && (count_retries > 2))
 312         {
 313                 NOTICE ("apcups plugin: There have been %i retries in the "
 314                                 "first %i iterations. Will close the socket "
 315                                 "in future iterations.",
 316                                 count_retries, count_iterations);
 317                 conf_persistent_conn = 0;
 318         }
 319
 320         while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
 321         {
 322                 assert ((size_t)n < sizeof (recvline));
 323                 recvline[n] = 0;
 324 #if APCMAIN
 325                 printf ("net_recv = `%s';\n", recvline);
 326 #endif /* if APCMAIN */
 327
 328                 toksaveptr = NULL;
 329                 tokptr = strtok_r (recvline, " :\t", &toksaveptr);
 330                 while (tokptr != NULL)
 331                 {
 332                         key = tokptr;
 333                         if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == NULL)
 334                                 continue;
 335                         value = atof (tokptr);
 336
 337                         PRINT_VALUE (key, value);
 338
 339                         if (strcmp ("LINEV", key) == 0)
 340                                 apcups_detail->linev = value;
 341                         else if (strcmp ("BATTV", key) == 0)
 342                                 apcups_detail->battv = value;
 343                         else if (strcmp ("ITEMP", key) == 0)
 344                                 apcups_detail->itemp = value;
 345                         else if (strcmp ("LOADPCT", key) == 0)
 346                                 apcups_detail->loadpct = value;
 347                         else if (strcmp ("BCHARGE", key) == 0)
 348                                 apcups_detail->bcharge = value;
 349                         else if (strcmp ("OUTPUTV", key) == 0)
 350                                 apcups_detail->outputv = value;
 351                         else if (strcmp ("LINEFREQ", key) == 0)
 352                                 apcups_detail->linefreq = value;
 353                         else if (strcmp ("TIMELEFT", key) == 0)
 354                         {
 355                                 /* Convert minutes to seconds if requested by
 356                                  * the user. */
 357                                 if (conf_report_seconds)
 358                                         value *= 60.0;
 359                                 apcups_detail->timeleft = value;
 360                         }
 361
 362                         tokptr = strtok_r (NULL, ":", &toksaveptr);
 363                 } /* while (tokptr != NULL) */
 364         }
 365         status = errno; /* save errno, net_shutdown() may re-set it. */
 366
 367         if (!conf_persistent_conn)
 368                 net_shutdown (&global_sockfd);
 369
 370         if (n < 0)
 371         {
 372                 char errbuf[1024];
 373                 ERROR ("apcups plugin: Reading from socket failed: %s",
 374                                 sstrerror (status, errbuf, sizeof (errbuf)));
 375                 return (-1);
 376         }
 377
 378         return (0);
 379 }
 380
 381 static int apcups_config (oconfig_item_t *ci)
 382 {
 383         _Bool persistent_conn_set = 0;
 384
 385         for (int i = 0; i < ci->children_num; i++)
 386         {
 387                 oconfig_item_t *child = ci->children + i;
 388
 389                 if (strcasecmp (child->key, "Host") == 0)
 390                         cf_util_get_string (child, &conf_node);
 391                 else if (strcasecmp (child->key, "Port") == 0)
 392                         cf_util_get_service (child, &conf_service);
 393                 else if (strcasecmp (child->key, "ReportSeconds") == 0)
 394                         cf_util_get_boolean (child, &conf_report_seconds);
 395                 else if (strcasecmp (child->key, "PersistentConnection") == 0) {
 396                         cf_util_get_boolean (child, &conf_persistent_conn);
 397                         persistent_conn_set = 1;
 398                 }
 399                 else
 400                         ERROR ("apcups plugin: Unknown config option \"%s\".", child->key);
 401         }
 402
 403         if (!persistent_conn_set) {
 404                 double interval = CDTIME_T_TO_DOUBLE(plugin_get_interval());
 405                 if (interval > APCUPS_SERVER_TIMEOUT) {
 406                         NOTICE ("apcups plugin: Plugin poll interval set to %.3f seconds. "
 407                                 "Apcupsd NIS socket timeout is %.3f seconds, "
 408                                 "PersistentConnection disabled by default.",
 409                                 interval, APCUPS_SERVER_TIMEOUT);
 410                         conf_persistent_conn = 0;
 411                 }
 412         }
 413
 414         return (0);
 415 } /* int apcups_config */
 416
 417 static void apc_submit_generic (const char *type, const char *type_inst, double value)
 418 {
 419         value_list_t vl = VALUE_LIST_INIT;
 420
 421         vl.values = &(value_t) { .gauge = value };
 422         vl.values_len = 1;
 423         sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin));
 424         sstrncpy (vl.type, type, sizeof (vl.type));
 425         sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
 426
 427         plugin_dispatch_values (&vl);
 428 }
 429
 430 static void apc_submit (struct apc_detail_s *apcups_detail)
 431 {
 432         apc_submit_generic ("voltage",    "input",   apcups_detail->linev);
 433         apc_submit_generic ("voltage",    "output",  apcups_detail->outputv);
 434         apc_submit_generic ("voltage",    "battery", apcups_detail->battv);
 435         apc_submit_generic ("charge",     "",        apcups_detail->bcharge);
 436         apc_submit_generic ("percent",    "load",    apcups_detail->loadpct);
 437         apc_submit_generic ("timeleft",   "",        apcups_detail->timeleft);
 438         apc_submit_generic ("temperature", "",       apcups_detail->itemp);
 439         apc_submit_generic ("frequency",  "input",   apcups_detail->linefreq);
 440 }
 441
 442 static int apcups_read (void)
 443 {
 444         struct apc_detail_s apcups_detail;
 445         int status;
 446
 447         apcups_detail.linev    =   -1.0;
 448         apcups_detail.outputv  =   -1.0;
 449         apcups_detail.battv    =   -1.0;
 450         apcups_detail.loadpct  =   -1.0;
 451         apcups_detail.bcharge  =   -1.0;
 452         apcups_detail.timeleft =    NAN;
 453         apcups_detail.itemp    = -300.0;
 454         apcups_detail.linefreq =   -1.0;
 455
 456         status = apc_query_server ((conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
 457                         (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
 458                         &apcups_detail);
 459
 460         /*
 461          * if we did not connect then do not bother submitting
 462          * zeros. We want rrd files to have NAN.
 463          */
 464         if (status != 0)
 465         {
 466                 DEBUG ("apcups plugin: apc_query_server (%s, %s) = %i",
 467                                 (conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
 468                                 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
 469                                 status);
 470                 return (-1);
 471         }
 472
 473         apc_submit (&apcups_detail);
 474
 475         return (0);
 476 } /* apcups_read */
 477
 478 void module_register (void)
 479 {
 480         plugin_register_complex_config ("apcups", apcups_config);
 481         plugin_register_read ("apcups", apcups_read);
 482         plugin_register_shutdown ("apcups", apcups_shutdown);
 483 } /* void module_register */