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>
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.
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.
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,
22 * Anthony Gialluca <tonyabg at charter.net>
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.
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"
39 # include <sys/types.h>
42 # include <sys/socket.h>
49 # include <netinet/in.h>
58 #define MODULE_NAME "apcups"
60 #define APCUPS_DEFAULT_HOST "localhost"
62 /* Default values for contacting daemon */
63 static char *global_host = NULL;
64 static int global_port = NISPORT;
67 * The following are only if not compiled to test the module with its own main.
70 static char *bvolt_file_template = "apcups/voltage-%s.rrd";
71 static char *bvolt_ds_def[] =
73 "DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":0:U",
75 static int bvolt_ds_num = 1;
77 static char *load_file_template = "apcups/load_percent.rrd";
78 static char *load_ds_def[] =
80 "DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:110",
82 static int load_ds_num = 1;
84 static char *charge_file_template = "apcups/charge_percent.rrd";
85 static char *charge_ds_def[] =
87 "DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:110",
89 static int charge_ds_num = 1;
91 static char *time_file_template = "apcups/timeleft.rrd";
92 static char *time_ds_def[] =
94 "DS:timeleft:GAUGE:"COLLECTD_HEARTBEAT":0:100",
96 static int time_ds_num = 1;
98 static char *temp_file_template = "apcups/temperature.rrd";
99 static char *temp_ds_def[] =
101 /* -273.15 is absolute zero */
102 "DS:value:GAUGE:"COLLECTD_HEARTBEAT":-274:U",
104 static int temp_ds_num = 1;
106 static char *freq_file_template = "apcups/frequency-%s.rrd";
107 static char *freq_ds_def[] =
109 "DS:frequency:GAUGE:"COLLECTD_HEARTBEAT":0:U",
111 static int freq_ds_num = 1;
113 static char *config_keys[] =
119 static int config_keys_num = 2;
121 #endif /* if APCMAIN */
138 * Read nbytes from the network.
139 * It is possible that the total bytes require in several
142 static int read_nbytes (int *fd, char *ptr, int nbytes)
152 while ((nleft > 0) && (nread != 0))
154 nread = read (*fd, ptr, nleft);
156 if ((nread < 0) && (errno == EINTR || errno == EAGAIN))
162 DBG ("Reading from socket failed failed: %s; *fd = -1;", strerror (errno));
163 syslog (LOG_ERR, "apcups plugin: Reading from socket failed failed: %s", strerror (errno));
169 DBG ("Received EOF. Closing socket %i.", *fd);
172 return (nbytes - nleft);
179 return (nbytes - nleft);
183 * Write nbytes to the network.
184 * It may require several writes.
186 static int write_nbytes (int *fd, void *buf, int buflen)
200 nwritten = write (*fd, ptr, nleft);
202 if ((nwritten < 0) && ((errno == EAGAIN) || (errno == EINTR)))
208 DBG ("Writing to socket failed: %s; *fd = -1;", strerror (errno));
209 syslog (LOG_ERR, "apcups plugin: Writing to socket failed: %s", strerror (errno));
217 /* If we get here, (nleft <= 0) is true */
222 /* Close the network connection */
223 static void net_close (int *fd)
229 DBG ("Gracefully shutting down socket %i.", *fd);
231 /* send EOF sentinel */
232 write_nbytes (fd, &pktsiz, sizeof (short));
240 * Open a TCP connection to the UPS network server
241 * Returns -1 on error
242 * Returns socket file descriptor otherwise
244 static int net_open (char *host, char *service, int port)
249 struct addrinfo ai_hints;
250 struct addrinfo *ai_return;
251 struct addrinfo *ai_list;
253 assert ((port > 0x00000000) && (port <= 0x0000FFFF));
255 /* Convert the port to a string */
256 snprintf (port_str, 8, "%i", port);
260 memset ((void *) &ai_hints, '\0', sizeof (ai_hints));
261 ai_hints.ai_family = AF_INET; /* XXX: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
262 ai_hints.ai_socktype = SOCK_STREAM;
264 status = getaddrinfo (host, port_str, &ai_hints, &ai_return);
267 DBG ("getaddrinfo failed: %s", status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status));
273 for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
275 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
279 /* `ai_list' still holds the current description of the socket.. */
283 DBG ("Unable to open a socket");
284 freeaddrinfo (ai_return);
288 status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
290 freeaddrinfo (ai_return);
292 if (status != 0) /* `connect(2)' failed */
294 DBG ("connect failed: %s", strerror (errno));
298 DBG ("Done opening a socket %i", sd);
301 } /* int net_open (char *host, char *service, int port) */
304 * Receive a message from the other end. Each message consists of
305 * two packets. The first is a header that contains the size
306 * of the data that follows in the second packet.
307 * Returns number of bytes read
308 * Returns 0 on end of file
309 * Returns -1 on hard end of file (i.e. network connection close)
310 * Returns -2 on error
312 static int net_recv (int *sockfd, char *buf, int buflen)
317 /* get data size -- in short */
318 if ((nbytes = read_nbytes (sockfd, (char *) &pktsiz, sizeof (short))) <= 0)
321 if (nbytes != sizeof (short))
324 pktsiz = ntohs (pktsiz);
327 DBG ("record length too large");
334 /* now read the actual data */
335 if ((nbytes = read_nbytes (sockfd, buf, pktsiz)) <= 0)
338 if (nbytes != pktsiz)
342 } /* static int net_recv (int sockfd, char *buf, int buflen) */
345 * Send a message over the network. The send consists of
346 * two network packets. The first is sends a short containing
347 * the length of the data packet which follows.
348 * Returns zero on success
349 * Returns non-zero on error
351 static int net_send (int *sockfd, char *buff, int len)
357 assert (*sockfd >= 0);
359 /* send short containing size of data packet */
360 packet_size = htons ((short) len);
362 rc = write_nbytes (sockfd, &packet_size, sizeof (packet_size));
363 if (rc != sizeof (packet_size))
366 /* send data packet */
367 rc = write_nbytes (sockfd, buff, len);
374 /* Get and print status from apcupsd NIS server */
375 static int apc_query_server (char *host, int port,
376 struct apc_detail_s *apcups_detail)
384 static int sockfd = -1;
385 static unsigned int complain = 0;
388 # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val)
390 # define PRINT_VALUE(name, val) /**/
395 if ((sockfd = net_open (host, NULL, port)) < 0)
397 /* Complain once every six hours. */
398 int complain_step = 21600 / atoi (COLLECTD_STEP);
400 if ((complain % complain_step) == 0)
401 syslog (LOG_ERR, "apcups plugin: Connecting to the apcupsd failed.");
406 else if (complain > 1)
408 syslog (LOG_NOTICE, "apcups plugin: Connection re-established to the apcupsd.");
413 if (net_send (&sockfd, "status", 6) < 0)
415 syslog (LOG_ERR, "apcups plugin: Writing to the socket failed.");
419 while ((n = net_recv (&sockfd, recvline, sizeof (recvline) - 1)) > 0)
421 assert (n < sizeof (recvline));
424 printf ("net_recv = `%s';\n", recvline);
425 #endif /* if APCMAIN */
427 tokptr = strtok (recvline, " :\t");
428 while (tokptr != NULL)
431 if ((tokptr = strtok (NULL, " :\t")) == NULL)
433 value = atof (tokptr);
435 PRINT_VALUE (key, value);
437 if (strcmp ("LINEV", key) == 0)
438 apcups_detail->linev = value;
439 else if (strcmp ("BATTV", key) == 0)
440 apcups_detail->battv = value;
441 else if (strcmp ("ITEMP", key) == 0)
442 apcups_detail->itemp = value;
443 else if (strcmp ("LOADPCT", key) == 0)
444 apcups_detail->loadpct = value;
445 else if (strcmp ("BCHARGE", key) == 0)
446 apcups_detail->bcharge = value;
447 else if (strcmp ("OUTPUTV", key) == 0)
448 apcups_detail->outputv = value;
449 else if (strcmp ("LINEFREQ", key) == 0)
450 apcups_detail->linefreq = value;
451 else if (strcmp ("TIMELEFT", key) == 0)
452 apcups_detail->timeleft = value;
454 tokptr = strtok (NULL, ":");
455 } /* while (tokptr != NULL) */
460 syslog (LOG_WARNING, "apcups plugin: Error reading from socket");
466 /* close the opened socket */
476 * This is used for testing apcups in a standalone mode.
477 * Usefull for debugging.
479 int main (int argc, char **argv)
481 /* we are not really going to use this */
482 struct apc_detail_s apcups_detail;
484 openlog ("apcups", LOG_PID | LOG_NDELAY | LOG_LOCAL1, LOG_USER);
486 if (global_host == NULL || strcmp (global_host, "0.0.0.0") == 0)
487 global_host = "localhost";
489 if(apc_query_server (global_host, global_port, &apcups_detail) < 0)
491 printf("apcups: Failed...\n");
498 static int apcups_config (char *key, char *value)
500 if (strcasecmp (key, "host") == 0)
502 if (global_host != NULL)
507 if ((global_host = strdup (value)) == NULL)
510 else if (strcasecmp (key, "Port") == 0)
512 int port_tmp = atoi (value);
513 if (port_tmp < 1 || port_tmp > 65535)
515 syslog (LOG_WARNING, "apcups plugin: Invalid port: %i", port_tmp);
518 global_port = port_tmp;
527 static void apcups_init (void)
532 static void apc_write_voltage (char *host, char *inst, char *val)
537 status = snprintf (file, 512, bvolt_file_template, inst);
538 if ((status < 1) || (status >= 512))
541 rrd_update_file (host, file, val, bvolt_ds_def, bvolt_ds_num);
544 static void apc_write_charge (char *host, char *inst, char *val)
546 rrd_update_file (host, charge_file_template, val, charge_ds_def, charge_ds_num);
549 static void apc_write_percent (char *host, char *inst, char *val)
551 rrd_update_file (host, load_file_template, val, load_ds_def, load_ds_num);
554 static void apc_write_timeleft (char *host, char *inst, char *val)
556 rrd_update_file (host, time_file_template, val, time_ds_def, time_ds_num);
559 static void apc_write_temperature (char *host, char *inst, char *val)
561 rrd_update_file (host, temp_file_template, val, temp_ds_def, temp_ds_num);
564 static void apc_write_frequency (char *host, char *inst, char *val)
569 status = snprintf (file, 512, freq_file_template, inst);
570 if ((status < 1) || (status >= 512))
573 rrd_update_file (host, file, val, freq_ds_def, freq_ds_num);
576 static void apc_submit_generic (char *type, char *inst,
582 status = snprintf (buf, 512, "%u:%f",
583 (unsigned int) curtime, value);
584 if ((status < 1) || (status >= 512))
587 DBG ("plugin_submit (%s, %s, %s);", type, inst, buf);
588 plugin_submit (type, inst, buf);
591 static void apc_submit (struct apc_detail_s *apcups_detail)
593 apc_submit_generic ("apcups_voltage", "input", apcups_detail->linev);
594 apc_submit_generic ("apcups_voltage", "output", apcups_detail->outputv);
595 apc_submit_generic ("apcups_voltage", "battery", apcups_detail->battv);
596 apc_submit_generic ("apcups_charge", "-", apcups_detail->bcharge);
597 apc_submit_generic ("apcups_charge_pct", "-", apcups_detail->loadpct);
598 apc_submit_generic ("apcups_timeleft", "-", apcups_detail->timeleft);
599 apc_submit_generic ("apcups_temp", "-", apcups_detail->itemp);
600 apc_submit_generic ("apcups_frequency", "input", apcups_detail->linefreq);
603 static void apcups_read (void)
605 struct apc_detail_s apcups_detail;
608 apcups_detail.linev = -1.0;
609 apcups_detail.outputv = -1.0;
610 apcups_detail.battv = -1.0;
611 apcups_detail.loadpct = -1.0;
612 apcups_detail.bcharge = -1.0;
613 apcups_detail.timeleft = -1.0;
614 apcups_detail.itemp = -300.0;
615 apcups_detail.linefreq = -1.0;
617 status = apc_query_server (global_host == NULL
618 ? APCUPS_DEFAULT_HOST
620 global_port, &apcups_detail);
623 * if we did not connect then do not bother submitting
624 * zeros. We want rrd files to have NAN.
628 DBG ("apc_query_server (%s, %i) = %i",
630 ? APCUPS_DEFAULT_HOST
632 global_port, status);
636 apc_submit (&apcups_detail);
639 void module_register (void)
641 plugin_register (MODULE_NAME, apcups_init, apcups_read, NULL);
642 plugin_register ("apcups_voltage", NULL, NULL, apc_write_voltage);
643 plugin_register ("apcups_charge", NULL, NULL, apc_write_charge);
644 plugin_register ("apcups_charge_pct", NULL, NULL, apc_write_percent);
645 plugin_register ("apcups_timeleft", NULL, NULL, apc_write_timeleft);
646 plugin_register ("apcups_temp", NULL, NULL, apc_write_temperature);
647 plugin_register ("apcups_frequency", NULL, NULL, apc_write_frequency);
648 cf_register (MODULE_NAME, apcups_config, config_keys, config_keys_num);
651 #endif /* if APCMAIN */