src/nginx.c

   1 /**
   2  * collectd - src/nginx.c
   3  * Copyright (C) 2006-2010  Florian octo Forster
   4  * Copyright (C) 2008       Sebastian Harl
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Authors:
  25  *   Florian octo Forster <octo at collectd.org>
  26  *   Sebastian Harl <sh at tokkee.org>
  27  **/
  28
  29 #include "collectd.h"
  30 #include "common.h"
  31 #include "plugin.h"
  32 #include "configfile.h"
  33
  34 #include <curl/curl.h>
  35
  36 static char *url         = NULL;
  37 static char *user        = NULL;
  38 static char *pass        = NULL;
  39 static char *verify_peer = NULL;
  40 static char *verify_host = NULL;
  41 static char *cacert      = NULL;
  42
  43 static CURL *curl = NULL;
  44
  45 static char   nginx_buffer[16384];
  46 static size_t nginx_buffer_len = 0;
  47 static char   nginx_curl_error[CURL_ERROR_SIZE];
  48
  49 static const char *config_keys[] =
  50 {
  51   "URL",
  52   "User",
  53   "Password",
  54   "VerifyPeer",
  55   "VerifyHost",
  56   "CACert"
  57 };
  58 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  59
  60 static size_t nginx_curl_callback (void *buf, size_t size, size_t nmemb,
  61     void __attribute__((unused)) *stream)
  62 {
  63   size_t len = size * nmemb;
  64
  65   /* Check if the data fits into the memory. If not, truncate it. */
  66   if ((nginx_buffer_len + len) >= sizeof (nginx_buffer))
  67   {
  68     assert (sizeof (nginx_buffer) > nginx_buffer_len);
  69     len = (sizeof (nginx_buffer) - 1) - nginx_buffer_len;
  70   }
  71
  72   if (len <= 0)
  73     return (len);
  74
  75   memcpy (&nginx_buffer[nginx_buffer_len], buf, len);
  76   nginx_buffer_len += len;
  77   nginx_buffer[nginx_buffer_len] = 0;
  78
  79   return (len);
  80 }
  81
  82 static int config_set (char **var, const char *value)
  83 {
  84   if (*var != NULL)
  85   {
  86     free (*var);
  87     *var = NULL;
  88   }
  89
  90   if ((*var = strdup (value)) == NULL)
  91     return (1);
  92   else
  93     return (0);
  94 }
  95
  96 static int config (const char *key, const char *value)
  97 {
  98   if (strcasecmp (key, "url") == 0)
  99     return (config_set (&url, value));
 100   else if (strcasecmp (key, "user") == 0)
 101     return (config_set (&user, value));
 102   else if (strcasecmp (key, "password") == 0)
 103     return (config_set (&pass, value));
 104   else if (strcasecmp (key, "verifypeer") == 0)
 105     return (config_set (&verify_peer, value));
 106   else if (strcasecmp (key, "verifyhost") == 0)
 107     return (config_set (&verify_host, value));
 108   else if (strcasecmp (key, "cacert") == 0)
 109     return (config_set (&cacert, value));
 110   else
 111     return (-1);
 112 } /* int config */
 113
 114 static int init (void)
 115 {
 116   static char credentials[1024];
 117
 118   if (curl != NULL)
 119     curl_easy_cleanup (curl);
 120
 121   if ((curl = curl_easy_init ()) == NULL)
 122   {
 123     ERROR ("nginx plugin: curl_easy_init failed.");
 124     return (-1);
 125   }
 126
 127   curl_easy_setopt (curl, CURLOPT_NOSIGNAL, 1L);
 128   curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, nginx_curl_callback);
 129   curl_easy_setopt (curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
 130   curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, nginx_curl_error);
 131
 132   if (user != NULL)
 133   {
 134     int status = ssnprintf (credentials, sizeof (credentials),
 135         "%s:%s", user, pass == NULL ? "" : pass);
 136     if ((status < 0) || ((size_t) status >= sizeof (credentials)))
 137     {
 138       ERROR ("nginx plugin: Credentials would have been truncated.");
 139       return (-1);
 140     }
 141
 142     curl_easy_setopt (curl, CURLOPT_USERPWD, credentials);
 143   }
 144
 145   if (url != NULL)
 146   {
 147     curl_easy_setopt (curl, CURLOPT_URL, url);
 148   }
 149
 150   curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1L);
 151   curl_easy_setopt (curl, CURLOPT_MAXREDIRS, 50L);
 152
 153   if ((verify_peer == NULL) || IS_TRUE (verify_peer))
 154   {
 155     curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 1L);
 156   }
 157   else
 158   {
 159     curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 0L);
 160   }
 161
 162   if ((verify_host == NULL) || IS_TRUE (verify_host))
 163   {
 164     curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 2L);
 165   }
 166   else
 167   {
 168     curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 0L);
 169   }
 170
 171   if (cacert != NULL)
 172   {
 173     curl_easy_setopt (curl, CURLOPT_CAINFO, cacert);
 174   }
 175
 176   return (0);
 177 } /* void init */
 178
 179 static void submit (char *type, char *inst, long long value)
 180 {
 181   value_t values[1];
 182   value_list_t vl = VALUE_LIST_INIT;
 183
 184   if (strcmp (type, "nginx_connections") == 0)
 185     values[0].gauge = value;
 186   else if (strcmp (type, "nginx_requests") == 0)
 187     values[0].derive = value;
 188   else if (strcmp (type, "connections") == 0)
 189     values[0].derive = value;
 190   else
 191     return;
 192
 193   vl.values = values;
 194   vl.values_len = 1;
 195   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 196   sstrncpy (vl.plugin, "nginx", sizeof (vl.plugin));
 197   sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
 198   sstrncpy (vl.type, type, sizeof (vl.type));
 199
 200   if (inst != NULL)
 201     sstrncpy (vl.type_instance, inst, sizeof (vl.type_instance));
 202
 203   plugin_dispatch_values (&vl);
 204 } /* void submit */
 205
 206 static int nginx_read (void)
 207 {
 208   int i;
 209
 210   char *ptr;
 211   char *lines[16];
 212   int   lines_num = 0;
 213   char *saveptr;
 214
 215   char *fields[16];
 216   int   fields_num;
 217
 218   if (curl == NULL)
 219     return (-1);
 220   if (url == NULL)
 221     return (-1);
 222
 223   nginx_buffer_len = 0;
 224   if (curl_easy_perform (curl) != CURLE_OK)
 225   {
 226     WARNING ("nginx plugin: curl_easy_perform failed: %s", nginx_curl_error);
 227     return (-1);
 228   }
 229
 230   ptr = nginx_buffer;
 231   saveptr = NULL;
 232   while ((lines[lines_num] = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
 233   {
 234     ptr = NULL;
 235     lines_num++;
 236
 237     if (lines_num >= 16)
 238       break;
 239   }
 240
 241   /*
 242    * Active connections: 291
 243    * server accepts handled requests
 244    *  16630948 16630948 31070465
 245    * Reading: 6 Writing: 179 Waiting: 106
 246    */
 247   for (i = 0; i < lines_num; i++)
 248   {
 249     fields_num = strsplit (lines[i], fields,
 250         (sizeof (fields) / sizeof (fields[0])));
 251
 252     if (fields_num == 3)
 253     {
 254       if ((strcmp (fields[0], "Active") == 0)
 255           && (strcmp (fields[1], "connections:") == 0))
 256       {
 257         submit ("nginx_connections", "active", atoll (fields[2]));
 258       }
 259       else if ((atoll (fields[0]) != 0)
 260           && (atoll (fields[1]) != 0)
 261           && (atoll (fields[2]) != 0))
 262       {
 263         submit ("connections", "accepted", atoll (fields[0]));
 264         submit ("connections", "handled", atoll (fields[1]));
 265         submit ("nginx_requests", NULL, atoll (fields[2]));
 266       }
 267     }
 268     else if (fields_num == 6)
 269     {
 270       if ((strcmp (fields[0], "Reading:") == 0)
 271           && (strcmp (fields[2], "Writing:") == 0)
 272           && (strcmp (fields[4], "Waiting:") == 0))
 273       {
 274         submit ("nginx_connections", "reading", atoll (fields[1]));
 275         submit ("nginx_connections", "writing", atoll (fields[3]));
 276         submit ("nginx_connections", "waiting", atoll (fields[5]));
 277       }
 278     }
 279   }
 280
 281   nginx_buffer_len = 0;
 282
 283   return (0);
 284 } /* int nginx_read */
 285
 286 void module_register (void)
 287 {
 288   plugin_register_config ("nginx", config, config_keys, config_keys_num);
 289   plugin_register_init ("nginx", init);
 290   plugin_register_read ("nginx", nginx_read);
 291 } /* void module_register */
 292
 293 /*
 294  * vim: set shiftwidth=2 softtabstop=2 tabstop=8 :
 295  */