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
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.
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.
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
21 * Antony Dovgal <tony at daylessday.org>
22 * Phoenix Kayo <kayo.k11.4 at gmail.com>
23 * Florian Forster <octo at collectd.org>
29 #include "configfile.h"
34 #include "pinba.pb-c.h"
36 /* AIX doesn't have MSG_DONTWAIT */
38 # define MSG_DONTWAIT MSG_NONBLOCK
44 #ifndef PINBA_UDP_BUFFER_SIZE
45 # define PINBA_UDP_BUFFER_SIZE 65536
48 #ifndef PINBA_DEFAULT_NODE
49 # define PINBA_DEFAULT_NODE "::0"
52 #ifndef PINBA_DEFAULT_SERVICE
53 # define PINBA_DEFAULT_SERVICE "30002"
56 #ifndef PINBA_MAX_SOCKETS
57 # define PINBA_MAX_SOCKETS 16
61 * Private data structures
66 struct pollfd fd[PINBA_MAX_SOCKETS];
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
75 uint64_t n; /* nanos */
77 typedef struct float_counter_s float_counter_t;
79 struct pinba_statnode_s
81 /* collector name, used as plugin instance */
91 float_counter_t req_time;
92 float_counter_t ru_utime;
93 float_counter_t ru_stime;
98 typedef struct pinba_statnode_s pinba_statnode_t;
102 * Module global variables
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;
120 static void float_counter_add (float_counter_t *fc, float val) /* {{{ */
127 tmp = (uint64_t) val;
131 fc->n += (uint64_t) ((val * 1000000000.0) + .5);
133 if (fc->n >= 1000000000)
137 assert (fc->n < 1000000000);
139 } /* }}} void float_counter_add */
141 static derive_t float_counter_get (const float_counter_t *fc, /* {{{ */
146 ret = (derive_t) (fc->i * factor);
147 ret += (derive_t) (fc->n / (1000000000 / factor));
150 } /* }}} derive_t float_counter_get */
152 static void strset (char **str, const char *new) /* {{{ */
165 } /* }}} void strset */
167 static void service_statnode_add(const char *name, /* {{{ */
172 pinba_statnode_t *node;
174 node = realloc (stat_nodes,
175 sizeof (*stat_nodes) * (stat_nodes_num + 1));
178 ERROR ("pinba plugin: realloc failed");
183 node = stat_nodes + stat_nodes_num;
184 memset (node, 0, sizeof (*node));
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 */
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, /* {{{ */
210 pinba_statnode_t *node;
212 if (stat_nodes_num == 0)
215 /* begin collecting */
217 pthread_mutex_lock (&stat_nodes_lock);
220 if (index >= stat_nodes_num)
222 pthread_mutex_unlock (&stat_nodes_lock);
226 node = stat_nodes + index;
227 memcpy (res, node, sizeof (*res));
230 node->mem_peak = NAN;
233 } /* }}} unsigned int service_statnode_collect */
235 static void service_statnode_process (pinba_statnode_t *node, /* {{{ */
236 Pinba__Request* request)
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) /* {{{ */
256 pthread_mutex_lock (&stat_nodes_lock);
258 for (i = 0; i < stat_nodes_num; i++)
260 if ((stat_nodes[i].host != NULL)
261 && (strcmp (request->hostname, stat_nodes[i].host) != 0))
264 if ((stat_nodes[i].server != NULL)
265 && (strcmp (request->server_name, stat_nodes[i].server) != 0))
268 if ((stat_nodes[i].script != NULL)
269 && (strcmp (request->script_name, stat_nodes[i].script) != 0))
272 service_statnode_process(&stat_nodes[i], request);
275 pthread_mutex_unlock(&stat_nodes_lock);
276 } /* }}} void service_process_request */
278 static int pb_del_socket (pinba_socket_t *s, /* {{{ */
281 if (index >= s->fd_num)
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))
290 memmove (&s->fd[index], &s->fd[index + 1],
291 sizeof (s->fd[0]) * (s->fd_num - (index + 1)));
296 } /* }}} int pb_del_socket */
298 static int pb_add_socket (pinba_socket_t *s, /* {{{ */
299 const struct addrinfo *ai)
305 if (s->fd_num == PINBA_MAX_SOCKETS)
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);
313 fd = socket (ai->ai_family, ai->ai_socktype, ai->ai_protocol);
317 ERROR ("pinba plugin: socket(2) failed: %s",
318 sstrerror (errno, errbuf, sizeof (errbuf)));
323 status = setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &tmp, sizeof (tmp));
327 WARNING ("pinba plugin: setsockopt(SO_REUSEADDR) failed: %s",
328 sstrerror (errno, errbuf, sizeof (errbuf)));
331 status = bind (fd, ai->ai_addr, ai->ai_addrlen);
335 ERROR ("pinba plugin: bind(2) failed: %s",
336 sstrerror (errno, errbuf, sizeof (errbuf)));
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;
347 } /* }}} int pb_add_socket */
349 static pinba_socket_t *pinba_socket_open (const char *node, /* {{{ */
353 struct addrinfo *ai_list;
354 struct addrinfo *ai_ptr;
358 node = PINBA_DEFAULT_NODE;
361 service = PINBA_DEFAULT_SERVICE;
363 struct addrinfo ai_hints = {
364 .ai_family = AF_UNSPEC,
365 .ai_flags = AI_PASSIVE,
366 .ai_socktype = SOCK_DGRAM
369 status = getaddrinfo (node, service,
370 &ai_hints, &ai_list);
373 ERROR ("pinba plugin: getaddrinfo(3) failed: %s",
374 gai_strerror (status));
377 assert (ai_list != NULL);
379 s = calloc (1, sizeof (*s));
382 freeaddrinfo (ai_list);
383 ERROR ("pinba plugin: calloc failed.");
387 for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
389 status = pb_add_socket (s, ai_ptr);
392 } /* for (ai_list) */
394 freeaddrinfo (ai_list);
398 WARNING ("pinba plugin: Unable to open socket for address %s.", node);
404 } /* }}} pinba_socket_open */
406 static void pinba_socket_free (pinba_socket_t *socket) /* {{{ */
413 for (i = 0; i < socket->fd_num; i++)
415 if (socket->fd[i].fd < 0)
417 close (socket->fd[i].fd);
418 socket->fd[i].fd = -1;
422 } /* }}} void pinba_socket_free */
424 static int pinba_process_stats_packet (const uint8_t *buffer, /* {{{ */
427 Pinba__Request *request;
429 request = pinba__request__unpack (NULL, buffer_size, buffer);
434 service_process_request(request);
435 pinba__request__free_unpacked (request, NULL);
438 } /* }}} int pinba_process_stats_packet */
440 static int pinba_udp_read_callback_fn (int sock) /* {{{ */
442 uint8_t buffer[PINBA_UDP_BUFFER_SIZE];
448 buffer_size = sizeof (buffer);
449 status = recvfrom (sock, buffer, buffer_size - 1, MSG_DONTWAIT, /* from = */ NULL, /* from len = */ 0);
456 || (errno == EWOULDBLOCK)
458 || (errno == EAGAIN))
463 WARNING("pinba plugin: recvfrom(2) failed: %s",
464 sstrerror (errno, errbuf, sizeof (errbuf)));
467 else if (status == 0)
469 DEBUG ("pinba plugin: recvfrom(2) returned unexpected status zero.");
472 else /* if (status > 0) */
474 assert (((size_t) status) < buffer_size);
475 buffer_size = (size_t) status;
476 buffer[buffer_size] = 0;
478 status = pinba_process_stats_packet (buffer, buffer_size);
480 DEBUG("pinba plugin: Parsing packet failed.");
488 } /* }}} void pinba_udp_read_callback_fn */
490 static int receive_loop (void) /* {{{ */
494 s = pinba_socket_open (conf_node, conf_service);
497 ERROR ("pinba plugin: Collector thread is exiting prematurely.");
501 while (!collector_thread_do_shutdown)
509 status = poll (s->fd, s->fd_num, /* timeout = */ 1000);
510 if (status == 0) /* timeout */
518 if ((errno == EINTR) || (errno == EAGAIN))
521 ERROR ("pinba plugin: poll(2) failed: %s",
522 sstrerror (errno, errbuf, sizeof (errbuf)));
523 pinba_socket_free (s);
527 for (i = 0; i < s->fd_num; i++)
529 if (s->fd[i].revents & (POLLERR | POLLHUP | POLLNVAL))
531 pb_del_socket (s, i);
534 else if (s->fd[i].revents & (POLLIN | POLLPRI))
536 pinba_udp_read_callback_fn (s->fd[i].fd);
539 } /* while (!collector_thread_do_shutdown) */
541 pinba_socket_free (s);
545 } /* }}} int receive_loop */
547 static void *collector_thread (void *arg) /* {{{ */
551 memset (&collector_thread_id, 0, sizeof (collector_thread_id));
552 collector_thread_running = 0;
555 } /* }}} void *collector_thread */
558 * Plugin declaration section
560 static int pinba_config_view (const oconfig_item_t *ci) /* {{{ */
569 status = cf_util_get_string (ci, &name);
573 for (i = 0; i < ci->children_num; i++)
575 oconfig_item_t *child = ci->children + i;
577 if (strcasecmp ("Host", child->key) == 0)
578 status = cf_util_get_string (child, &host);
579 else if (strcasecmp ("Server", child->key) == 0)
580 status = cf_util_get_string (child, &server);
581 else if (strcasecmp ("Script", child->key) == 0)
582 status = cf_util_get_string (child, &script);
585 WARNING ("pinba plugin: Unknown config option: %s", child->key);
594 service_statnode_add (name, host, server, script);
602 } /* }}} int pinba_config_view */
604 static int plugin_config (oconfig_item_t *ci) /* {{{ */
608 /* The lock should not be necessary in the config callback, but let's be
610 pthread_mutex_lock (&stat_nodes_lock);
612 for (i = 0; i < ci->children_num; i++)
614 oconfig_item_t *child = ci->children + i;
616 if (strcasecmp ("Address", child->key) == 0)
617 cf_util_get_string (child, &conf_node);
618 else if (strcasecmp ("Port", child->key) == 0)
619 cf_util_get_service (child, &conf_service);
620 else if (strcasecmp ("View", child->key) == 0)
621 pinba_config_view (child);
623 WARNING ("pinba plugin: Unknown config option: %s", child->key);
626 pthread_mutex_unlock(&stat_nodes_lock);
629 } /* }}} int pinba_config */
631 static int plugin_init (void) /* {{{ */
635 if (stat_nodes == NULL)
637 /* Collect the "total" data by default. */
638 service_statnode_add ("total",
641 /* script = */ NULL);
644 if (collector_thread_running)
647 status = plugin_thread_create (&collector_thread_id,
654 ERROR ("pinba plugin: pthread_create(3) failed: %s",
655 sstrerror (errno, errbuf, sizeof (errbuf)));
658 collector_thread_running = 1;
663 static int plugin_shutdown (void) /* {{{ */
665 if (collector_thread_running)
669 DEBUG ("pinba plugin: Shutting down collector thread.");
670 collector_thread_do_shutdown = 1;
672 status = pthread_join (collector_thread_id, /* retval = */ NULL);
676 ERROR ("pinba plugin: pthread_join(3) failed: %s",
677 sstrerror (status, errbuf, sizeof (errbuf)));
680 collector_thread_running = 0;
681 collector_thread_do_shutdown = 0;
682 } /* if (collector_thread_running) */
685 } /* }}} int plugin_shutdown */
687 static int plugin_submit (const pinba_statnode_t *res) /* {{{ */
690 value_list_t vl = VALUE_LIST_INIT;
694 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
695 sstrncpy (vl.plugin, "pinba", sizeof (vl.plugin));
696 sstrncpy (vl.plugin_instance, res->name, sizeof (vl.plugin_instance));
698 value.derive = res->req_count;
699 sstrncpy (vl.type, "total_requests", sizeof (vl.type));
700 plugin_dispatch_values (&vl);
702 value.derive = float_counter_get (&res->req_time, /* factor = */ 1000);
703 sstrncpy (vl.type, "total_time_in_ms", sizeof (vl.type));
704 plugin_dispatch_values (&vl);
706 value.derive = res->doc_size;
707 sstrncpy (vl.type, "total_bytes", sizeof (vl.type));
708 plugin_dispatch_values (&vl);
710 value.derive = float_counter_get (&res->ru_utime, /* factor = */ 100);
711 sstrncpy (vl.type, "cpu", sizeof (vl.type));
712 sstrncpy (vl.type_instance, "user", sizeof (vl.type_instance));
713 plugin_dispatch_values (&vl);
715 value.derive = float_counter_get (&res->ru_stime, /* factor = */ 100);
716 sstrncpy (vl.type, "cpu", sizeof (vl.type));
717 sstrncpy (vl.type_instance, "system", sizeof (vl.type_instance));
718 plugin_dispatch_values (&vl);
720 value.gauge = res->mem_peak;
721 sstrncpy (vl.type, "memory", sizeof (vl.type));
722 sstrncpy (vl.type_instance, "peak", sizeof (vl.type_instance));
723 plugin_dispatch_values (&vl);
726 } /* }}} int plugin_submit */
728 static int plugin_read (void) /* {{{ */
731 pinba_statnode_t data;
733 while ((i = service_statnode_collect (&data, i)) != 0)
735 plugin_submit (&data);
739 } /* }}} int plugin_read */
741 void module_register (void) /* {{{ */
743 plugin_register_complex_config ("pinba", plugin_config);
744 plugin_register_init ("pinba", plugin_init);
745 plugin_register_read ("pinba", plugin_read);
746 plugin_register_shutdown ("pinba", plugin_shutdown);
747 } /* }}} void module_register */
749 /* vim: set sw=2 sts=2 et fdm=marker : */