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>
29 #include "common.h" /* rrd_update_file */
30 #include "plugin.h" /* plugin_register, plugin_submit */
33 # include <sys/types.h>
40 # include <netinet/in.h>
43 #ifndef APCUPS_SERVER_TIMEOUT
44 # define APCUPS_SERVER_TIMEOUT 15.0
47 #ifndef APCUPS_DEFAULT_NODE
48 # define APCUPS_DEFAULT_NODE "localhost"
51 #ifndef APCUPS_DEFAULT_SERVICE
52 # define APCUPS_DEFAULT_SERVICE "3551"
73 /* Default values for contacting daemon */
74 static char *conf_node = NULL;
75 static char *conf_service = NULL;
76 /* Defaults to false for backwards compatibility. */
77 static _Bool conf_report_seconds = 0;
78 static _Bool conf_persistent_conn = 1;
80 static int global_sockfd = -1;
82 static int count_retries = 0;
83 static int count_iterations = 0;
85 static int net_shutdown (int *fd)
87 uint16_t packet_size = 0;
89 if ((fd == NULL) || (*fd < 0))
92 (void)swrite (*fd, (void *) &packet_size, sizeof (packet_size));
97 } /* int net_shutdown */
99 /* Close the network connection */
100 static int apcups_shutdown (void)
102 if (global_sockfd < 0)
105 net_shutdown (&global_sockfd);
107 } /* int apcups_shutdown */
110 * Open a TCP connection to the UPS network server
111 * Returns -1 on error
112 * Returns socket file descriptor otherwise
114 static int net_open (char const *node, char const *service)
118 struct addrinfo *ai_return;
119 struct addrinfo *ai_list;
121 /* TODO: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
122 struct addrinfo ai_hints = {
123 .ai_family = AF_INET,
124 .ai_socktype = SOCK_STREAM
127 status = getaddrinfo (node, service, &ai_hints, &ai_return);
131 INFO ("apcups plugin: getaddrinfo failed: %s",
132 (status == EAI_SYSTEM)
133 ? sstrerror (errno, errbuf, sizeof (errbuf))
134 : gai_strerror (status));
140 for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
142 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
146 /* `ai_list' still holds the current description of the socket.. */
150 DEBUG ("apcups plugin: Unable to open a socket");
151 freeaddrinfo (ai_return);
155 status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
157 freeaddrinfo (ai_return);
159 if (status != 0) /* `connect(2)' failed */
162 INFO ("apcups plugin: connect failed: %s",
163 sstrerror (errno, errbuf, sizeof (errbuf)));
168 DEBUG ("apcups plugin: Done opening a socket %i", sd);
174 * Receive a message from the other end. Each message consists of
175 * two packets. The first is a header that contains the size
176 * of the data that follows in the second packet.
177 * Returns number of bytes read
178 * Returns 0 on end of file
179 * Returns -1 on hard end of file (i.e. network connection close)
180 * Returns -2 on error
182 static int net_recv (int *sockfd, char *buf, int buflen)
184 uint16_t packet_size;
186 /* get data size -- in short */
187 if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
194 packet_size = ntohs (packet_size);
195 if (packet_size > buflen)
197 ERROR ("apcups plugin: Received %"PRIu16" bytes of payload "
198 "but have only %i bytes of buffer available.",
199 packet_size, buflen);
205 if (packet_size == 0)
208 /* now read the actual data */
209 if (sread (*sockfd, (void *) buf, packet_size) != 0)
216 return ((int) packet_size);
217 } /* static int net_recv (int *sockfd, char *buf, int buflen) */
220 * Send a message over the network. The send consists of
221 * two network packets. The first is sends a short containing
222 * the length of the data packet which follows.
223 * Returns zero on success
224 * Returns non-zero on error
226 static int net_send (int *sockfd, const char *buff, int len)
228 uint16_t packet_size;
231 assert (*sockfd >= 0);
233 /* send short containing size of data packet */
234 packet_size = htons ((uint16_t) len);
236 if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
243 /* send data packet */
244 if (swrite (*sockfd, (void *) buff, len) != 0)
254 /* Get and print status from apcupsd NIS server */
255 static int apc_query_server (char const *node, char const *service,
256 struct apc_detail_s *apcups_detail)
268 # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val)
270 # define PRINT_VALUE(name, val) /**/
275 if (global_sockfd < 0)
277 global_sockfd = net_open (node, service);
278 if (global_sockfd < 0)
280 ERROR ("apcups plugin: Connecting to the "
287 status = net_send (&global_sockfd, "status", strlen ("status"));
290 /* net_send is closing the socket on error. */
291 assert (global_sockfd < 0);
299 ERROR ("apcups plugin: Writing to the socket failed.");
304 } /* while (retry) */
306 /* When collectd's collection interval is larger than apcupsd's
307 * timeout, we would have to retry / re-connect each iteration. Try to
308 * detect this situation and shut down the socket gracefully in that
309 * case. Otherwise, keep the socket open to avoid overhead. */
311 if ((count_iterations == 10) && (count_retries > 2))
313 NOTICE ("apcups plugin: There have been %i retries in the "
314 "first %i iterations. Will close the socket "
315 "in future iterations.",
316 count_retries, count_iterations);
317 conf_persistent_conn = 0;
320 while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
322 assert ((size_t)n < sizeof (recvline));
325 printf ("net_recv = `%s';\n", recvline);
326 #endif /* if APCMAIN */
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)
383 _Bool persistent_conn_set = 0;
385 for (int 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);
397 persistent_conn_set = 1;
400 ERROR ("apcups plugin: Unknown config option \"%s\".", child->key);
403 if (!persistent_conn_set) {
404 double interval = CDTIME_T_TO_DOUBLE(plugin_get_interval());
405 if (interval > APCUPS_SERVER_TIMEOUT) {
406 NOTICE ("apcups plugin: Plugin poll interval set to %.3f seconds. "
407 "Apcupsd NIS socket timeout is %.3f seconds, "
408 "PersistentConnection disabled by default.",
409 interval, APCUPS_SERVER_TIMEOUT);
410 conf_persistent_conn = 0;
415 } /* int apcups_config */
417 static void apc_submit_generic (const char *type, const char *type_inst, double value)
419 value_list_t vl = VALUE_LIST_INIT;
421 vl.values = &(value_t) { .gauge = value };
423 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
424 sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin));
425 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
426 sstrncpy (vl.type, type, sizeof (vl.type));
427 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
429 plugin_dispatch_values (&vl);
432 static void apc_submit (struct apc_detail_s *apcups_detail)
434 apc_submit_generic ("voltage", "input", apcups_detail->linev);
435 apc_submit_generic ("voltage", "output", apcups_detail->outputv);
436 apc_submit_generic ("voltage", "battery", apcups_detail->battv);
437 apc_submit_generic ("charge", "", apcups_detail->bcharge);
438 apc_submit_generic ("percent", "load", apcups_detail->loadpct);
439 apc_submit_generic ("timeleft", "", apcups_detail->timeleft);
440 apc_submit_generic ("temperature", "", apcups_detail->itemp);
441 apc_submit_generic ("frequency", "input", apcups_detail->linefreq);
444 static int apcups_read (void)
446 struct apc_detail_s apcups_detail;
449 apcups_detail.linev = -1.0;
450 apcups_detail.outputv = -1.0;
451 apcups_detail.battv = -1.0;
452 apcups_detail.loadpct = -1.0;
453 apcups_detail.bcharge = -1.0;
454 apcups_detail.timeleft = NAN;
455 apcups_detail.itemp = -300.0;
456 apcups_detail.linefreq = -1.0;
458 status = apc_query_server ((conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
459 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
463 * if we did not connect then do not bother submitting
464 * zeros. We want rrd files to have NAN.
468 DEBUG ("apcups plugin: apc_query_server (%s, %s) = %i",
469 (conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
470 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
475 apc_submit (&apcups_detail);
480 void module_register (void)
482 plugin_register_complex_config ("apcups", apcups_config);
483 plugin_register_read ("apcups", apcups_read);
484 plugin_register_shutdown ("apcups", apcups_shutdown);
485 } /* void module_register */