X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fapcups.c;h=2d1c16bb2424e3aaea49653fc4aba02da700323c;hb=de41631e3196258b3bcfa3267e82267c8c261e72;hp=ca026b9689907f49f7227c3ae612b54e4ff4cfef;hpb=074b4980bc75bea6826e6a38dcc6e193a721b2a8;p=collectd.git diff --git a/src/apcups.c b/src/apcups.c index ca026b96..2d1c16bb 100644 --- a/src/apcups.c +++ b/src/apcups.c @@ -1,10 +1,9 @@ /* * 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 - * + * Copyright (C) 2006-2015 Florian octo Forster + * Copyright (C) 2006 Anthony Gialluca + * Copyright (C) 2000-2004 Kern Sibbald + * Copyright (C) 1996-1999 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 @@ -22,6 +21,7 @@ * * Authors: * Anthony Gialluca + * Florian octo Forster **/ #include "collectd.h" @@ -32,9 +32,6 @@ #if HAVE_SYS_TYPES_H # include #endif -#if HAVE_SYS_SOCKET_H -# include -#endif #if HAVE_NETDB_H # include #endif @@ -43,11 +40,17 @@ # include #endif -#define NISPORT 3551 -#define MAXSTRING 256 -#define MODULE_NAME "apcups" +#ifndef APCUPS_SERVER_TIMEOUT +# define APCUPS_SERVER_TIMEOUT 15.0 +#endif -#define APCUPS_DEFAULT_HOST "localhost" +#ifndef APCUPS_DEFAULT_NODE +# define APCUPS_DEFAULT_NODE "localhost" +#endif + +#ifndef APCUPS_DEFAULT_SERVICE +# define APCUPS_DEFAULT_SERVICE "3551" +#endif /* * Private data types @@ -68,67 +71,65 @@ struct apc_detail_s * Private variables */ /* Default values for contacting daemon */ -static char *conf_host = NULL; -static int conf_port = NISPORT; +static char *conf_node = NULL; +static char *conf_service = NULL; +/* Defaults to false for backwards compatibility. */ +static _Bool conf_report_seconds = 0; +static _Bool conf_persistent_conn = 1; static int global_sockfd = -1; -static const char *config_keys[] = -{ - "Host", - "Port", - NULL -}; -static int config_keys_num = 2; +static int count_retries = 0; +static int count_iterations = 0; -/* Close the network connection */ -static int apcups_shutdown (void) +static int net_shutdown (int *fd) { uint16_t packet_size = 0; - if (global_sockfd < 0) - return (0); + if ((fd == NULL) || (*fd < 0)) + return (EINVAL); - DEBUG ("Gracefully shutting down socket %i.", global_sockfd); + swrite (*fd, (void *) &packet_size, sizeof (packet_size)); + close (*fd); + *fd = -1; - /* send EOF sentinel */ - swrite (global_sockfd, (void *) &packet_size, sizeof (packet_size)); + return (0); +} /* int net_shutdown */ - close (global_sockfd); - global_sockfd = -1; +/* Close the network connection */ +static int apcups_shutdown (void) +{ + if (global_sockfd < 0) + return (0); + net_shutdown (&global_sockfd); return (0); } /* int apcups_shutdown */ -/* +/* * Open a TCP connection to the UPS network server * Returns -1 on error * Returns socket file descriptor otherwise */ -static int net_open (char *host, int port) +static int net_open (char const *node, char const *service) { int sd; int status; - char port_str[8]; struct addrinfo ai_hints; struct addrinfo *ai_return; struct addrinfo *ai_list; - assert ((port > 0x00000000) && (port <= 0x0000FFFF)); - - /* Convert the port to a string */ - ssnprintf (port_str, sizeof (port_str), "%i", port); - /* Resolve name */ - memset ((void *) &ai_hints, '\0', sizeof (ai_hints)); - ai_hints.ai_family = AF_INET; /* XXX: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */ + memset (&ai_hints, 0, sizeof (ai_hints)); + /* TODO: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */ + ai_hints.ai_family = AF_INET; ai_hints.ai_socktype = SOCK_STREAM; - status = getaddrinfo (host, port_str, &ai_hints, &ai_return); + status = getaddrinfo (node, service, &ai_hints, &ai_return); if (status != 0) { char errbuf[1024]; - INFO ("getaddrinfo failed: %s", + INFO ("apcups plugin: getaddrinfo failed: %s", (status == EAI_SYSTEM) ? sstrerror (errno, errbuf, sizeof (errbuf)) : gai_strerror (status)); @@ -147,7 +148,7 @@ static int net_open (char *host, int port) if (sd < 0) { - DEBUG ("Unable to open a socket"); + DEBUG ("apcups plugin: Unable to open a socket"); freeaddrinfo (ai_return); return (-1); } @@ -159,18 +160,18 @@ static int net_open (char *host, int port) if (status != 0) /* `connect(2)' failed */ { char errbuf[1024]; - INFO ("connect failed: %s", + INFO ("apcups plugin: connect failed: %s", sstrerror (errno, errbuf, sizeof (errbuf))); close (sd); return (-1); } - DEBUG ("Done opening a socket %i", sd); + DEBUG ("apcups plugin: Done opening a socket %i", sd); return (sd); -} /* int net_open (char *host, char *service, int port) */ +} /* int net_open */ -/* +/* * Receive a message from the other end. Each message consists of * two packets. The first is a header that contains the size * of the data that follows in the second packet. @@ -186,6 +187,7 @@ static int net_recv (int *sockfd, char *buf, int buflen) /* get data size -- in short */ if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0) { + close (*sockfd); *sockfd = -1; return (-1); } @@ -193,7 +195,11 @@ static int net_recv (int *sockfd, char *buf, int buflen) packet_size = ntohs (packet_size); if (packet_size > buflen) { - DEBUG ("record length too large"); + ERROR ("apcups plugin: Received %"PRIu16" bytes of payload " + "but have only %i bytes of buffer available.", + packet_size, buflen); + close (*sockfd); + *sockfd = -1; return (-2); } @@ -203,6 +209,7 @@ static int net_recv (int *sockfd, char *buf, int buflen) /* now read the actual data */ if (sread (*sockfd, (void *) buf, packet_size) != 0) { + close (*sockfd); *sockfd = -1; return (-1); } @@ -217,7 +224,7 @@ static int net_recv (int *sockfd, char *buf, int buflen) * Returns zero on success * Returns non-zero on error */ -static int net_send (int *sockfd, char *buff, int len) +static int net_send (int *sockfd, const char *buff, int len) { uint16_t packet_size; @@ -229,6 +236,7 @@ static int net_send (int *sockfd, char *buff, int len) if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0) { + close (*sockfd); *sockfd = -1; return (-1); } @@ -236,6 +244,7 @@ static int net_send (int *sockfd, char *buff, int len) /* send data packet */ if (swrite (*sockfd, (void *) buff, len) != 0) { + close (*sockfd); *sockfd = -1; return (-2); } @@ -244,7 +253,7 @@ static int net_send (int *sockfd, char *buff, int len) } /* Get and print status from apcupsd NIS server */ -static int apc_query_server (char *host, int port, +static int apc_query_server (char const *node, char const *service, struct apc_detail_s *apcups_detail) { int n; @@ -253,6 +262,8 @@ static int apc_query_server (char *host, int port, char *toksaveptr; char *key; double value; + _Bool retry = 1; + int status; #if APCMAIN # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val) @@ -260,27 +271,57 @@ static int apc_query_server (char *host, int port, # define PRINT_VALUE(name, val) /**/ #endif - if (global_sockfd < 0) + while (retry) { - global_sockfd = net_open (host, port); if (global_sockfd < 0) { - ERROR ("apcups plugin: Connecting to the " - "apcupsd failed."); + global_sockfd = net_open (node, service); + if (global_sockfd < 0) + { + ERROR ("apcups plugin: Connecting to the " + "apcupsd failed."); + return (-1); + } + } + + + status = net_send (&global_sockfd, "status", strlen ("status")); + if (status != 0) + { + /* net_send is closing the socket on error. */ + assert (global_sockfd < 0); + if (retry) + { + retry = 0; + count_retries++; + continue; + } + + ERROR ("apcups plugin: Writing to the socket failed."); return (-1); } - } - if (net_send (&global_sockfd, "status", 6) < 0) + break; + } /* while (retry) */ + + /* When collectd's collection interval is larger than apcupsd's + * timeout, we would have to retry / re-connect each iteration. Try to + * detect this situation and shut down the socket gracefully in that + * case. Otherwise, keep the socket open to avoid overhead. */ + count_iterations++; + if ((count_iterations == 10) && (count_retries > 2)) { - ERROR ("apcups plugin: Writing to the socket failed."); - return (-1); + NOTICE ("apcups plugin: There have been %i retries in the " + "first %i iterations. Will close the socket " + "in future iterations.", + count_retries, count_iterations); + conf_persistent_conn = 0; } while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0) { - assert ((unsigned int)n < sizeof (recvline)); - recvline[n] = '\0'; + assert ((size_t)n < sizeof (recvline)); + recvline[n] = 0; #if APCMAIN printf ("net_recv = `%s';\n", recvline); #endif /* if APCMAIN */ @@ -298,7 +339,7 @@ static int apc_query_server (char *host, int port, if (strcmp ("LINEV", key) == 0) apcups_detail->linev = value; - else if (strcmp ("BATTV", key) == 0) + else if (strcmp ("BATTV", key) == 0) apcups_detail->battv = value; else if (strcmp ("ITEMP", key) == 0) apcups_detail->itemp = value; @@ -311,51 +352,71 @@ static int apc_query_server (char *host, int port, else if (strcmp ("LINEFREQ", key) == 0) apcups_detail->linefreq = value; else if (strcmp ("TIMELEFT", key) == 0) + { + /* Convert minutes to seconds if requested by + * the user. */ + if (conf_report_seconds) + value *= 60.0; apcups_detail->timeleft = value; + } tokptr = strtok_r (NULL, ":", &toksaveptr); } /* while (tokptr != NULL) */ } - + status = errno; /* save errno, net_shutdown() may re-set it. */ + + if (!conf_persistent_conn) + net_shutdown (&global_sockfd); + if (n < 0) { - WARNING ("apcups plugin: Error reading from socket"); + char errbuf[1024]; + ERROR ("apcups plugin: Reading from socket failed: %s", + sstrerror (status, errbuf, sizeof (errbuf))); return (-1); } return (0); } -static int apcups_config (const char *key, const char *value) +static int apcups_config (oconfig_item_t *ci) { - if (strcasecmp (key, "host") == 0) + int i; + _Bool persistent_conn_set = 0; + + for (i = 0; i < ci->children_num; i++) { - if (conf_host != NULL) - { - free (conf_host); - conf_host = NULL; + oconfig_item_t *child = ci->children + i; + + if (strcasecmp (child->key, "Host") == 0) + cf_util_get_string (child, &conf_node); + else if (strcasecmp (child->key, "Port") == 0) + cf_util_get_service (child, &conf_service); + else if (strcasecmp (child->key, "ReportSeconds") == 0) + cf_util_get_boolean (child, &conf_report_seconds); + else if (strcasecmp (child->key, "PersistentConnection") == 0) { + cf_util_get_boolean (child, &conf_persistent_conn); + persistent_conn_set = 1; } - if ((conf_host = strdup (value)) == NULL) - return (1); + else + ERROR ("apcups plugin: Unknown config option \"%s\".", child->key); } - else if (strcasecmp (key, "Port") == 0) - { - int port_tmp = atoi (value); - if (port_tmp < 1 || port_tmp > 65535) - { - WARNING ("apcups plugin: Invalid port: %i", port_tmp); - return (1); + + if (!persistent_conn_set) { + double interval = CDTIME_T_TO_DOUBLE(plugin_get_interval()); + if (interval > APCUPS_SERVER_TIMEOUT) { + NOTICE ("apcups plugin: Plugin poll interval set to %.3f seconds. " + "Apcupsd NIS socket timeout is %.3f seconds, " + "PersistentConnection disabled by default.", + interval, APCUPS_SERVER_TIMEOUT); + conf_persistent_conn = 0; } - conf_port = port_tmp; - } - else - { - return (-1); } + return (0); -} +} /* int apcups_config */ -static void apc_submit_generic (char *type, char *type_inst, double value) +static void apc_submit_generic (const char *type, const char *type_inst, double value) { value_t values[1]; value_list_t vl = VALUE_LIST_INIT; @@ -364,7 +425,6 @@ static void apc_submit_generic (char *type, char *type_inst, double value) vl.values = values; vl.values_len = 1; - vl.time = time (NULL); sstrncpy (vl.host, hostname_g, sizeof (vl.host)); sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin)); sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance)); @@ -396,26 +456,24 @@ static int apcups_read (void) apcups_detail.battv = -1.0; apcups_detail.loadpct = -1.0; apcups_detail.bcharge = -1.0; - apcups_detail.timeleft = -1.0; + apcups_detail.timeleft = NAN; apcups_detail.itemp = -300.0; apcups_detail.linefreq = -1.0; - - status = apc_query_server (conf_host == NULL - ? APCUPS_DEFAULT_HOST - : conf_host, - conf_port, &apcups_detail); - + + status = apc_query_server ((conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node, + (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service, + &apcups_detail); + /* * if we did not connect then do not bother submitting * zeros. We want rrd files to have NAN. */ if (status != 0) { - DEBUG ("apc_query_server (%s, %i) = %i", - conf_host == NULL - ? APCUPS_DEFAULT_HOST - : conf_host, - conf_port, status); + DEBUG ("apcups plugin: apc_query_server (%s, %s) = %i", + (conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node, + (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service, + status); return (-1); } @@ -426,8 +484,7 @@ static int apcups_read (void) void module_register (void) { - plugin_register_config ("apcups", apcups_config, config_keys, - config_keys_num); + plugin_register_complex_config ("apcups", apcups_config); plugin_register_read ("apcups", apcups_read); plugin_register_shutdown ("apcups", apcups_shutdown); } /* void module_register */