1 /**
2 * collectd - src/pinba.c (based on code from pinba_engine 0.0.5)
3 * Copyright (c) 2007-2009 Antony Dovgal
4 * Copyright (C) 2010 Phoenix Kayo
5 * Copyright (C) 2010 Florian Forster
6 *
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 *
20 * Authors:
21 * Antony Dovgal <tony at daylessday.org>
22 * Phoenix Kayo <kayo.k11.4 at gmail.com>
23 * Florian Forster <octo at collectd.org>
24 **/
26 #include "collectd.h"
27 #include "common.h"
28 #include "plugin.h"
29 #include "configfile.h"
31 #include <netdb.h>
32 #include <poll.h>
34 #include "pinba.pb-c.h"
36 /* AIX doesn't have MSG_DONTWAIT */
37 #ifndef MSG_DONTWAIT
38 # define MSG_DONTWAIT MSG_NONBLOCK
39 #endif
41 /*
42 * Defines
43 */
44 #ifndef PINBA_UDP_BUFFER_SIZE
45 # define PINBA_UDP_BUFFER_SIZE 65536
46 #endif
48 #ifndef PINBA_DEFAULT_NODE
49 # define PINBA_DEFAULT_NODE "::0"
50 #endif
52 #ifndef PINBA_DEFAULT_SERVICE
53 # define PINBA_DEFAULT_SERVICE "30002"
54 #endif
56 #ifndef PINBA_MAX_SOCKETS
57 # define PINBA_MAX_SOCKETS 16
58 #endif
60 /*
61 * Private data structures
62 */
63 /* {{{ */
64 struct pinba_socket_s
65 {
66 struct pollfd fd[PINBA_MAX_SOCKETS];
67 nfds_t fd_num;
68 };
69 typedef struct pinba_socket_s pinba_socket_t;
71 /* Fixed point counter value. n is the decimal part multiplied by 10^9. */
72 struct float_counter_s
73 {
74 uint64_t i;
75 uint64_t n; /* nanos */
76 };
77 typedef struct float_counter_s float_counter_t;
79 struct pinba_statnode_s
80 {
81 /* collector name, used as plugin instance */
82 char *name;
84 /* query data */
85 char *host;
86 char *server;
87 char *script;
89 derive_t req_count;
91 float_counter_t req_time;
92 float_counter_t ru_utime;
93 float_counter_t ru_stime;
95 derive_t doc_size;
96 gauge_t mem_peak;
97 };
98 typedef struct pinba_statnode_s pinba_statnode_t;
99 /* }}} */
101 /*
102 * Module global variables
103 */
104 /* {{{ */
105 static pinba_statnode_t *stat_nodes = NULL;
106 static unsigned int stat_nodes_num = 0;
107 static pthread_mutex_t stat_nodes_lock;
109 static char *conf_node = NULL;
110 static char *conf_service = NULL;
112 static _Bool collector_thread_running = 0;
113 static _Bool collector_thread_do_shutdown = 0;
114 static pthread_t collector_thread_id;
115 /* }}} */
117 /*
118 * Functions
119 */
120 static void float_counter_add (float_counter_t *fc, float val) /* {{{ */
121 {
122 uint64_t tmp;
124 if (val < 0.0)
125 return;
127 tmp = (uint64_t) val;
128 val -= (double) tmp;
130 fc->i += tmp;
131 fc->n += (uint64_t) ((val * 1000000000.0) + .5);
133 if (fc->n >= 1000000000)
134 {
135 fc->i += 1;
136 fc->n -= 1000000000;
137 assert (fc->n < 1000000000);
138 }
139 } /* }}} void float_counter_add */
141 static derive_t float_counter_get (const float_counter_t *fc, /* {{{ */
142 uint64_t factor)
143 {
144 derive_t ret;
146 ret = (derive_t) (fc->i * factor);
147 ret += (derive_t) (fc->n / (1000000000 / factor));
149 return (ret);
150 } /* }}} derive_t float_counter_get */
152 static void strset (char **str, const char *new) /* {{{ */
153 {
154 char *tmp;
156 if (!str || !new)
157 return;
159 tmp = strdup (new);
160 if (tmp == NULL)
161 return;
163 sfree (*str);
164 *str = tmp;
165 } /* }}} void strset */
167 static void service_statnode_add(const char *name, /* {{{ */
168 const char *host,
169 const char *server,
170 const char *script)
171 {
172 pinba_statnode_t *node;
174 node = realloc (stat_nodes,
175 sizeof (*stat_nodes) * (stat_nodes_num + 1));
176 if (node == NULL)
177 {
178 ERROR ("pinba plugin: realloc failed");
179 return;
180 }
181 stat_nodes = node;
183 node = stat_nodes + stat_nodes_num;
184 memset (node, 0, sizeof (*node));
186 /* reset strings */
187 node->name = NULL;
188 node->host = NULL;
189 node->server = NULL;
190 node->script = NULL;
192 node->mem_peak = NAN;
194 /* fill query data */
195 strset (&node->name, name);
196 strset (&node->host, host);
197 strset (&node->server, server);
198 strset (&node->script, script);
200 /* increment counter */
201 stat_nodes_num++;
202 } /* }}} void service_statnode_add */
204 /* Copy the data from the global "stat_nodes" list into the buffer pointed to
205 * by "res", doing the derivation in the process. Returns the next index or
206 * zero if the end of the list has been reached. */
207 static unsigned int service_statnode_collect (pinba_statnode_t *res, /* {{{ */
208 unsigned int index)
209 {
210 pinba_statnode_t *node;
212 if (stat_nodes_num == 0)
213 return 0;
215 /* begin collecting */
216 if (index == 0)
217 pthread_mutex_lock (&stat_nodes_lock);
219 /* end collecting */
220 if (index >= stat_nodes_num)
221 {
222 pthread_mutex_unlock (&stat_nodes_lock);
223 return 0;
224 }
226 node = stat_nodes + index;
227 memcpy (res, node, sizeof (*res));
229 /* reset node */
230 node->mem_peak = NAN;
232 return (index + 1);
233 } /* }}} unsigned int service_statnode_collect */
235 static void service_statnode_process (pinba_statnode_t *node, /* {{{ */
236 Pinba__Request* request)
237 {
238 node->req_count++;
240 float_counter_add (&node->req_time, request->request_time);
241 float_counter_add (&node->ru_utime, request->ru_utime);
242 float_counter_add (&node->ru_stime, request->ru_stime);
244 node->doc_size += request->document_size;
246 if (isnan (node->mem_peak)
247 || (node->mem_peak < ((gauge_t) request->memory_peak)))
248 node->mem_peak = (gauge_t) request->memory_peak;
250 } /* }}} void service_statnode_process */
252 static void service_process_request (Pinba__Request *request) /* {{{ */
253 {
254 unsigned int i;
256 pthread_mutex_lock (&stat_nodes_lock);
258 for (i = 0; i < stat_nodes_num; i++)
259 {
260 if ((stat_nodes[i].host != NULL)
261 && (strcmp (request->hostname, stat_nodes[i].host) != 0))
262 continue;
264 if ((stat_nodes[i].server != NULL)
265 && (strcmp (request->server_name, stat_nodes[i].server) != 0))
266 continue;
268 if ((stat_nodes[i].script != NULL)
269 && (strcmp (request->script_name, stat_nodes[i].script) != 0))
270 continue;
272 service_statnode_process(&stat_nodes[i], request);
273 }
275 pthread_mutex_unlock(&stat_nodes_lock);
276 } /* }}} void service_process_request */
278 static int pb_del_socket (pinba_socket_t *s, /* {{{ */
279 nfds_t index)
280 {
281 if (index >= s->fd_num)
282 return (EINVAL);
284 close (s->fd[index].fd);
285 s->fd[index].fd = -1;
287 /* When deleting the last element in the list, no memmove is necessary. */
288 if (index < (s->fd_num - 1))
289 {
290 memmove (&s->fd[index], &s->fd[index + 1],
291 sizeof (s->fd[0]) * (s->fd_num - (index + 1)));
292 }
294 s->fd_num--;
295 return (0);
296 } /* }}} int pb_del_socket */
298 static int pb_add_socket (pinba_socket_t *s, /* {{{ */
299 const struct addrinfo *ai)
300 {
301 int fd;
302 int tmp;
303 int status;
305 if (s->fd_num == PINBA_MAX_SOCKETS)
306 {
307 WARNING ("pinba plugin: Sorry, you have hit the built-in limit of "
308 "%i sockets. Please complain to the collectd developers so we can "
309 "raise the limit.", PINBA_MAX_SOCKETS);
310 return (-1);
311 }
313 fd = socket (ai->ai_family, ai->ai_socktype, ai->ai_protocol);
314 if (fd < 0)
315 {
316 char errbuf[1024];
317 ERROR ("pinba plugin: socket(2) failed: %s",
318 sstrerror (errno, errbuf, sizeof (errbuf)));
319 return (0);
320 }
322 tmp = 1;
323 status = setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &tmp, sizeof (tmp));
324 if (status != 0)
325 {
326 char errbuf[1024];
327 WARNING ("pinba plugin: setsockopt(SO_REUSEADDR) failed: %s",
328 sstrerror (errno, errbuf, sizeof (errbuf)));
329 }
331 status = bind (fd, ai->ai_addr, ai->ai_addrlen);
332 if (status != 0)
333 {
334 char errbuf[1024];
335 ERROR ("pinba plugin: bind(2) failed: %s",
336 sstrerror (errno, errbuf, sizeof (errbuf)));
337 close (fd);
338 return (0);
339 }
341 s->fd[s->fd_num].fd = fd;
342 s->fd[s->fd_num].events = POLLIN | POLLPRI;
343 s->fd[s->fd_num].revents = 0;
344 s->fd_num++;
346 return (0);
347 } /* }}} int pb_add_socket */
349 static pinba_socket_t *pinba_socket_open (const char *node, /* {{{ */
350 const char *service)
351 {
352 pinba_socket_t *s;
353 struct addrinfo *ai_list;
354 struct addrinfo *ai_ptr;
355 struct addrinfo ai_hints;
356 int status;
358 memset (&ai_hints, 0, sizeof (ai_hints));
359 ai_hints.ai_flags = AI_PASSIVE;
360 ai_hints.ai_family = AF_UNSPEC;
361 ai_hints.ai_socktype = SOCK_DGRAM;
362 ai_hints.ai_addr = NULL;
363 ai_hints.ai_canonname = NULL;
364 ai_hints.ai_next = NULL;
366 if (node == NULL)
367 node = PINBA_DEFAULT_NODE;
369 if (service == NULL)
370 service = PINBA_DEFAULT_SERVICE;
372 ai_list = NULL;
373 status = getaddrinfo (node, service,
374 &ai_hints, &ai_list);
375 if (status != 0)
376 {
377 ERROR ("pinba plugin: getaddrinfo(3) failed: %s",
378 gai_strerror (status));
379 return (NULL);
380 }
381 assert (ai_list != NULL);
383 s = calloc (1, sizeof (*s));
384 if (s == NULL)
385 {
386 freeaddrinfo (ai_list);
387 ERROR ("pinba plugin: calloc failed.");
388 return (NULL);
389 }
391 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
392 {
393 status = pb_add_socket (s, ai_ptr);
394 if (status != 0)
395 break;
396 } /* for (ai_list) */
398 freeaddrinfo (ai_list);
400 if (s->fd_num < 1)
401 {
402 WARNING ("pinba plugin: Unable to open socket for address %s.", node);
403 sfree (s);
404 s = NULL;
405 }
407 return (s);
408 } /* }}} pinba_socket_open */
410 static void pinba_socket_free (pinba_socket_t *socket) /* {{{ */
411 {
412 nfds_t i;
414 if (!socket)
415 return;
417 for (i = 0; i < socket->fd_num; i++)
418 {
419 if (socket->fd[i].fd < 0)
420 continue;
421 close (socket->fd[i].fd);
422 socket->fd[i].fd = -1;
423 }
425 sfree(socket);
426 } /* }}} void pinba_socket_free */
428 static int pinba_process_stats_packet (const uint8_t *buffer, /* {{{ */
429 size_t buffer_size)
430 {
431 Pinba__Request *request;
433 request = pinba__request__unpack (NULL, buffer_size, buffer);
435 if (!request)
436 return (-1);
438 service_process_request(request);
439 pinba__request__free_unpacked (request, NULL);
441 return (0);
442 } /* }}} int pinba_process_stats_packet */
444 static int pinba_udp_read_callback_fn (int sock) /* {{{ */
445 {
446 uint8_t buffer[PINBA_UDP_BUFFER_SIZE];
447 size_t buffer_size;
448 int status;
450 while (42)
451 {
452 buffer_size = sizeof (buffer);
453 status = recvfrom (sock, buffer, buffer_size - 1, MSG_DONTWAIT, /* from = */ NULL, /* from len = */ 0);
454 if (status < 0)
455 {
456 char errbuf[1024];
458 if ((errno == EINTR)
459 #ifdef EWOULDBLOCK
460 || (errno == EWOULDBLOCK)
461 #endif
462 || (errno == EAGAIN))
463 {
464 continue;
465 }
467 WARNING("pinba plugin: recvfrom(2) failed: %s",
468 sstrerror (errno, errbuf, sizeof (errbuf)));
469 return (-1);
470 }
471 else if (status == 0)
472 {
473 DEBUG ("pinba plugin: recvfrom(2) returned unexpected status zero.");
474 return (-1);
475 }
476 else /* if (status > 0) */
477 {
478 assert (((size_t) status) < buffer_size);
479 buffer_size = (size_t) status;
480 buffer[buffer_size] = 0;
482 status = pinba_process_stats_packet (buffer, buffer_size);
483 if (status != 0)
484 DEBUG("pinba plugin: Parsing packet failed.");
485 return (status);
486 }
487 } /* while (42) */
489 /* not reached */
490 assert (23 == 42);
491 return (-1);
492 } /* }}} void pinba_udp_read_callback_fn */
494 static int receive_loop (void) /* {{{ */
495 {
496 pinba_socket_t *s;
498 s = pinba_socket_open (conf_node, conf_service);
499 if (s == NULL)
500 {
501 ERROR ("pinba plugin: Collector thread is exiting prematurely.");
502 return (-1);
503 }
505 while (!collector_thread_do_shutdown)
506 {
507 int status;
508 nfds_t i;
510 if (s->fd_num < 1)
511 break;
513 status = poll (s->fd, s->fd_num, /* timeout = */ 1000);
514 if (status == 0) /* timeout */
515 {
516 continue;
517 }
518 else if (status < 0)
519 {
520 char errbuf[1024];
522 if ((errno == EINTR) || (errno == EAGAIN))
523 continue;
525 ERROR ("pinba plugin: poll(2) failed: %s",
526 sstrerror (errno, errbuf, sizeof (errbuf)));
527 pinba_socket_free (s);
528 return (-1);
529 }
531 for (i = 0; i < s->fd_num; i++)
532 {
533 if (s->fd[i].revents & (POLLERR | POLLHUP | POLLNVAL))
534 {
535 pb_del_socket (s, i);
536 i--;
537 }
538 else if (s->fd[i].revents & (POLLIN | POLLPRI))
539 {
540 pinba_udp_read_callback_fn (s->fd[i].fd);
541 }
542 } /* for (s->fd) */
543 } /* while (!collector_thread_do_shutdown) */
545 pinba_socket_free (s);
546 s = NULL;
548 return (0);
549 } /* }}} int receive_loop */
551 static void *collector_thread (void *arg) /* {{{ */
552 {
553 receive_loop ();
555 memset (&collector_thread_id, 0, sizeof (collector_thread_id));
556 collector_thread_running = 0;
557 pthread_exit (NULL);
558 return (NULL);
559 } /* }}} void *collector_thread */
561 /*
562 * Plugin declaration section
563 */
564 static int pinba_config_view (const oconfig_item_t *ci) /* {{{ */
565 {
566 char *name = NULL;
567 char *host = NULL;
568 char *server = NULL;
569 char *script = NULL;
570 int status;
571 int i;
573 status = cf_util_get_string (ci, &name);
574 if (status != 0)
575 return (status);
577 for (i = 0; i < ci->children_num; i++)
578 {
579 oconfig_item_t *child = ci->children + i;
581 if (strcasecmp ("Host", child->key) == 0)
582 status = cf_util_get_string (child, &host);
583 else if (strcasecmp ("Server", child->key) == 0)
584 status = cf_util_get_string (child, &server);
585 else if (strcasecmp ("Script", child->key) == 0)
586 status = cf_util_get_string (child, &script);
587 else
588 {
589 WARNING ("pinba plugin: Unknown config option: %s", child->key);
590 status = -1;
591 }
593 if (status != 0)
594 break;
595 }
597 if (status == 0)
598 service_statnode_add (name, host, server, script);
600 sfree (name);
601 sfree (host);
602 sfree (server);
603 sfree (script);
605 return (status);
606 } /* }}} int pinba_config_view */
608 static int plugin_config (oconfig_item_t *ci) /* {{{ */
609 {
610 int i;
612 /* The lock should not be necessary in the config callback, but let's be
613 * sure.. */
614 pthread_mutex_lock (&stat_nodes_lock);
616 for (i = 0; i < ci->children_num; i++)
617 {
618 oconfig_item_t *child = ci->children + i;
620 if (strcasecmp ("Address", child->key) == 0)
621 cf_util_get_string (child, &conf_node);
622 else if (strcasecmp ("Port", child->key) == 0)
623 cf_util_get_service (child, &conf_service);
624 else if (strcasecmp ("View", child->key) == 0)
625 pinba_config_view (child);
626 else
627 WARNING ("pinba plugin: Unknown config option: %s", child->key);
628 }
630 pthread_mutex_unlock(&stat_nodes_lock);
632 return (0);
633 } /* }}} int pinba_config */
635 static int plugin_init (void) /* {{{ */
636 {
637 int status;
639 if (stat_nodes == NULL)
640 {
641 /* Collect the "total" data by default. */
642 service_statnode_add ("total",
643 /* host = */ NULL,
644 /* server = */ NULL,
645 /* script = */ NULL);
646 }
648 if (collector_thread_running)
649 return (0);
651 status = plugin_thread_create (&collector_thread_id,
652 /* attrs = */ NULL,
653 collector_thread,
654 /* args = */ NULL);
655 if (status != 0)
656 {
657 char errbuf[1024];
658 ERROR ("pinba plugin: pthread_create(3) failed: %s",
659 sstrerror (errno, errbuf, sizeof (errbuf)));
660 return (-1);
661 }
662 collector_thread_running = 1;
664 return (0);
665 } /* }}} */
667 static int plugin_shutdown (void) /* {{{ */
668 {
669 if (collector_thread_running)
670 {
671 int status;
673 DEBUG ("pinba plugin: Shutting down collector thread.");
674 collector_thread_do_shutdown = 1;
676 status = pthread_join (collector_thread_id, /* retval = */ NULL);
677 if (status != 0)
678 {
679 char errbuf[1024];
680 ERROR ("pinba plugin: pthread_join(3) failed: %s",
681 sstrerror (status, errbuf, sizeof (errbuf)));
682 }
684 collector_thread_running = 0;
685 collector_thread_do_shutdown = 0;
686 } /* if (collector_thread_running) */
688 return (0);
689 } /* }}} int plugin_shutdown */
691 static int plugin_submit (const pinba_statnode_t *res) /* {{{ */
692 {
693 value_t value;
694 value_list_t vl = VALUE_LIST_INIT;
696 vl.values = &value;
697 vl.values_len = 1;
698 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
699 sstrncpy (vl.plugin, "pinba", sizeof (vl.plugin));
700 sstrncpy (vl.plugin_instance, res->name, sizeof (vl.plugin_instance));
702 value.derive = res->req_count;
703 sstrncpy (vl.type, "total_requests", sizeof (vl.type));
704 plugin_dispatch_values (&vl);
706 value.derive = float_counter_get (&res->req_time, /* factor = */ 1000);
707 sstrncpy (vl.type, "total_time_in_ms", sizeof (vl.type));
708 plugin_dispatch_values (&vl);
710 value.derive = res->doc_size;
711 sstrncpy (vl.type, "total_bytes", sizeof (vl.type));
712 plugin_dispatch_values (&vl);
714 value.derive = float_counter_get (&res->ru_utime, /* factor = */ 100);
715 sstrncpy (vl.type, "cpu", sizeof (vl.type));
716 sstrncpy (vl.type_instance, "user", sizeof (vl.type_instance));
717 plugin_dispatch_values (&vl);
719 value.derive = float_counter_get (&res->ru_stime, /* factor = */ 100);
720 sstrncpy (vl.type, "cpu", sizeof (vl.type));
721 sstrncpy (vl.type_instance, "system", sizeof (vl.type_instance));
722 plugin_dispatch_values (&vl);
724 value.gauge = res->mem_peak;
725 sstrncpy (vl.type, "memory", sizeof (vl.type));
726 sstrncpy (vl.type_instance, "peak", sizeof (vl.type_instance));
727 plugin_dispatch_values (&vl);
729 return (0);
730 } /* }}} int plugin_submit */
732 static int plugin_read (void) /* {{{ */
733 {
734 unsigned int i=0;
735 pinba_statnode_t data;
737 while ((i = service_statnode_collect (&data, i)) != 0)
738 {
739 plugin_submit (&data);
740 }
742 return 0;
743 } /* }}} int plugin_read */
745 void module_register (void) /* {{{ */
746 {
747 plugin_register_complex_config ("pinba", plugin_config);
748 plugin_register_init ("pinba", plugin_init);
749 plugin_register_read ("pinba", plugin_read);
750 plugin_register_shutdown ("pinba", plugin_shutdown);
751 } /* }}} void module_register */
753 /* vim: set sw=2 sts=2 et fdm=marker : */