2 * collectd - src/apcups.c
3 * Copyright (C) 2006-2007 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 verplant.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>
36 # include <sys/socket.h>
43 # include <netinet/in.h>
48 #define MODULE_NAME "apcups"
50 #define APCUPS_DEFAULT_HOST "localhost"
70 /* Default values for contacting daemon */
71 static char *conf_host = NULL;
72 static int conf_port = NISPORT;
74 static int global_sockfd = -1;
76 static const char *config_keys[] =
82 static int config_keys_num = 2;
84 /* Close the network connection */
85 static int apcups_shutdown (void)
87 uint16_t packet_size = 0;
89 if (global_sockfd < 0)
92 DEBUG ("Gracefully shutting down socket %i.", global_sockfd);
94 /* send EOF sentinel */
95 swrite (global_sockfd, (void *) &packet_size, sizeof (packet_size));
97 close (global_sockfd);
101 } /* int apcups_shutdown */
104 * Open a TCP connection to the UPS network server
105 * Returns -1 on error
106 * Returns socket file descriptor otherwise
108 static int net_open (char *host, int port)
113 struct addrinfo ai_hints;
114 struct addrinfo *ai_return;
115 struct addrinfo *ai_list;
117 assert ((port > 0x00000000) && (port <= 0x0000FFFF));
119 /* Convert the port to a string */
120 ssnprintf (port_str, sizeof (port_str), "%i", port);
123 memset ((void *) &ai_hints, '\0', sizeof (ai_hints));
124 ai_hints.ai_family = AF_INET; /* XXX: Change this to `AF_UNSPEC' if apcupsd can handle IPv6 */
125 ai_hints.ai_socktype = SOCK_STREAM;
127 status = getaddrinfo (host, port_str, &ai_hints, &ai_return);
131 INFO ("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 ("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 ("connect failed: %s",
163 sstrerror (errno, errbuf, sizeof (errbuf)));
168 DEBUG ("Done opening a socket %i", sd);
171 } /* int net_open (char *host, char *service, int port) */
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, 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 *host, int port,
256 struct apc_detail_s *apcups_detail)
266 # define PRINT_VALUE(name, val) printf(" Found property: name = %s; value = %f;\n", name, val)
268 # define PRINT_VALUE(name, val) /**/
271 if (global_sockfd < 0)
273 global_sockfd = net_open (host, port);
274 if (global_sockfd < 0)
276 ERROR ("apcups plugin: Connecting to the "
282 if (net_send (&global_sockfd, "status", 6) < 0)
284 ERROR ("apcups plugin: Writing to the socket failed.");
288 while ((n = net_recv (&global_sockfd, recvline, sizeof (recvline) - 1)) > 0)
290 assert ((unsigned int)n < sizeof (recvline));
293 printf ("net_recv = `%s';\n", recvline);
294 #endif /* if APCMAIN */
297 tokptr = strtok_r (recvline, " :\t", &toksaveptr);
298 while (tokptr != NULL)
301 if ((tokptr = strtok_r (NULL, " :\t", &toksaveptr)) == NULL)
303 value = atof (tokptr);
305 PRINT_VALUE (key, value);
307 if (strcmp ("LINEV", key) == 0)
308 apcups_detail->linev = value;
309 else if (strcmp ("BATTV", key) == 0)
310 apcups_detail->battv = value;
311 else if (strcmp ("ITEMP", key) == 0)
312 apcups_detail->itemp = value;
313 else if (strcmp ("LOADPCT", key) == 0)
314 apcups_detail->loadpct = value;
315 else if (strcmp ("BCHARGE", key) == 0)
316 apcups_detail->bcharge = value;
317 else if (strcmp ("OUTPUTV", key) == 0)
318 apcups_detail->outputv = value;
319 else if (strcmp ("LINEFREQ", key) == 0)
320 apcups_detail->linefreq = value;
321 else if (strcmp ("TIMELEFT", key) == 0)
322 apcups_detail->timeleft = value;
324 tokptr = strtok_r (NULL, ":", &toksaveptr);
325 } /* while (tokptr != NULL) */
330 WARNING ("apcups plugin: Error reading from socket");
337 static int apcups_config (const char *key, const char *value)
339 if (strcasecmp (key, "host") == 0)
341 if (conf_host != NULL)
346 if ((conf_host = strdup (value)) == NULL)
349 else if (strcasecmp (key, "Port") == 0)
351 int port_tmp = atoi (value);
352 if (port_tmp < 1 || port_tmp > 65535)
354 WARNING ("apcups plugin: Invalid port: %i", port_tmp);
357 conf_port = port_tmp;
366 static void apc_submit_generic (char *type, char *type_inst, double value)
369 value_list_t vl = VALUE_LIST_INIT;
371 values[0].gauge = value;
375 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
376 sstrncpy (vl.plugin, "apcups", sizeof (vl.plugin));
377 sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
378 sstrncpy (vl.type, type, sizeof (vl.type));
379 sstrncpy (vl.type_instance, type_inst, sizeof (vl.type_instance));
381 plugin_dispatch_values (&vl);
384 static void apc_submit (struct apc_detail_s *apcups_detail)
386 apc_submit_generic ("voltage", "input", apcups_detail->linev);
387 apc_submit_generic ("voltage", "output", apcups_detail->outputv);
388 apc_submit_generic ("voltage", "battery", apcups_detail->battv);
389 apc_submit_generic ("charge", "", apcups_detail->bcharge);
390 apc_submit_generic ("percent", "load", apcups_detail->loadpct);
391 apc_submit_generic ("timeleft", "", apcups_detail->timeleft);
392 apc_submit_generic ("temperature", "", apcups_detail->itemp);
393 apc_submit_generic ("frequency", "input", apcups_detail->linefreq);
396 static int apcups_read (void)
398 struct apc_detail_s apcups_detail;
401 apcups_detail.linev = -1.0;
402 apcups_detail.outputv = -1.0;
403 apcups_detail.battv = -1.0;
404 apcups_detail.loadpct = -1.0;
405 apcups_detail.bcharge = -1.0;
406 apcups_detail.timeleft = -1.0;
407 apcups_detail.itemp = -300.0;
408 apcups_detail.linefreq = -1.0;
410 status = apc_query_server (conf_host == NULL
411 ? APCUPS_DEFAULT_HOST
413 conf_port, &apcups_detail);
416 * if we did not connect then do not bother submitting
417 * zeros. We want rrd files to have NAN.
421 DEBUG ("apc_query_server (%s, %i) = %i",
423 ? APCUPS_DEFAULT_HOST
429 apc_submit (&apcups_detail);
434 void module_register (void)
436 plugin_register_config ("apcups", apcups_config, config_keys,
438 plugin_register_read ("apcups", apcups_read);
439 plugin_register_shutdown ("apcups", apcups_shutdown);
440 } /* void module_register */