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