Merge pull request #1899 from rubenk/python-fixes-for-interactive-sessions
[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
28 #include "common.h"
29 #include "plugin.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   pthread_mutex_lock (&stat_nodes_lock);
255
256   for (unsigned int i = 0; i < stat_nodes_num; i++)
257   {
258     if ((stat_nodes[i].host != NULL)
259         && (strcmp (request->hostname, stat_nodes[i].host) != 0))
260       continue;
261
262     if ((stat_nodes[i].server != NULL)
263       && (strcmp (request->server_name, stat_nodes[i].server) != 0))
264       continue;
265
266     if ((stat_nodes[i].script != NULL)
267       && (strcmp (request->script_name, stat_nodes[i].script) != 0))
268       continue;
269
270     service_statnode_process(&stat_nodes[i], request);
271   }
272
273   pthread_mutex_unlock(&stat_nodes_lock);
274 } /* }}} void service_process_request */
275
276 static int pb_del_socket (pinba_socket_t *s, /* {{{ */
277     nfds_t index)
278 {
279   if (index >= s->fd_num)
280     return (EINVAL);
281
282   close (s->fd[index].fd);
283   s->fd[index].fd = -1;
284
285   /* When deleting the last element in the list, no memmove is necessary. */
286   if (index < (s->fd_num - 1))
287   {
288     memmove (&s->fd[index], &s->fd[index + 1],
289         sizeof (s->fd[0]) * (s->fd_num - (index + 1)));
290   }
291
292   s->fd_num--;
293   return (0);
294 } /* }}} int pb_del_socket */
295
296 static int pb_add_socket (pinba_socket_t *s, /* {{{ */
297     const struct addrinfo *ai)
298 {
299   int fd;
300   int tmp;
301   int status;
302
303   if (s->fd_num == PINBA_MAX_SOCKETS)
304   {
305     WARNING ("pinba plugin: Sorry, you have hit the built-in limit of "
306         "%i sockets. Please complain to the collectd developers so we can "
307         "raise the limit.", PINBA_MAX_SOCKETS);
308     return (-1);
309   }
310
311   fd = socket (ai->ai_family, ai->ai_socktype, ai->ai_protocol);
312   if (fd < 0)
313   {
314     char errbuf[1024];
315     ERROR ("pinba plugin: socket(2) failed: %s",
316         sstrerror (errno, errbuf, sizeof (errbuf)));
317     return (0);
318   }
319
320   tmp = 1;
321   status = setsockopt (fd, SOL_SOCKET, SO_REUSEADDR, &tmp, sizeof (tmp));
322   if (status != 0)
323   {
324     char errbuf[1024];
325     WARNING ("pinba plugin: setsockopt(SO_REUSEADDR) failed: %s",
326         sstrerror (errno, errbuf, sizeof (errbuf)));
327   }
328
329   status = bind (fd, ai->ai_addr, ai->ai_addrlen);
330   if (status != 0)
331   {
332     char errbuf[1024];
333     ERROR ("pinba plugin: bind(2) failed: %s",
334         sstrerror (errno, errbuf, sizeof (errbuf)));
335     close (fd);
336     return (0);
337   }
338
339   s->fd[s->fd_num].fd = fd;
340   s->fd[s->fd_num].events = POLLIN | POLLPRI;
341   s->fd[s->fd_num].revents = 0;
342   s->fd_num++;
343
344   return (0);
345 } /* }}} int pb_add_socket */
346
347 static pinba_socket_t *pinba_socket_open (const char *node, /* {{{ */
348     const char *service)
349 {
350   pinba_socket_t *s;
351   struct addrinfo *ai_list;
352   int status;
353
354   if (node == NULL)
355     node = PINBA_DEFAULT_NODE;
356
357   if (service == NULL)
358     service = PINBA_DEFAULT_SERVICE;
359
360   struct addrinfo  ai_hints = {
361     .ai_family = AF_UNSPEC,
362     .ai_flags = AI_PASSIVE,
363     .ai_socktype = SOCK_DGRAM
364   };
365
366   status = getaddrinfo (node, service,
367       &ai_hints, &ai_list);
368   if (status != 0)
369   {
370     ERROR ("pinba plugin: getaddrinfo(3) failed: %s",
371         gai_strerror (status));
372     return (NULL);
373   }
374   assert (ai_list != NULL);
375
376   s = calloc (1, sizeof (*s));
377   if (s == NULL)
378   {
379     freeaddrinfo (ai_list);
380     ERROR ("pinba plugin: calloc failed.");
381     return (NULL);
382   }
383
384   for (struct addrinfo *ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next)
385   {
386     status = pb_add_socket (s, ai_ptr);
387     if (status != 0)
388       break;
389   } /* for (ai_list) */
390
391   freeaddrinfo (ai_list);
392
393   if (s->fd_num < 1)
394   {
395     WARNING ("pinba plugin: Unable to open socket for address %s.", node);
396     sfree (s);
397     s = NULL;
398   }
399
400   return (s);
401 } /* }}} pinba_socket_open */
402
403 static void pinba_socket_free (pinba_socket_t *socket) /* {{{ */
404 {
405   if (!socket)
406     return;
407
408   for (nfds_t i = 0; i < socket->fd_num; i++)
409   {
410     if (socket->fd[i].fd < 0)
411       continue;
412     close (socket->fd[i].fd);
413     socket->fd[i].fd = -1;
414   }
415
416   sfree(socket);
417 } /* }}} void pinba_socket_free */
418
419 static int pinba_process_stats_packet (const uint8_t *buffer, /* {{{ */
420     size_t buffer_size)
421 {
422   Pinba__Request *request;
423
424   request = pinba__request__unpack (NULL, buffer_size, buffer);
425
426   if (!request)
427     return (-1);
428
429   service_process_request(request);
430   pinba__request__free_unpacked (request, NULL);
431
432   return (0);
433 } /* }}} int pinba_process_stats_packet */
434
435 static int pinba_udp_read_callback_fn (int sock) /* {{{ */
436 {
437   uint8_t buffer[PINBA_UDP_BUFFER_SIZE];
438   size_t buffer_size;
439   int status;
440
441   while (42)
442   {
443     buffer_size = sizeof (buffer);
444     status = recvfrom (sock, buffer, buffer_size - 1, MSG_DONTWAIT, /* from = */ NULL, /* from len = */ 0);
445     if (status < 0)
446     {
447       char errbuf[1024];
448
449       if ((errno == EINTR)
450 #ifdef EWOULDBLOCK
451           || (errno == EWOULDBLOCK)
452 #endif
453           || (errno == EAGAIN))
454       {
455         continue;
456       }
457
458       WARNING("pinba plugin: recvfrom(2) failed: %s",
459           sstrerror (errno, errbuf, sizeof (errbuf)));
460       return (-1);
461     }
462     else if (status == 0)
463     {
464       DEBUG ("pinba plugin: recvfrom(2) returned unexpected status zero.");
465       return (-1);
466     }
467     else /* if (status > 0) */
468     {
469       assert (((size_t) status) < buffer_size);
470       buffer_size = (size_t) status;
471       buffer[buffer_size] = 0;
472
473       status = pinba_process_stats_packet (buffer, buffer_size);
474       if (status != 0)
475         DEBUG("pinba plugin: Parsing packet failed.");
476       return (status);
477     }
478   } /* while (42) */
479
480   /* not reached */
481   assert (23 == 42);
482   return (-1);
483 } /* }}} void pinba_udp_read_callback_fn */
484
485 static int receive_loop (void) /* {{{ */
486 {
487   pinba_socket_t *s;
488
489   s = pinba_socket_open (conf_node, conf_service);
490   if (s == NULL)
491   {
492     ERROR ("pinba plugin: Collector thread is exiting prematurely.");
493     return (-1);
494   }
495
496   while (!collector_thread_do_shutdown)
497   {
498     int status;
499
500     if (s->fd_num < 1)
501       break;
502
503     status = poll (s->fd, s->fd_num, /* timeout = */ 1000);
504     if (status == 0) /* timeout */
505     {
506       continue;
507     }
508     else if (status < 0)
509     {
510       char errbuf[1024];
511
512       if ((errno == EINTR) || (errno == EAGAIN))
513         continue;
514
515       ERROR ("pinba plugin: poll(2) failed: %s",
516           sstrerror (errno, errbuf, sizeof (errbuf)));
517       pinba_socket_free (s);
518       return (-1);
519     }
520
521     for (nfds_t i = 0; i < s->fd_num; i++)
522     {
523       if (s->fd[i].revents & (POLLERR | POLLHUP | POLLNVAL))
524       {
525         pb_del_socket (s, i);
526         i--;
527       }
528       else if (s->fd[i].revents & (POLLIN | POLLPRI))
529       {
530         pinba_udp_read_callback_fn (s->fd[i].fd);
531       }
532     } /* for (s->fd) */
533   } /* while (!collector_thread_do_shutdown) */
534
535   pinba_socket_free (s);
536   s = NULL;
537
538   return (0);
539 } /* }}} int receive_loop */
540
541 static void *collector_thread (void *arg) /* {{{ */
542 {
543   receive_loop ();
544
545   memset (&collector_thread_id, 0, sizeof (collector_thread_id));
546   collector_thread_running = 0;
547   pthread_exit (NULL);
548   return (NULL);
549 } /* }}} void *collector_thread */
550
551 /*
552  * Plugin declaration section
553  */
554 static int pinba_config_view (const oconfig_item_t *ci) /* {{{ */
555 {
556   char *name   = NULL;
557   char *host   = NULL;
558   char *server = NULL;
559   char *script = NULL;
560   int status;
561
562   status = cf_util_get_string (ci, &name);
563   if (status != 0)
564     return (status);
565
566   for (int i = 0; i < ci->children_num; i++)
567   {
568     oconfig_item_t *child = ci->children + i;
569
570     if (strcasecmp ("Host", child->key) == 0)
571       status = cf_util_get_string (child, &host);
572     else if (strcasecmp ("Server", child->key) == 0)
573       status = cf_util_get_string (child, &server);
574     else if (strcasecmp ("Script", child->key) == 0)
575       status = cf_util_get_string (child, &script);
576     else
577     {
578       WARNING ("pinba plugin: Unknown config option: %s", child->key);
579       status = -1;
580     }
581
582     if (status != 0)
583       break;
584   }
585
586   if (status == 0)
587     service_statnode_add (name, host, server, script);
588
589   sfree (name);
590   sfree (host);
591   sfree (server);
592   sfree (script);
593
594   return (status);
595 } /* }}} int pinba_config_view */
596
597 static int plugin_config (oconfig_item_t *ci) /* {{{ */
598 {
599   /* The lock should not be necessary in the config callback, but let's be
600    * sure.. */
601   pthread_mutex_lock (&stat_nodes_lock);
602
603   for (int i = 0; i < ci->children_num; i++)
604   {
605     oconfig_item_t *child = ci->children + i;
606
607     if (strcasecmp ("Address", child->key) == 0)
608       cf_util_get_string (child, &conf_node);
609     else if (strcasecmp ("Port", child->key) == 0)
610       cf_util_get_service (child, &conf_service);
611     else if (strcasecmp ("View", child->key) == 0)
612       pinba_config_view (child);
613     else
614       WARNING ("pinba plugin: Unknown config option: %s", child->key);
615   }
616
617   pthread_mutex_unlock(&stat_nodes_lock);
618
619   return (0);
620 } /* }}} int pinba_config */
621
622 static int plugin_init (void) /* {{{ */
623 {
624   int status;
625
626   if (stat_nodes == NULL)
627   {
628     /* Collect the "total" data by default. */
629     service_statnode_add ("total",
630         /* host   = */ NULL,
631         /* server = */ NULL,
632         /* script = */ NULL);
633   }
634
635   if (collector_thread_running)
636     return (0);
637
638   status = plugin_thread_create (&collector_thread_id,
639       /* attrs = */ NULL,
640       collector_thread,
641       /* args = */ NULL);
642   if (status != 0)
643   {
644     char errbuf[1024];
645     ERROR ("pinba plugin: pthread_create(3) failed: %s",
646         sstrerror (errno, errbuf, sizeof (errbuf)));
647     return (-1);
648   }
649   collector_thread_running = 1;
650
651   return (0);
652 } /* }}} */
653
654 static int plugin_shutdown (void) /* {{{ */
655 {
656   if (collector_thread_running)
657   {
658     int status;
659
660     DEBUG ("pinba plugin: Shutting down collector thread.");
661     collector_thread_do_shutdown = 1;
662
663     status = pthread_join (collector_thread_id, /* retval = */ NULL);
664     if (status != 0)
665     {
666       char errbuf[1024];
667       ERROR ("pinba plugin: pthread_join(3) failed: %s",
668           sstrerror (status, errbuf, sizeof (errbuf)));
669     }
670
671     collector_thread_running = 0;
672     collector_thread_do_shutdown = 0;
673   } /* if (collector_thread_running) */
674
675   return (0);
676 } /* }}} int plugin_shutdown */
677
678 static int plugin_submit (const pinba_statnode_t *res) /* {{{ */
679 {
680   value_t value;
681   value_list_t vl = VALUE_LIST_INIT;
682
683   vl.values = &value;
684   vl.values_len = 1;
685   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
686   sstrncpy (vl.plugin, "pinba", sizeof (vl.plugin));
687   sstrncpy (vl.plugin_instance, res->name, sizeof (vl.plugin_instance));
688
689   value.derive = res->req_count;
690   sstrncpy (vl.type, "total_requests", sizeof (vl.type));
691   plugin_dispatch_values (&vl);
692
693   value.derive = float_counter_get (&res->req_time, /* factor = */ 1000);
694   sstrncpy (vl.type, "total_time_in_ms", sizeof (vl.type));
695   plugin_dispatch_values (&vl);
696
697   value.derive = res->doc_size;
698   sstrncpy (vl.type, "total_bytes", sizeof (vl.type));
699   plugin_dispatch_values (&vl);
700
701   value.derive = float_counter_get (&res->ru_utime, /* factor = */ 100);
702   sstrncpy (vl.type, "cpu", sizeof (vl.type));
703   sstrncpy (vl.type_instance, "user", sizeof (vl.type_instance));
704   plugin_dispatch_values (&vl);
705
706   value.derive = float_counter_get (&res->ru_stime, /* factor = */ 100);
707   sstrncpy (vl.type, "cpu", sizeof (vl.type));
708   sstrncpy (vl.type_instance, "system", sizeof (vl.type_instance));
709   plugin_dispatch_values (&vl);
710
711   value.gauge = res->mem_peak;
712   sstrncpy (vl.type, "memory", sizeof (vl.type));
713   sstrncpy (vl.type_instance, "peak", sizeof (vl.type_instance));
714   plugin_dispatch_values (&vl);
715
716   return (0);
717 } /* }}} int plugin_submit */
718
719 static int plugin_read (void) /* {{{ */
720 {
721   unsigned int i=0;
722   pinba_statnode_t data;
723
724   while ((i = service_statnode_collect (&data, i)) != 0)
725   {
726     plugin_submit (&data);
727   }
728
729   return 0;
730 } /* }}} int plugin_read */
731
732 void module_register (void) /* {{{ */
733 {
734   plugin_register_complex_config ("pinba", plugin_config);
735   plugin_register_init ("pinba", plugin_init);
736   plugin_register_read ("pinba", plugin_read);
737   plugin_register_shutdown ("pinba", plugin_shutdown);
738 } /* }}} void module_register */
739
740 /* vim: set sw=2 sts=2 et fdm=marker : */