X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fapcups.c;h=4f0bdfa69f8b64593e6b669a0c919c91cf89cdfb;hb=5e73df5f8ec52055e5f79be5d898e5baec4c9967;hp=f879f7c8a183f6ef77dad33dab3b400e6a808f8c;hpb=6085380c74939d50fba6a5c72cc16512f138ddbb;p=collectd.git diff --git a/src/apcups.c b/src/apcups.c index f879f7c8..4f0bdfa6 100644 --- a/src/apcups.c +++ b/src/apcups.c @@ -1,9 +1,11 @@ /* * collectd - src/apcups.c + * Copyright (C) 2007 Florian octo Forster * Copyright (C) 2006 Anthony Gialluca * Copyright (C) 2000-2004 Kern Sibbald * Copyright (C) 1996-99 Andre M. Hedrick * + * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2 of the GNU General * Public License as published by the Free Software Foundation. @@ -33,7 +35,6 @@ #include "common.h" /* rrd_update_file */ #include "plugin.h" /* plugin_register, plugin_submit */ #include "configfile.h" /* cf_register */ -#include "utils_debug.h" #if HAVE_SYS_TYPES_H # include @@ -44,79 +45,20 @@ #if HAVE_NETDB_H # include #endif + #if HAVE_NETINET_IN_H # include #endif -#ifndef APCMAIN -# define APCMAIN 0 -#endif - #define NISPORT 3551 #define MAXSTRING 256 #define MODULE_NAME "apcups" -/* Default values for contacting daemon */ -static char *global_host = NULL; -static int global_port = NISPORT; - -/* - * The following are only if not compiled to test the module with its own main. -*/ -#if !APCMAIN -static char *bvolt_file_template = "apcups/voltage-%s.rrd"; -static char *bvolt_ds_def[] = -{ - "DS:voltage:GAUGE:"COLLECTD_HEARTBEAT":0:U", -}; -static int bvolt_ds_num = 1; - -static char *load_file_template = "apcups/charge_percent.rrd"; -static char *load_ds_def[] = -{ - "DS:percent:GAUGE:"COLLECTD_HEARTBEAT":0:100", -}; -static int load_ds_num = 1; - -static char *charge_file_template = "apcups/charge.rrd"; -static char *charge_ds_def[] = -{ - "DS:charge:GAUGE:"COLLECTD_HEARTBEAT":0:U", -}; -static int charge_ds_num = 1; - -static char *time_file_template = "apcups/time.rrd"; -static char *time_ds_def[] = -{ - "DS:timeleft:GAUGE:"COLLECTD_HEARTBEAT":0:100", -}; -static int time_ds_num = 1; - -static char *temp_file_template = "apcups/temperature.rrd"; -static char *temp_ds_def[] = -{ - /* -273.15 is absolute zero */ - "DS:temperature:GAUGE:"COLLECTD_HEARTBEAT":-274:U", -}; -static int temp_ds_num = 1; - -static char *freq_file_template = "apcups/frequency-%s.rrd"; -static char *freq_ds_def[] = -{ - "DS:frequency:GAUGE:"COLLECTD_HEARTBEAT":0:U", -}; -static int freq_ds_num = 1; - -static char *config_keys[] = -{ - "Host", - "Port", - NULL -}; -static int config_keys_num = 2; - -#endif /* if APCMAIN */ +#define APCUPS_DEFAULT_HOST "localhost" +/* + * Private data types + */ struct apc_detail_s { double linev; @@ -129,98 +71,41 @@ struct apc_detail_s double linefreq; }; -#define BIG_BUF 4096 - /* - * Read nbytes from the network. - * It is possible that the total bytes require in several - * read requests + * Private variables */ -static int read_nbytes (int *fd, char *ptr, int nbytes) -{ - int nleft; - int nread; - - nleft = nbytes; - nread = -1; - - assert (*fd >= 0); - - while ((nleft > 0) && (nread != 0)) - { - nread = read (*fd, ptr, nleft); - - if (nread == -1 && (errno == EINTR || errno == EAGAIN)) - continue; - - if (nread == -1) - { - *fd = -1; - syslog (LOG_ERR, "apcups plugin: write failed: %s", strerror (errno)); - return (-1); - } +/* Default values for contacting daemon */ +static char *conf_host = NULL; +static int conf_port = NISPORT; - nleft -= nread; - ptr += nread; - } +static int global_sockfd = -1; - return (nbytes - nleft); -} - -/* - * Write nbytes to the network. - * It may require several writes. - */ -static int write_nbytes (int *fd, void *buf, int buflen) +static const char *config_keys[] = { - int nleft; - int nwritten; - char *ptr; - - assert (buflen > 0); - assert (*fd >= 0); - - ptr = (char *) buf; - - nleft = buflen; - while (nleft > 0) - { - nwritten = write (*fd, ptr, nleft); - - if ((nwritten == -1) && ((errno == EAGAIN) || (errno == EINTR))) - continue; - - if (nwritten == -1) - { - syslog (LOG_ERR, "Writing to socket failed: %s", strerror (errno)); - *fd = -1; - return (-1); - } - - nleft -= nwritten; - ptr += nwritten; - } - - /* If we get here, (nleft <= 0) is true */ - return (buflen); -} + "Host", + "Port", + NULL +}; +static int config_keys_num = 2; -#if 0 /* Close the network connection */ -static void net_close (int *fd) +static int apcups_shutdown (void) { - short pktsiz = 0; + uint16_t packet_size = 0; + + if (global_sockfd < 0) + return (0); - assert (*fd >= 0); + DEBUG ("Gracefully shutting down socket %i.", global_sockfd); /* send EOF sentinel */ - write_nbytes (fd, &pktsiz, sizeof (short)); + swrite (global_sockfd, (void *) &packet_size, sizeof (packet_size)); - close (*fd); - *fd = -1; -} -#endif + close (global_sockfd); + global_sockfd = -1; + return (0); +} /* int apcups_shutdown */ /* * Open a TCP connection to the UPS network server @@ -250,7 +135,11 @@ static int net_open (char *host, char *service, int port) status = getaddrinfo (host, port_str, &ai_hints, &ai_return); if (status != 0) { - DBG ("getaddrinfo failed: %s", status == EAI_SYSTEM ? strerror (errno) : gai_strerror (status)); + char errbuf[1024]; + DEBUG ("getaddrinfo failed: %s", + (status == EAI_SYSTEM) + ? sstrerror (errno, errbuf, sizeof (errbuf)) + : gai_strerror (status)); return (-1); } @@ -266,7 +155,7 @@ static int net_open (char *host, char *service, int port) if (sd < 0) { - DBG ("Unable to open a socket"); + DEBUG ("Unable to open a socket"); freeaddrinfo (ai_return); return (-1); } @@ -277,10 +166,15 @@ static int net_open (char *host, char *service, int port) if (status != 0) /* `connect(2)' failed */ { - DBG ("connect failed: %s", strerror (errno)); + char errbuf[1024]; + DEBUG ("connect failed: %s", + sstrerror (errno, errbuf, sizeof (errbuf))); + close (sd); return (-1); } + DEBUG ("Done opening a socket %i", sd); + return (sd); } /* int net_open (char *host, char *service, int port) */ @@ -295,35 +189,34 @@ static int net_open (char *host, char *service, int port) */ static int net_recv (int *sockfd, char *buf, int buflen) { - int nbytes; - short pktsiz; + uint16_t packet_size; /* get data size -- in short */ - if ((nbytes = read_nbytes (sockfd, (char *) &pktsiz, sizeof (short))) <= 0) + if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0) + { + *sockfd = -1; return (-1); + } - if (nbytes != sizeof (short)) - return (-2); - - pktsiz = ntohs (pktsiz); - if (pktsiz > buflen) + packet_size = ntohs (packet_size); + if (packet_size > buflen) { - DBG ("record length too large"); + DEBUG ("record length too large"); return (-2); } - if (pktsiz == 0) + if (packet_size == 0) return (0); /* now read the actual data */ - if ((nbytes = read_nbytes (sockfd, buf, pktsiz)) <= 0) - return (-2); - - if (nbytes != pktsiz) - return (-2); + if (sread (*sockfd, (void *) buf, packet_size) != 0) + { + *sockfd = -1; + return (-1); + } - return (nbytes); -} /* static int net_recv (int sockfd, char *buf, int buflen) */ + return ((int) packet_size); +} /* static int net_recv (int *sockfd, char *buf, int buflen) */ /* * Send a message over the network. The send consists of @@ -334,22 +227,26 @@ static int net_recv (int *sockfd, char *buf, int buflen) */ static int net_send (int *sockfd, char *buff, int len) { - int rc; - short packet_size; + uint16_t packet_size; assert (len > 0); + assert (*sockfd >= 0); /* send short containing size of data packet */ - packet_size = htons ((short) len); + packet_size = htons ((uint16_t) len); - rc = write_nbytes (sockfd, &packet_size, sizeof (packet_size)); - if (rc != sizeof (packet_size)) + if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0) + { + *sockfd = -1; return (-1); + } /* send data packet */ - rc = write_nbytes (sockfd, buff, len); - if (rc != len) - return (-1); + if (swrite (*sockfd, (void *) buff, len) != 0) + { + *sockfd = -1; + return (-2); + } return (0); } @@ -361,11 +258,11 @@ static int apc_query_server (char *host, int port, int n; char recvline[1024]; char *tokptr; + char *toksaveptr; char *key; double value; - static int sockfd = -1; - static int complain = 0; + static complain_t compl; #if APCMAIN # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val) @@ -373,30 +270,28 @@ static int apc_query_server (char *host, int port, # define PRINT_VALUE(name, val) /**/ #endif - if (sockfd < 0) + if (global_sockfd < 0) { - if ((sockfd = net_open (host, NULL, port)) < 0) + if ((global_sockfd = net_open (host, NULL, port)) < 0) { - /* Complain once every six hours. */ - int complain_step = 21600 / atoi (COLLECTD_STEP); - - if ((complain % complain_step) == 0) - syslog (LOG_ERR, "apcups plugin: Connecting to the apcupsd failed."); - complain++; - + plugin_complain (LOG_ERR, &compl, "apcups plugin: " + "Connecting to the apcupsd failed."); return (-1); } - complain = 0; + else + { + plugin_relief (LOG_NOTICE, &compl, "apcups plugin: " + "Connection re-established to the apcupsd."); + } } - if (net_send (&sockfd, "status", 6) < 0) + if (net_send (&global_sockfd, "status", 6) < 0) { - syslog (LOG_ERR, "apcups plugin: Writing to the socket failed."); + ERROR ("apcups plugin: Writing to the socket failed."); return (-1); } - /* XXX: Do we read `n' or `n-1' bytes? */ - while ((n = net_recv (&sockfd, recvline, sizeof (recvline) - 1)) > 0) + while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0) { assert (n < sizeof (recvline)); recvline[n] = '\0'; @@ -404,86 +299,57 @@ static int apc_query_server (char *host, int port, printf ("net_recv = `%s';\n", recvline); #endif /* if APCMAIN */ - tokptr = strtok (recvline, ":"); + toksaveptr = NULL; + tokptr = strtok_r (recvline, " :\t", &toksaveptr); while (tokptr != NULL) { key = tokptr; - if ((tokptr = strtok (NULL, " \t")) == NULL) + if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == NULL) continue; value = atof (tokptr); + PRINT_VALUE (key, value); if (strcmp ("LINEV", key) == 0) apcups_detail->linev = value; - else if (strcmp ("BATTV", tokptr) == 0) + else if (strcmp ("BATTV", key) == 0) apcups_detail->battv = value; - else if (strcmp ("ITEMP", tokptr) == 0) + else if (strcmp ("ITEMP", key) == 0) apcups_detail->itemp = value; - else if (strcmp ("LOADPCT", tokptr) == 0) + else if (strcmp ("LOADPCT", key) == 0) apcups_detail->loadpct = value; - else if (strcmp ("BCHARGE", tokptr) == 0) + else if (strcmp ("BCHARGE", key) == 0) apcups_detail->bcharge = value; - else if (strcmp ("OUTPUTV", tokptr) == 0) + else if (strcmp ("OUTPUTV", key) == 0) apcups_detail->outputv = value; - else if (strcmp ("LINEFREQ", tokptr) == 0) + else if (strcmp ("LINEFREQ", key) == 0) apcups_detail->linefreq = value; - else if (strcmp ("TIMELEFT", tokptr) == 0) + else if (strcmp ("TIMELEFT", key) == 0) apcups_detail->timeleft = value; - else - { - syslog (LOG_WARNING, "apcups plugin: Received unknown property from apcupsd: `%s' = %f", - key, value); - } - tokptr = strtok (NULL, ":"); + tokptr = strtok_r (NULL, ":", &toksaveptr); } /* while (tokptr != NULL) */ } - + if (n < 0) { - syslog (LOG_WARNING, "apcups plugin: Error reading from socket"); + WARNING ("apcups plugin: Error reading from socket"); return (-1); } return (0); } -#if APCMAIN -/* - * This is used for testing apcups in a standalone mode. - * Usefull for debugging. - */ -int main (int argc, char **argv) -{ - /* we are not really going to use this */ - struct apc_detail_s apcups_detail; - - openlog ("apcups", LOG_PID | LOG_NDELAY | LOG_LOCAL1); - - if (!*host || strcmp (host, "0.0.0.0") == 0) - host = "localhost"; - - if(do_apc_status (host, port, &apcups_detail) < 0) - { - printf("apcups: Failed...\n"); - return(-1); - } - - apc_query_server (global_host, global_port, &apcups_detail); - - return 0; -} -#else -static int apcups_config (char *key, char *value) +static int apcups_config (const char *key, const char *value) { if (strcasecmp (key, "host") == 0) { - if (global_host != NULL) + if (conf_host != NULL) { - free (global_host); - global_host = NULL; + free (conf_host); + conf_host = NULL; } - if ((global_host = strdup (value)) == NULL) + if ((conf_host = strdup (value)) == NULL) return (1); } else if (strcasecmp (key, "Port") == 0) @@ -491,10 +357,10 @@ static int apcups_config (char *key, char *value) int port_tmp = atoi (value); if (port_tmp < 1 || port_tmp > 65535) { - syslog (LOG_WARNING, "apcups plugin: Invalid port: %i", port_tmp); + WARNING ("apcups plugin: Invalid port: %i", port_tmp); return (1); } - global_port = port_tmp; + conf_port = port_tmp; } else { @@ -503,89 +369,41 @@ static int apcups_config (char *key, char *value) return (0); } -static void apcups_init (void) -{ - return; -} - -static void apc_write_voltage (char *host, char *inst, char *val) -{ - char file[512]; - int status; - - status = snprintf (file, 512, bvolt_file_template, inst); - if ((status < 1) || (status >= 512)) - return; - - rrd_update_file (host, file, val, bvolt_ds_def, bvolt_ds_num); -} - -static void apc_write_charge (char *host, char *inst, char *val) -{ - rrd_update_file (host, charge_file_template, val, charge_ds_def, charge_ds_num); -} - -static void apc_write_percent (char *host, char *inst, char *val) -{ - rrd_update_file (host, load_file_template, val, load_ds_def, load_ds_num); -} - -static void apc_write_timeleft (char *host, char *inst, char *val) -{ - rrd_update_file (host, time_file_template, val, time_ds_def, time_ds_num); -} - -static void apc_write_temperature (char *host, char *inst, char *val) -{ - rrd_update_file (host, temp_file_template, val, temp_ds_def, temp_ds_num); -} - -static void apc_write_frequency (char *host, char *inst, char *val) +static void apc_submit_generic (char *type, char *type_inst, double value) { - char file[512]; - int status; + value_t values[1]; + value_list_t vl = VALUE_LIST_INIT; - status = snprintf (file, 512, freq_file_template, inst); - if ((status < 1) || (status >= 512)) - return; - - rrd_update_file (host, file, val, freq_ds_def, freq_ds_num); -} - -static void apc_submit_generic (char *type, char *inst, - double value) -{ - char buf[512]; - int status; + values[0].gauge = value; - status = snprintf (buf, 512, "%u:%f", - (unsigned int) curtime, value); - if ((status < 1) || (status >= 512)) - return; + vl.values = values; + vl.values_len = 1; + vl.time = time (NULL); + strcpy (vl.host, hostname_g); + strcpy (vl.plugin, "apcups"); + strcpy (vl.plugin_instance, ""); + strncpy (vl.type_instance, type_inst, sizeof (vl.type_instance)); - plugin_submit (type, inst, buf); + plugin_dispatch_values (type, &vl); } static void apc_submit (struct apc_detail_s *apcups_detail) { - apc_submit_generic ("apcups_voltage", "input", apcups_detail->linev); - apc_submit_generic ("apcups_voltage", "output", apcups_detail->outputv); - apc_submit_generic ("apcups_voltage", "battery", apcups_detail->battv); - apc_submit_generic ("apcups_charge", "-", apcups_detail->bcharge); - apc_submit_generic ("apcups_charge_pct", "-", apcups_detail->loadpct); - apc_submit_generic ("apcups_timeleft", "-", apcups_detail->timeleft); - apc_submit_generic ("apcups_temp", "-", apcups_detail->itemp); - apc_submit_generic ("apcups_frequency", "input", apcups_detail->linefreq); + apc_submit_generic ("voltage", "input", apcups_detail->linev); + apc_submit_generic ("voltage", "output", apcups_detail->outputv); + apc_submit_generic ("voltage", "battery", apcups_detail->battv); + apc_submit_generic ("charge", "", apcups_detail->bcharge); + apc_submit_generic ("percent", "load", apcups_detail->loadpct); + apc_submit_generic ("timeleft", "", apcups_detail->timeleft); + apc_submit_generic ("temperature", "", apcups_detail->itemp); + apc_submit_generic ("frequency", "input", apcups_detail->linefreq); } -static void apcups_read (void) +static int apcups_read (void) { struct apc_detail_s apcups_detail; int status; - if (global_host == NULL) - return; - apcups_detail.linev = -1.0; apcups_detail.outputv = -1.0; apcups_detail.battv = -1.0; @@ -595,29 +413,34 @@ static void apcups_read (void) apcups_detail.itemp = -300.0; apcups_detail.linefreq = -1.0; - status = apc_query_server (global_host, global_port, &apcups_detail); + status = apc_query_server (conf_host == NULL + ? APCUPS_DEFAULT_HOST + : conf_host, + conf_port, &apcups_detail); /* * if we did not connect then do not bother submitting * zeros. We want rrd files to have NAN. */ if (status != 0) - return; + { + DEBUG ("apc_query_server (%s, %i) = %i", + conf_host == NULL + ? APCUPS_DEFAULT_HOST + : conf_host, + conf_port, status); + return (-1); + } apc_submit (&apcups_detail); + + return (0); } /* apcups_read */ void module_register (void) { - plugin_register (MODULE_NAME, apcups_init, apcups_read, NULL); - plugin_register ("apcups_voltage", NULL, NULL, apc_write_voltage); - plugin_register ("apcups_charge", NULL, NULL, apc_write_charge); - plugin_register ("apcups_charge_pct", NULL, NULL, apc_write_percent); - plugin_register ("apcups_timeleft", NULL, NULL, apc_write_timeleft); - plugin_register ("apcups_temp", NULL, NULL, apc_write_temperature); - plugin_register ("apcups_frequency", NULL, NULL, apc_write_frequency); - cf_register (MODULE_NAME, apcups_config, config_keys, config_keys_num); -} - -#endif /* if APCMAIN */ -#undef MODULE_NAME + plugin_register_config ("apcups", apcups_config, config_keys, + config_keys_num); + plugin_register_read ("apcups", apcups_read); + plugin_register_shutdown ("apcups", apcups_shutdown); +} /* void module_register */