1 /*
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>
7 *
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.
11 *
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.
16 *
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,
20 * MA 02111-1307, USA.
21 *
22 * Authors:
23 * Anthony Gialluca <tonyabg at charter.net>
24 * Florian octo Forster <octo at collectd.org>
25 **/
27 #include "collectd.h"
28 #include "common.h" /* rrd_update_file */
29 #include "plugin.h" /* plugin_register, plugin_submit */
30 #include "configfile.h" /* cf_register */
32 #if HAVE_SYS_TYPES_H
33 # include <sys/types.h>
34 #endif
35 #if HAVE_NETDB_H
36 # include <netdb.h>
37 #endif
39 #if HAVE_NETINET_IN_H
40 # include <netinet/in.h>
41 #endif
43 #ifndef APCUPS_SERVER_TIMEOUT
44 # define APCUPS_SERVER_TIMEOUT 15.0
45 #endif
47 #ifndef APCUPS_DEFAULT_NODE
48 # define APCUPS_DEFAULT_NODE "localhost"
49 #endif
51 #ifndef APCUPS_DEFAULT_SERVICE
52 # define APCUPS_DEFAULT_SERVICE "3551"
53 #endif
55 /*
56 * Private data types
57 */
58 struct apc_detail_s
59 {
60 double linev;
61 double loadpct;
62 double bcharge;
63 double timeleft;
64 double outputv;
65 double itemp;
66 double battv;
67 double linefreq;
68 };
70 /*
71 * Private variables
72 */
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)
86 {
87 uint16_t packet_size = 0;
89 if ((fd == NULL) || (*fd < 0))
90 return (EINVAL);
92 (void)swrite (*fd, (void *) &packet_size, sizeof (packet_size));
93 close (*fd);
94 *fd = -1;
96 return (0);
97 } /* int net_shutdown */
99 /* Close the network connection */
100 static int apcups_shutdown (void)
101 {
102 if (global_sockfd < 0)
103 return (0);
105 net_shutdown (&global_sockfd);
106 return (0);
107 } /* int apcups_shutdown */
109 /*
110 * Open a TCP connection to the UPS network server
111 * Returns -1 on error
112 * Returns socket file descriptor otherwise
113 */
114 static int net_open (char const *node, char const *service)
115 {
116 int sd;
117 int status;
118 struct addrinfo ai_hints;
119 struct addrinfo *ai_return;
120 struct addrinfo *ai_list;
122 /* Resolve name */
123 memset (&ai_hints, 0, sizeof (ai_hints));
124 /* TODO: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
125 ai_hints.ai_family = AF_INET;
126 ai_hints.ai_socktype = SOCK_STREAM;
128 status = getaddrinfo (node, service, &ai_hints, &ai_return);
129 if (status != 0)
130 {
131 char errbuf[1024];
132 INFO ("apcups plugin: getaddrinfo failed: %s",
133 (status == EAI_SYSTEM)
134 ? sstrerror (errno, errbuf, sizeof (errbuf))
135 : gai_strerror (status));
136 return (-1);
137 }
139 /* Create socket */
140 sd = -1;
141 for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
142 {
143 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
144 if (sd >= 0)
145 break;
146 }
147 /* `ai_list' still holds the current description of the socket.. */
149 if (sd < 0)
150 {
151 DEBUG ("apcups plugin: Unable to open a socket");
152 freeaddrinfo (ai_return);
153 return (-1);
154 }
156 status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
158 freeaddrinfo (ai_return);
160 if (status != 0) /* `connect(2)' failed */
161 {
162 char errbuf[1024];
163 INFO ("apcups plugin: connect failed: %s",
164 sstrerror (errno, errbuf, sizeof (errbuf)));
165 close (sd);
166 return (-1);
167 }
169 DEBUG ("apcups plugin: Done opening a socket %i", sd);
171 return (sd);
172 } /* int net_open */
174 /*
175 * Receive a message from the other end. Each message consists of
176 * two packets. The first is a header that contains the size
177 * of the data that follows in the second packet.
178 * Returns number of bytes read
179 * Returns 0 on end of file
180 * Returns -1 on hard end of file (i.e. network connection close)
181 * Returns -2 on error
182 */
183 static int net_recv (int *sockfd, char *buf, int buflen)
184 {
185 uint16_t packet_size;
187 /* get data size -- in short */
188 if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
189 {
190 close (*sockfd);
191 *sockfd = -1;
192 return (-1);
193 }
195 packet_size = ntohs (packet_size);
196 if (packet_size > buflen)
197 {
198 ERROR ("apcups plugin: Received %"PRIu16" bytes of payload "
199 "but have only %i bytes of buffer available.",
200 packet_size, buflen);
201 close (*sockfd);
202 *sockfd = -1;
203 return (-2);
204 }
206 if (packet_size == 0)
207 return (0);
209 /* now read the actual data */
210 if (sread (*sockfd, (void *) buf, packet_size) != 0)
211 {
212 close (*sockfd);
213 *sockfd = -1;
214 return (-1);
215 }
217 return ((int) packet_size);
218 } /* static int net_recv (int *sockfd, char *buf, int buflen) */
220 /*
221 * Send a message over the network. The send consists of
222 * two network packets. The first is sends a short containing
223 * the length of the data packet which follows.
224 * Returns zero on success
225 * Returns non-zero on error
226 */
227 static int net_send (int *sockfd, const char *buff, int len)
228 {
229 uint16_t packet_size;
231 assert (len > 0);
232 assert (*sockfd >= 0);
234 /* send short containing size of data packet */
235 packet_size = htons ((uint16_t) len);
237 if (swrite (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
238 {
239 close (*sockfd);
240 *sockfd = -1;
241 return (-1);
242 }
244 /* send data packet */
245 if (swrite (*sockfd, (void *) buff, len) != 0)
246 {
247 close (*sockfd);
248 *sockfd = -1;
249 return (-2);
250 }
252 return (0);
253 }
255 /* Get and print status from apcupsd NIS server */
256 static int apc_query_server (char const *node, char const *service,
257 struct apc_detail_s *apcups_detail)
258 {
259 int n;
260 char recvline[1024];
261 char *tokptr;
262 char *toksaveptr;
263 char *key;
264 double value;
265 _Bool retry = 1;
266 int status;
268 #if APCMAIN
269 # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val)
270 #else
271 # define PRINT_VALUE(name, val) /**/
272 #endif
274 while (retry)
275 {
276 if (global_sockfd < 0)
277 {
278 global_sockfd = net_open (node, service);
279 if (global_sockfd < 0)
280 {
281 ERROR ("apcups plugin: Connecting to the "
282 "apcupsd failed.");
283 return (-1);
284 }
285 }
288 status = net_send (&global_sockfd, "status", strlen ("status"));
289 if (status != 0)
290 {
291 /* net_send is closing the socket on error. */
292 assert (global_sockfd < 0);
293 if (retry)
294 {
295 retry = 0;
296 count_retries++;
297 continue;
298 }
300 ERROR ("apcups plugin: Writing to the socket failed.");
301 return (-1);
302 }
304 break;
305 } /* while (retry) */
307 /* When collectd's collection interval is larger than apcupsd's
308 * timeout, we would have to retry / re-connect each iteration. Try to
309 * detect this situation and shut down the socket gracefully in that
310 * case. Otherwise, keep the socket open to avoid overhead. */
311 count_iterations++;
312 if ((count_iterations == 10) && (count_retries > 2))
313 {
314 NOTICE ("apcups plugin: There have been %i retries in the "
315 "first %i iterations. Will close the socket "
316 "in future iterations.",
317 count_retries, count_iterations);
318 conf_persistent_conn = 0;
319 }
321 while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
322 {
323 assert ((size_t)n < sizeof (recvline));
324 recvline[n] = 0;
325 #if APCMAIN
326 printf ("net_recv = `%s';\n", recvline);
327 #endif /* if APCMAIN */
329 toksaveptr = NULL;
330 tokptr = strtok_r (recvline, " :\t", &toksaveptr);
331 while (tokptr != NULL)
332 {
333 key = tokptr;
334 if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == NULL)
335 continue;
336 value = atof (tokptr);
338 PRINT_VALUE (key, value);
340 if (strcmp ("LINEV", key) == 0)
341 apcups_detail->linev = value;
342 else if (strcmp ("BATTV", key) == 0)
343 apcups_detail->battv = value;
344 else if (strcmp ("ITEMP", key) == 0)
345 apcups_detail->itemp = value;
346 else if (strcmp ("LOADPCT", key) == 0)
347 apcups_detail->loadpct = value;
348 else if (strcmp ("BCHARGE", key) == 0)
349 apcups_detail->bcharge = value;
350 else if (strcmp ("OUTPUTV", key) == 0)
351 apcups_detail->outputv = value;
352 else if (strcmp ("LINEFREQ", key) == 0)
353 apcups_detail->linefreq = value;
354 else if (strcmp ("TIMELEFT", key) == 0)
355 {
356 /* Convert minutes to seconds if requested by
357 * the user. */
358 if (conf_report_seconds)
359 value *= 60.0;
360 apcups_detail->timeleft = value;
361 }
363 tokptr = strtok_r (NULL, ":", &toksaveptr);
364 } /* while (tokptr != NULL) */
365 }
366 status = errno; /* save errno, net_shutdown() may re-set it. */
368 if (!conf_persistent_conn)
369 net_shutdown (&global_sockfd);
371 if (n < 0)
372 {
373 char errbuf[1024];
374 ERROR ("apcups plugin: Reading from socket failed: %s",
375 sstrerror (status, errbuf, sizeof (errbuf)));
376 return (-1);
377 }
379 return (0);
380 }
382 static int apcups_config (oconfig_item_t *ci)
383 {
384 int i;
385 _Bool persistent_conn_set = 0;
387 for (i = 0; i < ci->children_num; i++)
388 {
389 oconfig_item_t *child = ci->children + i;
391 if (strcasecmp (child->key, "Host") == 0)
392 cf_util_get_string (child, &conf_node);
393 else if (strcasecmp (child->key, "Port") == 0)
394 cf_util_get_service (child, &conf_service);
395 else if (strcasecmp (child->key, "ReportSeconds") == 0)
396 cf_util_get_boolean (child, &conf_report_seconds);
397 else if (strcasecmp (child->key, "PersistentConnection") == 0) {
398 cf_util_get_boolean (child, &conf_persistent_conn);
399 persistent_conn_set = 1;
400 }
401 else
402 ERROR ("apcups plugin: Unknown config option \"%s\".", child->key);
403 }
405 if (!persistent_conn_set) {
406 double interval = CDTIME_T_TO_DOUBLE(plugin_get_interval());
407 if (interval > APCUPS_SERVER_TIMEOUT) {
408 NOTICE ("apcups plugin: Plugin poll interval set to %.3f seconds. "
409 "Apcupsd NIS socket timeout is %.3f seconds, "
410 "PersistentConnection disabled by default.",
411 interval, APCUPS_SERVER_TIMEOUT);
412 conf_persistent_conn = 0;
413 }
414 }
416 return (0);
417 } /* int apcups_config */
419 static void apc_submit_generic (const char *type, const char *type_inst, double value)
420 {
421 value_t values[1];
422 value_list_t vl = VALUE_LIST_INIT;
424 values[0].gauge = value;
426 vl.values = values;
427 vl.values_len = 1;
428 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
429 sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin));
430 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
431 sstrncpy (vl.type, type, sizeof (vl.type));
432 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
434 plugin_dispatch_values (&vl);
435 }
437 static void apc_submit (struct apc_detail_s *apcups_detail)
438 {
439 apc_submit_generic ("voltage", "input", apcups_detail->linev);
440 apc_submit_generic ("voltage", "output", apcups_detail->outputv);
441 apc_submit_generic ("voltage", "battery", apcups_detail->battv);
442 apc_submit_generic ("charge", "", apcups_detail->bcharge);
443 apc_submit_generic ("percent", "load", apcups_detail->loadpct);
444 apc_submit_generic ("timeleft", "", apcups_detail->timeleft);
445 apc_submit_generic ("temperature", "", apcups_detail->itemp);
446 apc_submit_generic ("frequency", "input", apcups_detail->linefreq);
447 }
449 static int apcups_read (void)
450 {
451 struct apc_detail_s apcups_detail;
452 int status;
454 apcups_detail.linev = -1.0;
455 apcups_detail.outputv = -1.0;
456 apcups_detail.battv = -1.0;
457 apcups_detail.loadpct = -1.0;
458 apcups_detail.bcharge = -1.0;
459 apcups_detail.timeleft = NAN;
460 apcups_detail.itemp = -300.0;
461 apcups_detail.linefreq = -1.0;
463 status = apc_query_server ((conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
464 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
465 &apcups_detail);
467 /*
468 * if we did not connect then do not bother submitting
469 * zeros. We want rrd files to have NAN.
470 */
471 if (status != 0)
472 {
473 DEBUG ("apcups plugin: apc_query_server (%s, %s) = %i",
474 (conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
475 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
476 status);
477 return (-1);
478 }
480 apc_submit (&apcups_detail);
482 return (0);
483 } /* apcups_read */
485 void module_register (void)
486 {
487 plugin_register_complex_config ("apcups", apcups_config);
488 plugin_register_read ("apcups", apcups_read);
489 plugin_register_shutdown ("apcups", apcups_shutdown);
490 } /* void module_register */