/*
* collectd - src/apcups.c
- * Copyright (C) 2006 Anthony Gialluca <tonyabg at charter.net>
- * Copyright (C) 2000-2004 Kern Sibbald
- * Copyright (C) 1996-99 Andre M. Hedrick <andre at suse.com>
+ * Copyright (C) 2006-2012 Florian octo Forster
+ * Copyright (C) 2006 Anthony Gialluca <tonyabg at charter.net>
+ * Copyright (C) 2000-2004 Kern Sibbald
+ * Copyright (C) 1996-1999 Andre M. Hedrick <andre at suse.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of version 2 of the GNU General
*
* Authors:
* Anthony Gialluca <tonyabg at charter.net>
+ * Florian octo Forster <octo at verplant.org>
**/
-/*
- * 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 <stdlib.h>
-
#include "collectd.h"
#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 <sys/types.h>
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[] =
{
};
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);
- DBG ("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;
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));
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];
+ INFO ("getaddrinfo failed: %s",
+ (status == EAI_SYSTEM)
+ ? sstrerror (errno, errbuf, sizeof (errbuf))
+ : gai_strerror (status));
return (-1);
}
if (sd < 0)
{
- DBG ("Unable to open a socket");
+ DEBUG ("Unable to open a socket");
freeaddrinfo (ai_return);
return (-1);
}
if (status != 0) /* `connect(2)' failed */
{
- DBG ("connect failed: %s", strerror (errno));
+ char errbuf[1024];
+ INFO ("connect failed: %s",
+ sstrerror (errno, errbuf, sizeof (errbuf)));
close (sd);
return (-1);
}
- DBG ("Done opening a socket %i", sd);
+ DEBUG ("Done opening a socket %i", sd);
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.
/* get data size -- in short */
if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
{
+ close (*sockfd);
*sockfd = -1;
return (-1);
}
packet_size = ntohs (packet_size);
if (packet_size > buflen)
{
- DBG ("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);
}
/* now read the actual data */
if (sread (*sockfd, (void *) buf, packet_size) != 0)
{
+ close (*sockfd);
*sockfd = -1;
return (-1);
}
if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
{
+ close (*sockfd);
*sockfd = -1;
return (-1);
}
/* send data packet */
if (swrite (*sockfd, (void *) buff, len) != 0)
{
+ close (*sockfd);
*sockfd = -1;
return (-2);
}
int n;
char recvline[1024];
char *tokptr;
+ 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)
# 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))
{
- syslog (LOG_ERR, "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);
#endif /* if APCMAIN */
- tokptr = strtok (recvline, " :\t");
+ 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);
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;
else if (strcmp ("TIMELEFT", key) == 0)
apcups_detail->timeleft = value;
- tokptr = strtok (NULL, ":");
+ 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)
{
- syslog (LOG_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);
}
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);
}
conf_port = port_tmp;
vl.values = values;
vl.values_len = 1;
- vl.time = time (NULL);
- strcpy (vl.host, hostname);
- 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)
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.
*/
if (status != 0)
{
- DBG ("apc_query_server (%s, %i) = %i",
+ DEBUG ("apc_query_server (%s, %i) = %i",
conf_host == NULL
? APCUPS_DEFAULT_HOST
: conf_host,
void module_register (void)
{
- 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);
-
- plugin_register_config ("apcups", apcups_config, config_keys, config_keys_num);
-
+ 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 */
projects / collectd.git / blobdiff