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