X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fapcups.c;h=08df0b50fbcb2cb36253bd2c97f9019f689962bb;hb=3faf514fd9b869cadda0f895e14e5036313c7781;hp=2539c32f5c308972c953f965fb2daf00ca60c628;hpb=06adec208286b5a136ffa5c5f3832c35e9f62844;p=collectd.git diff --git a/src/apcups.c b/src/apcups.c index 2539c32f..4fbbde63 100644 --- a/src/apcups.c +++ b/src/apcups.c @@ -1,8 +1,9 @@ /* * collectd - src/apcups.c - * Copyright (C) 2006 Anthony Gialluca - * Copyright (C) 2000-2004 Kern Sibbald - * Copyright (C) 1996-99 Andre M. Hedrick + * Copyright (C) 2006-2012 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 @@ -20,15 +21,9 @@ * * Authors: * Anthony Gialluca + * Florian octo Forster **/ -/* - * FIXME: Don't know why but without this here atof() was not returning - * correct values for me. This is behavior that I don't understand and - * should be examined in closer detail. - */ -#include - #include "collectd.h" #include "common.h" /* rrd_update_file */ #include "plugin.h" /* plugin_register, plugin_submit */ @@ -78,58 +73,9 @@ static int conf_port = NISPORT; static int global_sockfd = -1; -/* - * The following are only if not compiled to test the module with its own main. -*/ -static data_source_t data_source_voltage[1] = -{ - {"value", DS_TYPE_GAUGE, NAN, NAN} -}; - -static data_set_t ds_voltage = -{ - "voltage", 1, data_source_voltage -}; - -static data_source_t data_source_percent[1] = -{ - {"percent", DS_TYPE_GAUGE, 0, 100.1} -}; - -static data_set_t ds_percent = -{ - "percent", 1, data_source_percent -}; - -static data_source_t data_source_timeleft[1] = -{ - {"timeleft", DS_TYPE_GAUGE, 0, 100.0} -}; - -static data_set_t ds_timeleft = -{ - "timeleft", 1, data_source_timeleft -}; - -static data_source_t data_source_temperature[1] = -{ - {"value", DS_TYPE_GAUGE, -273.15, NAN} -}; - -static data_set_t ds_temperature = -{ - "temperature", 1, data_source_temperature -}; - -static data_source_t data_source_frequency[1] = -{ - {"frequency", DS_TYPE_GAUGE, 0, NAN} -}; - -static data_set_t ds_frequency = -{ - "frequency", 1, data_source_frequency -}; +static int count_retries = 0; +static int count_iterations = 0; +static _Bool close_socket = 0; static const char *config_keys[] = { @@ -139,31 +85,36 @@ static const char *config_keys[] = }; static int config_keys_num = 2; -/* 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, char *service, int port) +static int net_open (char *host, int port) { int sd; int status; @@ -175,8 +126,7 @@ static int net_open (char *host, char *service, int port) assert ((port > 0x00000000) && (port <= 0x0000FFFF)); /* Convert the port to a string */ - snprintf (port_str, 8, "%i", port); - port_str[7] = '\0'; + ssnprintf (port_str, sizeof (port_str), "%i", port); /* Resolve name */ memset ((void *) &ai_hints, '\0', sizeof (ai_hints)); @@ -187,7 +137,7 @@ static int net_open (char *host, char *service, int port) if (status != 0) { char errbuf[1024]; - DEBUG ("getaddrinfo failed: %s", + INFO ("getaddrinfo failed: %s", (status == EAI_SYSTEM) ? sstrerror (errno, errbuf, sizeof (errbuf)) : gai_strerror (status)); @@ -218,7 +168,7 @@ static int net_open (char *host, char *service, int port) if (status != 0) /* `connect(2)' failed */ { char errbuf[1024]; - DEBUG ("connect failed: %s", + INFO ("connect failed: %s", sstrerror (errno, errbuf, sizeof (errbuf))); close (sd); return (-1); @@ -229,7 +179,7 @@ static int net_open (char *host, char *service, int port) return (sd); } /* int net_open (char *host, char *service, int port) */ -/* +/* * 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. @@ -245,6 +195,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); } @@ -252,7 +203,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); } @@ -262,6 +217,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); } @@ -288,6 +244,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); } @@ -295,6 +252,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); } @@ -312,8 +270,8 @@ static int apc_query_server (char *host, int port, char *toksaveptr; char *key; double value; - - static complain_t compl; + _Bool retry = 1; + int status; #if APCMAIN # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val) @@ -321,30 +279,56 @@ static int apc_query_server (char *host, int port, # define PRINT_VALUE(name, val) /**/ #endif - if (global_sockfd < 0) + while (retry) { - if ((global_sockfd = net_open (host, NULL, port)) < 0) + if (global_sockfd < 0) { - plugin_complain (LOG_ERR, &compl, "apcups plugin: " - "Connecting to the apcupsd failed."); - return (-1); + global_sockfd = net_open (host, port); + if (global_sockfd < 0) + { + ERROR ("apcups plugin: Connecting to the " + "apcupsd failed."); + return (-1); + } } - else + + + status = net_send (&global_sockfd, "status", strlen ("status")); + if (status != 0) { - plugin_relief (LOG_NOTICE, &compl, "apcups plugin: " - "Connection re-established to the apcupsd."); + /* 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); + close_socket = 1; } while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0) { - assert (n < sizeof (recvline)); + assert ((unsigned int)n < sizeof (recvline)); recvline[n] = '\0'; #if APCMAIN printf ("net_recv = `%s';\n", recvline); @@ -363,7 +347,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; @@ -381,10 +365,16 @@ static int apc_query_server (char *host, int port, tokptr = strtok_r (NULL, ":", &toksaveptr); } /* while (tokptr != NULL) */ } - + status = errno; /* save errno, net_shutdown() may re-set it. */ + + if (close_socket) + 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); } @@ -429,25 +419,25 @@ static void apc_submit_generic (char *type, char *type_inst, double value) 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)); + sstrncpy (vl.host, hostname_g, sizeof (vl.host)); + sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin)); + sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance)); + sstrncpy (vl.type, type, sizeof (vl.type)); + sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance)); - plugin_dispatch_values (type, &vl); + plugin_dispatch_values (&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 int apcups_read (void) @@ -463,12 +453,12 @@ static int apcups_read (void) apcups_detail.timeleft = -1.0; 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); - + /* * if we did not connect then do not bother submitting * zeros. We want rrd files to have NAN. @@ -488,22 +478,10 @@ static int apcups_read (void) return (0); } /* apcups_read */ -void module_register (modreg_e load) +void module_register (void) { - if (load & MR_DATASETS) - { - plugin_register_data_set (&ds_voltage); - plugin_register_data_set (&ds_percent); - plugin_register_data_set (&ds_timeleft); - plugin_register_data_set (&ds_temperature); - plugin_register_data_set (&ds_frequency); - } - - if (load & MR_READ) - { - plugin_register_config ("apcups", apcups_config, config_keys, - config_keys_num); - plugin_register_read ("apcups", apcups_read); - plugin_register_shutdown ("apcups", apcups_shutdown); - } + 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 */