2 * collectd - src/apcups.c
3 * Copyright (C) 2006-2015 Florian octo Forster
4 * Copyright (C) 2006 Anthony Gialluca <tonyabg at charter.net>
5 * Copyright (C) 2000-2004 Kern Sibbald
6 * Copyright (C) 1996-1999 Andre M. Hedrick <andre at suse.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General
10 * Public License as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public
18 * License along with this program; if not, write to the Free
19 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
23 * Anthony Gialluca <tonyabg at charter.net>
24 * Florian octo Forster <octo at collectd.org>
28 #include "common.h" /* rrd_update_file */
29 #include "plugin.h" /* plugin_register, plugin_submit */
30 #include "configfile.h" /* cf_register */
33 # include <sys/types.h>
40 # include <netinet/in.h>
43 #ifndef APCUPS_DEFAULT_NODE
44 # define APCUPS_DEFAULT_NODE "localhost"
47 #ifndef APCUPS_DEFAULT_SERVICE
48 # define APCUPS_DEFAULT_SERVICE "3551"
69 /* Default values for contacting daemon */
70 static char *conf_node = NULL;
71 static char *conf_service = NULL;
72 /* Defaults to false for backwards compatibility. */
73 static _Bool conf_report_seconds = 0;
74 static _Bool conf_persistent_conn = 1;
76 static int global_sockfd = -1;
78 static int count_retries = 0;
79 static int count_iterations = 0;
81 static int net_shutdown (int *fd)
83 uint16_t packet_size = 0;
85 if ((fd == NULL) || (*fd < 0))
88 swrite (*fd, (void *) &packet_size, sizeof (packet_size));
93 } /* int net_shutdown */
95 /* Close the network connection */
96 static int apcups_shutdown (void)
98 if (global_sockfd < 0)
101 net_shutdown (&global_sockfd);
103 } /* int apcups_shutdown */
106 * Open a TCP connection to the UPS network server
107 * Returns -1 on error
108 * Returns socket file descriptor otherwise
110 static int net_open (char const *node, char const *service)
114 struct addrinfo ai_hints;
115 struct addrinfo *ai_return;
116 struct addrinfo *ai_list;
119 memset (&ai_hints, 0, sizeof (ai_hints));
120 /* TODO: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
121 ai_hints.ai_family = AF_INET;
122 ai_hints.ai_socktype = SOCK_STREAM;
124 status = getaddrinfo (node, service, &ai_hints, &ai_return);
128 INFO ("apcups plugin: getaddrinfo failed: %s",
129 (status == EAI_SYSTEM)
130 ? sstrerror (errno, errbuf, sizeof (errbuf))
131 : gai_strerror (status));
137 for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
139 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
143 /* `ai_list' still holds the current description of the socket.. */
147 DEBUG ("apcups plugin: Unable to open a socket");
148 freeaddrinfo (ai_return);
152 status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
154 freeaddrinfo (ai_return);
156 if (status != 0) /* `connect(2)' failed */
159 INFO ("apcups plugin: connect failed: %s",
160 sstrerror (errno, errbuf, sizeof (errbuf)));
165 DEBUG ("apcups plugin: Done opening a socket %i", sd);
171 * Receive a message from the other end. Each message consists of
172 * two packets. The first is a header that contains the size
173 * of the data that follows in the second packet.
174 * Returns number of bytes read
175 * Returns 0 on end of file
176 * Returns -1 on hard end of file (i.e. network connection close)
177 * Returns -2 on error
179 static int net_recv (int *sockfd, char *buf, int buflen)
181 uint16_t packet_size;
183 /* get data size -- in short */
184 if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
191 packet_size = ntohs (packet_size);
192 if (packet_size > buflen)
194 ERROR ("apcups plugin: Received %"PRIu16" bytes of payload "
195 "but have only %i bytes of buffer available.",
196 packet_size, buflen);
202 if (packet_size == 0)
205 /* now read the actual data */
206 if (sread (*sockfd, (void *) buf, packet_size) != 0)
213 return ((int) packet_size);
214 } /* static int net_recv (int *sockfd, char *buf, int buflen) */
217 * Send a message over the network. The send consists of
218 * two network packets. The first is sends a short containing
219 * the length of the data packet which follows.
220 * Returns zero on success
221 * Returns non-zero on error
223 static int net_send (int *sockfd, char *buff, int len)
225 uint16_t packet_size;
228 assert (*sockfd >= 0);
230 /* send short containing size of data packet */
231 packet_size = htons ((uint16_t) len);
233 if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
240 /* send data packet */
241 if (swrite (*sockfd, (void *) buff, len) != 0)
251 /* Get and print status from apcupsd NIS server */
252 static int apc_query_server (char const *node, char const *service,
253 struct apc_detail_s *apcups_detail)
265 # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val)
267 # define PRINT_VALUE(name, val) /**/
272 if (global_sockfd < 0)
274 global_sockfd = net_open (node, service);
275 if (global_sockfd < 0)
277 ERROR ("apcups plugin: Connecting to the "
284 status = net_send (&global_sockfd, "status", strlen ("status"));
287 /* net_send is closing the socket on error. */
288 assert (global_sockfd < 0);
296 ERROR ("apcups plugin: Writing to the socket failed.");
301 } /* while (retry) */
303 /* When collectd's collection interval is larger than apcupsd's
304 * timeout, we would have to retry / re-connect each iteration. Try to
305 * detect this situation and shut down the socket gracefully in that
306 * case. Otherwise, keep the socket open to avoid overhead. */
308 if ((count_iterations == 10) && (count_retries > 2))
310 NOTICE ("apcups plugin: There have been %i retries in the "
311 "first %i iterations. Will close the socket "
312 "in future iterations.",
313 count_retries, count_iterations);
314 conf_persistent_conn = 0;
317 while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
319 assert ((size_t)n < sizeof (recvline));
322 printf ("net_recv = `%s';\n", recvline);
323 #endif /* if APCMAIN */
325 if (strncmp ("END APC", recvline, strlen ("END APC")) == 0)
329 tokptr = strtok_r (recvline, " :\t", &toksaveptr);
330 while (tokptr != NULL)
333 if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == NULL)
335 value = atof (tokptr);
337 PRINT_VALUE (key, value);
339 if (strcmp ("LINEV", key) == 0)
340 apcups_detail->linev = value;
341 else if (strcmp ("BATTV", key) == 0)
342 apcups_detail->battv = value;
343 else if (strcmp ("ITEMP", key) == 0)
344 apcups_detail->itemp = value;
345 else if (strcmp ("LOADPCT", key) == 0)
346 apcups_detail->loadpct = value;
347 else if (strcmp ("BCHARGE", key) == 0)
348 apcups_detail->bcharge = value;
349 else if (strcmp ("OUTPUTV", key) == 0)
350 apcups_detail->outputv = value;
351 else if (strcmp ("LINEFREQ", key) == 0)
352 apcups_detail->linefreq = value;
353 else if (strcmp ("TIMELEFT", key) == 0)
355 /* Convert minutes to seconds if requested by
357 if (conf_report_seconds)
359 apcups_detail->timeleft = value;
362 tokptr = strtok_r (NULL, ":", &toksaveptr);
363 } /* while (tokptr != NULL) */
365 status = errno; /* save errno, net_shutdown() may re-set it. */
367 if (!conf_persistent_conn)
368 net_shutdown (&global_sockfd);
373 ERROR ("apcups plugin: Reading from socket failed: %s",
374 sstrerror (status, errbuf, sizeof (errbuf)));
381 static int apcups_config (oconfig_item_t *ci)
385 for (i = 0; i < ci->children_num; i++)
387 oconfig_item_t *child = ci->children + i;
389 if (strcasecmp (child->key, "Host") == 0)
390 cf_util_get_string (child, &conf_node);
391 else if (strcasecmp (child->key, "Port") == 0)
392 cf_util_get_service (child, &conf_service);
393 else if (strcasecmp (child->key, "ReportSeconds") == 0)
394 cf_util_get_boolean (child, &conf_report_seconds);
395 else if (strcasecmp (child->key, "PersistentConnection") == 0)
396 cf_util_get_boolean (child, &conf_persistent_conn);
398 ERROR ("apcups plugin: Unknown config option \"%s\".", child->key);
402 } /* int apcups_config */
404 static void apc_submit_generic (char *type, char *type_inst, double value)
407 value_list_t vl = VALUE_LIST_INIT;
409 values[0].gauge = value;
413 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
414 sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin));
415 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
416 sstrncpy (vl.type, type, sizeof (vl.type));
417 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
419 plugin_dispatch_values (&vl);
422 static void apc_submit (struct apc_detail_s *apcups_detail)
424 apc_submit_generic ("voltage", "input", apcups_detail->linev);
425 apc_submit_generic ("voltage", "output", apcups_detail->outputv);
426 apc_submit_generic ("voltage", "battery", apcups_detail->battv);
427 apc_submit_generic ("charge", "", apcups_detail->bcharge);
428 apc_submit_generic ("percent", "load", apcups_detail->loadpct);
429 apc_submit_generic ("timeleft", "", apcups_detail->timeleft);
430 apc_submit_generic ("temperature", "", apcups_detail->itemp);
431 apc_submit_generic ("frequency", "input", apcups_detail->linefreq);
434 static int apcups_read (void)
436 struct apc_detail_s apcups_detail;
439 apcups_detail.linev = -1.0;
440 apcups_detail.outputv = -1.0;
441 apcups_detail.battv = -1.0;
442 apcups_detail.loadpct = -1.0;
443 apcups_detail.bcharge = -1.0;
444 apcups_detail.timeleft = NAN;
445 apcups_detail.itemp = -300.0;
446 apcups_detail.linefreq = -1.0;
448 status = apc_query_server ((conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
449 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
453 * if we did not connect then do not bother submitting
454 * zeros. We want rrd files to have NAN.
458 DEBUG ("apcups plugin: apc_query_server (%s, %s) = %i",
459 (conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
460 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
465 apc_submit (&apcups_detail);
470 void module_register (void)
472 plugin_register_complex_config ("apcups", apcups_config);
473 plugin_register_read ("apcups", apcups_read);
474 plugin_register_shutdown ("apcups", apcups_shutdown);
475 } /* void module_register */