591f6acd652b092db8a9332acb868d91d5e2f08a
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_DEFAULT_NODE
44 # define APCUPS_DEFAULT_NODE "localhost"
45 #endif
47 #ifndef APCUPS_DEFAULT_SERVICE
48 # define APCUPS_DEFAULT_SERVICE "3551"
49 #endif
51 /*
52 * Private data types
53 */
54 struct apc_detail_s
55 {
56 double linev;
57 double loadpct;
58 double bcharge;
59 double timeleft;
60 double outputv;
61 double itemp;
62 double battv;
63 double linefreq;
64 };
66 /*
67 * Private variables
68 */
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)
82 {
83 uint16_t packet_size = 0;
85 if ((fd == NULL) || (*fd < 0))
86 return (EINVAL);
88 swrite (*fd, (void *) &packet_size, sizeof (packet_size));
89 close (*fd);
90 *fd = -1;
92 return (0);
93 } /* int net_shutdown */
95 /* Close the network connection */
96 static int apcups_shutdown (void)
97 {
98 if (global_sockfd < 0)
99 return (0);
101 net_shutdown (&global_sockfd);
102 return (0);
103 } /* int apcups_shutdown */
105 /*
106 * Open a TCP connection to the UPS network server
107 * Returns -1 on error
108 * Returns socket file descriptor otherwise
109 */
110 static int net_open (char const *node, char const *service)
111 {
112 int sd;
113 int status;
114 struct addrinfo ai_hints;
115 struct addrinfo *ai_return;
116 struct addrinfo *ai_list;
118 /* Resolve name */
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);
125 if (status != 0)
126 {
127 char errbuf[1024];
128 INFO ("apcups plugin: getaddrinfo failed: %s",
129 (status == EAI_SYSTEM)
130 ? sstrerror (errno, errbuf, sizeof (errbuf))
131 : gai_strerror (status));
132 return (-1);
133 }
135 /* Create socket */
136 sd = -1;
137 for (ai_list = ai_return; ai_list != NULL; ai_list = ai_list->ai_next)
138 {
139 sd = socket (ai_list->ai_family, ai_list->ai_socktype, ai_list->ai_protocol);
140 if (sd >= 0)
141 break;
142 }
143 /* `ai_list' still holds the current description of the socket.. */
145 if (sd < 0)
146 {
147 DEBUG ("apcups plugin: Unable to open a socket");
148 freeaddrinfo (ai_return);
149 return (-1);
150 }
152 status = connect (sd, ai_list->ai_addr, ai_list->ai_addrlen);
154 freeaddrinfo (ai_return);
156 if (status != 0) /* `connect(2)' failed */
157 {
158 char errbuf[1024];
159 INFO ("apcups plugin: connect failed: %s",
160 sstrerror (errno, errbuf, sizeof (errbuf)));
161 close (sd);
162 return (-1);
163 }
165 DEBUG ("apcups plugin: Done opening a socket %i", sd);
167 return (sd);
168 } /* int net_open */
170 /*
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
178 */
179 static int net_recv (int *sockfd, char *buf, int buflen)
180 {
181 uint16_t packet_size;
183 /* get data size -- in short */
184 if (sread (*sockfd, (void *) &packet_size, sizeof (packet_size)) != 0)
185 {
186 close (*sockfd);
187 *sockfd = -1;
188 return (-1);
189 }
191 packet_size = ntohs (packet_size);
192 if (packet_size > buflen)
193 {
194 ERROR ("apcups plugin: Received %"PRIu16" bytes of payload "
195 "but have only %i bytes of buffer available.",
196 packet_size, buflen);
197 close (*sockfd);
198 *sockfd = -1;
199 return (-2);
200 }
202 if (packet_size == 0)
203 return (0);
205 /* now read the actual data */
206 if (sread (*sockfd, (void *) buf, packet_size) != 0)
207 {
208 close (*sockfd);
209 *sockfd = -1;
210 return (-1);
211 }
213 return ((int) packet_size);
214 } /* static int net_recv (int *sockfd, char *buf, int buflen) */
216 /*
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
222 */
223 static int net_send (int *sockfd, const char *buff, int len)
224 {
225 uint16_t packet_size;
227 assert (len > 0);
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)
234 {
235 close (*sockfd);
236 *sockfd = -1;
237 return (-1);
238 }
240 /* send data packet */
241 if (swrite (*sockfd, (void *) buff, len) != 0)
242 {
243 close (*sockfd);
244 *sockfd = -1;
245 return (-2);
246 }
248 return (0);
249 }
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)
254 {
255 int n;
256 char recvline[1024];
257 char *tokptr;
258 char *toksaveptr;
259 char *key;
260 double value;
261 _Bool retry = 1;
262 int status;
264 #if APCMAIN
265 # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val)
266 #else
267 # define PRINT_VALUE(name, val) /**/
268 #endif
270 while (retry)
271 {
272 if (global_sockfd < 0)
273 {
274 global_sockfd = net_open (node, service);
275 if (global_sockfd < 0)
276 {
277 ERROR ("apcups plugin: Connecting to the "
278 "apcupsd failed.");
279 return (-1);
280 }
281 }
284 status = net_send (&global_sockfd, "status", strlen ("status"));
285 if (status != 0)
286 {
287 /* net_send is closing the socket on error. */
288 assert (global_sockfd < 0);
289 if (retry)
290 {
291 retry = 0;
292 count_retries++;
293 continue;
294 }
296 ERROR ("apcups plugin: Writing to the socket failed.");
297 return (-1);
298 }
300 break;
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. */
307 count_iterations++;
308 if ((count_iterations == 10) && (count_retries > 2))
309 {
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;
315 }
317 while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
318 {
319 assert ((size_t)n < sizeof (recvline));
320 recvline[n] = 0;
321 #if APCMAIN
322 printf ("net_recv = `%s';\n", recvline);
323 #endif /* if APCMAIN */
325 toksaveptr = NULL;
326 tokptr = strtok_r (recvline, " :\t", &toksaveptr);
327 while (tokptr != NULL)
328 {
329 key = tokptr;
330 if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == NULL)
331 continue;
332 value = atof (tokptr);
334 PRINT_VALUE (key, value);
336 if (strcmp ("LINEV", key) == 0)
337 apcups_detail->linev = value;
338 else if (strcmp ("BATTV", key) == 0)
339 apcups_detail->battv = value;
340 else if (strcmp ("ITEMP", key) == 0)
341 apcups_detail->itemp = value;
342 else if (strcmp ("LOADPCT", key) == 0)
343 apcups_detail->loadpct = value;
344 else if (strcmp ("BCHARGE", key) == 0)
345 apcups_detail->bcharge = value;
346 else if (strcmp ("OUTPUTV", key) == 0)
347 apcups_detail->outputv = value;
348 else if (strcmp ("LINEFREQ", key) == 0)
349 apcups_detail->linefreq = value;
350 else if (strcmp ("TIMELEFT", key) == 0)
351 {
352 /* Convert minutes to seconds if requested by
353 * the user. */
354 if (conf_report_seconds)
355 value *= 60.0;
356 apcups_detail->timeleft = value;
357 }
359 tokptr = strtok_r (NULL, ":", &toksaveptr);
360 } /* while (tokptr != NULL) */
361 }
362 status = errno; /* save errno, net_shutdown() may re-set it. */
364 if (!conf_persistent_conn)
365 net_shutdown (&global_sockfd);
367 if (n < 0)
368 {
369 char errbuf[1024];
370 ERROR ("apcups plugin: Reading from socket failed: %s",
371 sstrerror (status, errbuf, sizeof (errbuf)));
372 return (-1);
373 }
375 return (0);
376 }
378 static int apcups_config (oconfig_item_t *ci)
379 {
380 int i;
381 _Bool persistent_conn_set = 0;
383 for (i = 0; i < ci->children_num; i++)
384 {
385 oconfig_item_t *child = ci->children + i;
387 if (strcasecmp (child->key, "Host") == 0)
388 cf_util_get_string (child, &conf_node);
389 else if (strcasecmp (child->key, "Port") == 0)
390 cf_util_get_service (child, &conf_service);
391 else if (strcasecmp (child->key, "ReportSeconds") == 0)
392 cf_util_get_boolean (child, &conf_report_seconds);
393 else if (strcasecmp (child->key, "PersistentConnection") == 0) {
394 cf_util_get_boolean (child, &conf_persistent_conn);
395 persistent_conn_set = 1;
396 }
397 else
398 ERROR ("apcups plugin: Unknown config option \"%s\".", child->key);
399 }
401 if (!persistent_conn_set) {
402 double interval = CDTIME_T_TO_DOUBLE(plugin_get_interval());
403 if (interval > 15.0) {
404 NOTICE ("apcups plugin: Plugin poll interval set to %.3f seconds. "
405 "Apcupsd NIS socket timeout is 15 seconds, "
406 "PersistentConnection disabled by default.",
407 interval);
408 conf_persistent_conn = 0;
409 }
410 }
412 return (0);
413 } /* int apcups_config */
415 static void apc_submit_generic (const char *type, const char *type_inst, double value)
416 {
417 value_t values[1];
418 value_list_t vl = VALUE_LIST_INIT;
420 values[0].gauge = value;
422 vl.values = values;
423 vl.values_len = 1;
424 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
425 sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin));
426 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
427 sstrncpy (vl.type, type, sizeof (vl.type));
428 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
430 plugin_dispatch_values (&vl);
431 }
433 static void apc_submit (struct apc_detail_s *apcups_detail)
434 {
435 apc_submit_generic ("voltage", "input", apcups_detail->linev);
436 apc_submit_generic ("voltage", "output", apcups_detail->outputv);
437 apc_submit_generic ("voltage", "battery", apcups_detail->battv);
438 apc_submit_generic ("charge", "", apcups_detail->bcharge);
439 apc_submit_generic ("percent", "load", apcups_detail->loadpct);
440 apc_submit_generic ("timeleft", "", apcups_detail->timeleft);
441 apc_submit_generic ("temperature", "", apcups_detail->itemp);
442 apc_submit_generic ("frequency", "input", apcups_detail->linefreq);
443 }
445 static int apcups_read (void)
446 {
447 struct apc_detail_s apcups_detail;
448 int status;
450 apcups_detail.linev = -1.0;
451 apcups_detail.outputv = -1.0;
452 apcups_detail.battv = -1.0;
453 apcups_detail.loadpct = -1.0;
454 apcups_detail.bcharge = -1.0;
455 apcups_detail.timeleft = NAN;
456 apcups_detail.itemp = -300.0;
457 apcups_detail.linefreq = -1.0;
459 status = apc_query_server ((conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
460 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
461 &apcups_detail);
463 /*
464 * if we did not connect then do not bother submitting
465 * zeros. We want rrd files to have NAN.
466 */
467 if (status != 0)
468 {
469 DEBUG ("apcups plugin: apc_query_server (%s, %s) = %i",
470 (conf_node == NULL) ? APCUPS_DEFAULT_NODE : conf_node,
471 (conf_service == NULL) ? APCUPS_DEFAULT_SERVICE : conf_service,
472 status);
473 return (-1);
474 }
476 apc_submit (&apcups_detail);
478 return (0);
479 } /* apcups_read */
481 void module_register (void)
482 {
483 plugin_register_complex_config ("apcups", apcups_config);
484 plugin_register_read ("apcups", apcups_read);
485 plugin_register_shutdown ("apcups", apcups_shutdown);
486 } /* void module_register */