Merge pull request #1821 from rubenk/memset
[collectd.git] / src / pinba.c
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  **/
25
26 #include "collectd.h"
27 #include "common.h"
28 #include "plugin.h"
29 #include "configfile.h"
30
31 #include <netdb.h>
32 #include <poll.h>
33
34 #include "pinba.pb-c.h"
35
36 /* AIX doesn't have MSG_DONTWAIT */
37 #ifndef MSG_DONTWAIT
38 #  define MSG_DONTWAIT MSG_NONBLOCK
39 #endif
40
41 /*
42  * Defines
43  */
44 #ifndef PINBA_UDP_BUFFER_SIZE
45 # define PINBA_UDP_BUFFER_SIZE 65536
46 #endif
47
48 #ifndef PINBA_DEFAULT_NODE
49 # define PINBA_DEFAULT_NODE "::0"
50 #endif
51
52 #ifndef PINBA_DEFAULT_SERVICE
53 # define PINBA_DEFAULT_SERVICE "30002"
54 #endif
55
56 #ifndef PINBA_MAX_SOCKETS
57 # define PINBA_MAX_SOCKETS 16
58 #endif
59
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;
70
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;
78
79 struct pinba_statnode_s
80 {
81   /* collector name, used as plugin instance */
82   char *name;
83
84   /* query data */
85   char *host;
86   char *server;
87   char *script;
88
89   derive_t req_count;
90
91   float_counter_t req_time;
92   float_counter_t ru_utime;
93   float_counter_t ru_stime;
94
95   derive_t doc_size;
96   gauge_t mem_peak;
97 };
98 typedef struct pinba_statnode_s pinba_statnode_t;
99 /* }}} */
100
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;
108
109 static char *conf_node = NULL;
110 static char *conf_service = NULL;
111
112 static _Bool collector_thread_running = 0;
113 static _Bool collector_thread_do_shutdown = 0;
114 static pthread_t collector_thread_id;
115 /* }}} */
116
117 /*
118  * Functions
119  */
120 static void float_counter_add (float_counter_t *fc, float val) /* {{{ */
121 {
122   uint64_t tmp;
123
124   if (val < 0.0)
125     return;
126
127   tmp = (uint64_t) val;
128   val -= (double) tmp;
129
130   fc->i += tmp;
131   fc->n += (uint64_t) ((val * 1000000000.0) + .5);
132
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 */
140
141 static derive_t float_counter_get (const float_counter_t *fc, /* {{{ */
142     uint64_t factor)
143 {
144   derive_t ret;
145
146   ret = (derive_t) (fc->i * factor);
147   ret += (derive_t) (fc->n / (1000000000 / factor));
148
149   return (ret);
150 } /* }}} derive_t float_counter_get */
151
152 static void strset (char **str, const char *new) /* {{{ */
153 {
154   char *tmp;
155
156   if (!str || !new)
157     return;
158
159   tmp = strdup (new);
160   if (tmp == NULL)
161     return;
162
163   sfree (*str);
164   *str = tmp;
165 } /* }}} void strset */
166
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;
173
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;
182
183   node = stat_nodes + stat_nodes_num;
184   memset (node, 0, sizeof (*node));
185
186   /* reset strings */
187   node->name   = NULL;
188   node->host   = NULL;
189   node->server = NULL;
190   node->script = NULL;
191
192   node->mem_peak = NAN;
193
194   /* fill query data */
195   strset (&node->name, name);
196   strset (&node->host, host);
197   strset (&node->server, server);
198   strset (&node->script, script);
199
200   /* increment counter */
201   stat_nodes_num++;
202 } /* }}} void service_statnode_add */
203
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;
211
212   if (stat_nodes_num == 0)
213     return 0;
214
215   /* begin collecting */
216   if (index == 0)
217     pthread_mutex_lock (&stat_nodes_lock);
218
219   /* end collecting */
220   if (index >= stat_nodes_num)
221   {
222     pthread_mutex_unlock (&stat_nodes_lock);
223     return 0;
224   }
225
226   node = stat_nodes + index;
227   memcpy (res, node, sizeof (*res));
228
229   /* reset node */
230   node->mem_peak = NAN;
231
232   return (index + 1);
233 } /* }}} unsigned int service_statnode_collect */
234
235 static void service_statnode_process (pinba_statnode_t *node, /* {{{ */
236     Pinba__Request* request)
237 {
238   node->req_count++;
239
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);
243
244   node->doc_size += request->document_size;
245
246   if (isnan (node->mem_peak)
247       || (node->mem_peak < ((gauge_t) request->memory_peak)))
248     node->mem_peak = (gauge_t) request->memory_peak;
249
250 } /* }}} void service_statnode_process */
251
252 static void service_process_request (Pinba__Request *request) /* {{{ */
253 {
254   unsigned int i;
255
256   pthread_mutex_lock (&stat_nodes_lock);
257
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;
263
264     if ((stat_nodes[i].server != NULL)
265       && (strcmp (request->server_name, stat_nodes[i].server) != 0))
266       continue;
267
268     if ((stat_nodes[i].script != NULL)
269       && (strcmp (request->script_name, stat_nodes[i].script) != 0))
270       continue;
271
272     service_statnode_process(&stat_nodes[i], request);
273   }
274
275   pthread_mutex_unlock(&stat_nodes_lock);
276 } /* }}} void service_process_request */
277
278 static int pb_del_socket (pinba_socket_t *s, /* {{{ */
279     nfds_t index)
280 {
281   if (index >= s->fd_num)
282     return (EINVAL);
283
284   close (s->fd[index].fd);
285   s->fd[index].fd = -1;
286
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   }
293
294   s->fd_num--;
295   return (0);
296 } /* }}} int pb_del_socket */
297
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;
304
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   }
312
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   }
321
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   }
330
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   }
340
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++;
345
346   return (0);
347 } /* }}} int pb_add_socket */
348
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 = { 0 };
356   int status;
357
358   ai_hints.ai_flags = AI_PASSIVE;
359   ai_hints.ai_family = AF_UNSPEC;
360   ai_hints.ai_socktype = SOCK_DGRAM;
361   ai_hints.ai_addr = NULL;
362   ai_hints.ai_canonname = NULL;
363   ai_hints.ai_next = NULL;
364
365   if (node == NULL)
366     node = PINBA_DEFAULT_NODE;
367
368   if (service == NULL)
369     service = PINBA_DEFAULT_SERVICE;
370
371   ai_list = NULL;
372   status = getaddrinfo (node, service,
373       &ai_hints, &ai_list);
374   if (status != 0)
375   {
376     ERROR ("pinba plugin: getaddrinfo(3) failed: %s",
377         gai_strerror (status));
378     return (NULL);
379   }
380   assert (ai_list != NULL);
381
382   s = calloc (1, sizeof (*s));
383   if (s == NULL)
384   {
385     freeaddrinfo (ai_list);
386     ERROR ("pinba plugin: calloc failed.");
387     return (NULL);
388   }
389
390   for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
391   {
392     status = pb_add_socket (s, ai_ptr);
393     if (status != 0)
394       break;
395   } /* for (ai_list) */
396
397   freeaddrinfo (ai_list);
398
399   if (s->fd_num < 1)
400   {
401     WARNING ("pinba plugin: Unable to open socket for address %s.", node);
402     sfree (s);
403     s = NULL;
404   }
405
406   return (s);
407 } /* }}} pinba_socket_open */
408
409 static void pinba_socket_free (pinba_socket_t *socket) /* {{{ */
410 {
411   nfds_t i;
412
413   if (!socket)
414     return;
415
416   for (i = 0; i < socket->fd_num; i++)
417   {
418     if (socket->fd[i].fd < 0)
419       continue;
420     close (socket->fd[i].fd);
421     socket->fd[i].fd = -1;
422   }
423
424   sfree(socket);
425 } /* }}} void pinba_socket_free */
426
427 static int pinba_process_stats_packet (const uint8_t *buffer, /* {{{ */
428     size_t buffer_size)
429 {
430   Pinba__Request *request;
431
432   request = pinba__request__unpack (NULL, buffer_size, buffer);
433
434   if (!request)
435     return (-1);
436
437   service_process_request(request);
438   pinba__request__free_unpacked (request, NULL);
439
440   return (0);
441 } /* }}} int pinba_process_stats_packet */
442
443 static int pinba_udp_read_callback_fn (int sock) /* {{{ */
444 {
445   uint8_t buffer[PINBA_UDP_BUFFER_SIZE];
446   size_t buffer_size;
447   int status;
448
449   while (42)
450   {
451     buffer_size = sizeof (buffer);
452     status = recvfrom (sock, buffer, buffer_size - 1, MSG_DONTWAIT, /* from = */ NULL, /* from len = */ 0);
453     if (status < 0)
454     {
455       char errbuf[1024];
456
457       if ((errno == EINTR)
458 #ifdef EWOULDBLOCK
459           || (errno == EWOULDBLOCK)
460 #endif
461           || (errno == EAGAIN))
462       {
463         continue;
464       }
465
466       WARNING("pinba plugin: recvfrom(2) failed: %s",
467           sstrerror (errno, errbuf, sizeof (errbuf)));
468       return (-1);
469     }
470     else if (status == 0)
471     {
472       DEBUG ("pinba plugin: recvfrom(2) returned unexpected status zero.");
473       return (-1);
474     }
475     else /* if (status > 0) */
476     {
477       assert (((size_t) status) < buffer_size);
478       buffer_size = (size_t) status;
479       buffer[buffer_size] = 0;
480
481       status = pinba_process_stats_packet (buffer, buffer_size);
482       if (status != 0)
483         DEBUG("pinba plugin: Parsing packet failed.");
484       return (status);
485     }
486   } /* while (42) */
487
488   /* not reached */
489   assert (23 == 42);
490   return (-1);
491 } /* }}} void pinba_udp_read_callback_fn */
492
493 static int receive_loop (void) /* {{{ */
494 {
495   pinba_socket_t *s;
496
497   s = pinba_socket_open (conf_node, conf_service);
498   if (s == NULL)
499   {
500     ERROR ("pinba plugin: Collector thread is exiting prematurely.");
501     return (-1);
502   }
503
504   while (!collector_thread_do_shutdown)
505   {
506     int status;
507     nfds_t i;
508
509     if (s->fd_num < 1)
510       break;
511
512     status = poll (s->fd, s->fd_num, /* timeout = */ 1000);
513     if (status == 0) /* timeout */
514     {
515       continue;
516     }
517     else if (status < 0)
518     {
519       char errbuf[1024];
520
521       if ((errno == EINTR) || (errno == EAGAIN))
522         continue;
523
524       ERROR ("pinba plugin: poll(2) failed: %s",
525           sstrerror (errno, errbuf, sizeof (errbuf)));
526       pinba_socket_free (s);
527       return (-1);
528     }
529
530     for (i = 0; i < s->fd_num; i++)
531     {
532       if (s->fd[i].revents & (POLLERR | POLLHUP | POLLNVAL))
533       {
534         pb_del_socket (s, i);
535         i--;
536       }
537       else if (s->fd[i].revents & (POLLIN | POLLPRI))
538       {
539         pinba_udp_read_callback_fn (s->fd[i].fd);
540       }
541     } /* for (s->fd) */
542   } /* while (!collector_thread_do_shutdown) */
543
544   pinba_socket_free (s);
545   s = NULL;
546
547   return (0);
548 } /* }}} int receive_loop */
549
550 static void *collector_thread (void *arg) /* {{{ */
551 {
552   receive_loop ();
553
554   memset (&collector_thread_id, 0, sizeof (collector_thread_id));
555   collector_thread_running = 0;
556   pthread_exit (NULL);
557   return (NULL);
558 } /* }}} void *collector_thread */
559
560 /*
561  * Plugin declaration section
562  */
563 static int pinba_config_view (const oconfig_item_t *ci) /* {{{ */
564 {
565   char *name   = NULL;
566   char *host   = NULL;
567   char *server = NULL;
568   char *script = NULL;
569   int status;
570   int i;
571
572   status = cf_util_get_string (ci, &name);
573   if (status != 0)
574     return (status);
575
576   for (i = 0; i < ci->children_num; i++)
577   {
578     oconfig_item_t *child = ci->children + i;
579
580     if (strcasecmp ("Host", child->key) == 0)
581       status = cf_util_get_string (child, &host);
582     else if (strcasecmp ("Server", child->key) == 0)
583       status = cf_util_get_string (child, &server);
584     else if (strcasecmp ("Script", child->key) == 0)
585       status = cf_util_get_string (child, &script);
586     else
587     {
588       WARNING ("pinba plugin: Unknown config option: %s", child->key);
589       status = -1;
590     }
591
592     if (status != 0)
593       break;
594   }
595
596   if (status == 0)
597     service_statnode_add (name, host, server, script);
598
599   sfree (name);
600   sfree (host);
601   sfree (server);
602   sfree (script);
603
604   return (status);
605 } /* }}} int pinba_config_view */
606
607 static int plugin_config (oconfig_item_t *ci) /* {{{ */
608 {
609   int i;
610
611   /* The lock should not be necessary in the config callback, but let's be
612    * sure.. */
613   pthread_mutex_lock (&stat_nodes_lock);
614
615   for (i = 0; i < ci->children_num; i++)
616   {
617     oconfig_item_t *child = ci->children + i;
618
619     if (strcasecmp ("Address", child->key) == 0)
620       cf_util_get_string (child, &conf_node);
621     else if (strcasecmp ("Port", child->key) == 0)
622       cf_util_get_service (child, &conf_service);
623     else if (strcasecmp ("View", child->key) == 0)
624       pinba_config_view (child);
625     else
626       WARNING ("pinba plugin: Unknown config option: %s", child->key);
627   }
628
629   pthread_mutex_unlock(&stat_nodes_lock);
630
631   return (0);
632 } /* }}} int pinba_config */
633
634 static int plugin_init (void) /* {{{ */
635 {
636   int status;
637
638   if (stat_nodes == NULL)
639   {
640     /* Collect the "total" data by default. */
641     service_statnode_add ("total",
642         /* host   = */ NULL,
643         /* server = */ NULL,
644         /* script = */ NULL);
645   }
646
647   if (collector_thread_running)
648     return (0);
649
650   status = plugin_thread_create (&collector_thread_id,
651       /* attrs = */ NULL,
652       collector_thread,
653       /* args = */ NULL);
654   if (status != 0)
655   {
656     char errbuf[1024];
657     ERROR ("pinba plugin: pthread_create(3) failed: %s",
658         sstrerror (errno, errbuf, sizeof (errbuf)));
659     return (-1);
660   }
661   collector_thread_running = 1;
662
663   return (0);
664 } /* }}} */
665
666 static int plugin_shutdown (void) /* {{{ */
667 {
668   if (collector_thread_running)
669   {
670     int status;
671
672     DEBUG ("pinba plugin: Shutting down collector thread.");
673     collector_thread_do_shutdown = 1;
674
675     status = pthread_join (collector_thread_id, /* retval = */ NULL);
676     if (status != 0)
677     {
678       char errbuf[1024];
679       ERROR ("pinba plugin: pthread_join(3) failed: %s",
680           sstrerror (status, errbuf, sizeof (errbuf)));
681     }
682
683     collector_thread_running = 0;
684     collector_thread_do_shutdown = 0;
685   } /* if (collector_thread_running) */
686
687   return (0);
688 } /* }}} int plugin_shutdown */
689
690 static int plugin_submit (const pinba_statnode_t *res) /* {{{ */
691 {
692   value_t value;
693   value_list_t vl = VALUE_LIST_INIT;
694
695   vl.values = &value;
696   vl.values_len = 1;
697   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
698   sstrncpy (vl.plugin, "pinba", sizeof (vl.plugin));
699   sstrncpy (vl.plugin_instance, res->name, sizeof (vl.plugin_instance));
700
701   value.derive = res->req_count;
702   sstrncpy (vl.type, "total_requests", sizeof (vl.type));
703   plugin_dispatch_values (&vl);
704
705   value.derive = float_counter_get (&res->req_time, /* factor = */ 1000);
706   sstrncpy (vl.type, "total_time_in_ms", sizeof (vl.type));
707   plugin_dispatch_values (&vl);
708
709   value.derive = res->doc_size;
710   sstrncpy (vl.type, "total_bytes", sizeof (vl.type));
711   plugin_dispatch_values (&vl);
712
713   value.derive = float_counter_get (&res->ru_utime, /* factor = */ 100);
714   sstrncpy (vl.type, "cpu", sizeof (vl.type));
715   sstrncpy (vl.type_instance, "user", sizeof (vl.type_instance));
716   plugin_dispatch_values (&vl);
717
718   value.derive = float_counter_get (&res->ru_stime, /* factor = */ 100);
719   sstrncpy (vl.type, "cpu", sizeof (vl.type));
720   sstrncpy (vl.type_instance, "system", sizeof (vl.type_instance));
721   plugin_dispatch_values (&vl);
722
723   value.gauge = res->mem_peak;
724   sstrncpy (vl.type, "memory", sizeof (vl.type));
725   sstrncpy (vl.type_instance, "peak", sizeof (vl.type_instance));
726   plugin_dispatch_values (&vl);
727
728   return (0);
729 } /* }}} int plugin_submit */
730
731 static int plugin_read (void) /* {{{ */
732 {
733   unsigned int i=0;
734   pinba_statnode_t data;
735
736   while ((i = service_statnode_collect (&data, i)) != 0)
737   {
738     plugin_submit (&data);
739   }
740
741   return 0;
742 } /* }}} int plugin_read */
743
744 void module_register (void) /* {{{ */
745 {
746   plugin_register_complex_config ("pinba", plugin_config);
747   plugin_register_init ("pinba", plugin_init);
748   plugin_register_read ("pinba", plugin_read);
749   plugin_register_shutdown ("pinba", plugin_shutdown);
750 } /* }}} void module_register */
751
752 /* vim: set sw=2 sts=2 et fdm=marker : */