{GPL, other}: Relicense to MIT license.
[collectd.git] / src / nginx.c
index e5848ee..e8282f2 100644 (file)
 /**
  * collectd - src/nginx.c
- * Copyright (C) 2006,2007  Florian octo Forster
+ * Copyright (C) 2006-2010  Florian octo Forster
+ * Copyright (C) 2008       Sebastian Harl
  *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the
- * Free Software Foundation; either version 2 of the License, or (at your
- * option) any later version.
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
  *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
  *
  * Authors:
- *   Florian octo Forster <octo at verplant.org>
+ *   Florian octo Forster <octo at collectd.org>
+ *   Sebastian Harl <sh at tokkee.org>
  **/
 
 #include "collectd.h"
 #include "common.h"
 #include "plugin.h"
-#include "utils_debug.h"
 #include "configfile.h"
 
-#define MODULE_NAME "nginx"
+#include <curl/curl.h>
 
-#if HAVE_LIBCURL && HAVE_CURL_CURL_H
-#  define NGINX_HAVE_READ 1
-#  include <curl/curl.h>
-#else
-#  define NGINX_HAVE_READ 0
-#endif
+static char *url         = NULL;
+static char *user        = NULL;
+static char *pass        = NULL;
+static char *verify_peer = NULL;
+static char *verify_host = NULL;
+static char *cacert      = NULL;
 
-static char *url    = NULL;
-static char *user   = NULL;
-static char *pass   = NULL;
-static char *cacert = NULL;
-
-#if HAVE_LIBCURL
 static CURL *curl = NULL;
 
-#define ABUFFER_SIZE 16384
-static char nginx_buffer[ABUFFER_SIZE];
-static int  nginx_buffer_len = 0;
-static char nginx_curl_error[CURL_ERROR_SIZE];
-#endif /* HAVE_LIBCURL */
-
-static char *connections_file = "nginx/nginx_connections-%s.rrd";
-static char *connections_ds_def[] =
-{
-  "DS:value:GAUGE:"COLLECTD_HEARTBEAT":0:U",
-  NULL
-};
-static int connections_ds_num = 1;
-
-/* Limit to 2^20 requests/s */
-static char *requests_file = "nginx/nginx_requests.rrd";
-static char *requests_ds_def[] =
-{
-  "DS:value:COUNTER:"COLLECTD_HEARTBEAT":0:1048576",
-  NULL
-};
-static int requests_ds_num = 1;
+static char   nginx_buffer[16384];
+static size_t nginx_buffer_len = 0;
+static char   nginx_curl_error[CURL_ERROR_SIZE];
 
-static char *config_keys[] =
+static const char *config_keys[] =
 {
   "URL",
   "User",
   "Password",
-  "CACert",
-  NULL
+  "VerifyPeer",
+  "VerifyHost",
+  "CACert"
 };
-static int config_keys_num = 4;
+static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
 
-#if HAVE_LIBCURL
-static size_t nginx_curl_callback (void *buf, size_t size, size_t nmemb, void *stream)
+static size_t nginx_curl_callback (void *buf, size_t size, size_t nmemb,
+    void __attribute__((unused)) *stream)
 {
   size_t len = size * nmemb;
 
-  if ((nginx_buffer_len + len) >= ABUFFER_SIZE)
+  /* Check if the data fits into the memory. If not, truncate it. */
+  if ((nginx_buffer_len + len) >= sizeof (nginx_buffer))
   {
-    len = (ABUFFER_SIZE - 1) - nginx_buffer_len;
+    assert (sizeof (nginx_buffer) > nginx_buffer_len);
+    len = (sizeof (nginx_buffer) - 1) - nginx_buffer_len;
   }
 
   if (len <= 0)
     return (len);
 
-  memcpy (nginx_buffer + nginx_buffer_len, (char *) buf, len);
+  memcpy (&nginx_buffer[nginx_buffer_len], buf, len);
   nginx_buffer_len += len;
-  nginx_buffer[nginx_buffer_len] = '\0';
+  nginx_buffer[nginx_buffer_len] = 0;
 
   return (len);
 }
-#endif /* HAVE_LIBCURL */
 
-static int config_set (char **var, char *value)
+static int config_set (char **var, const char *value)
 {
   if (*var != NULL)
   {
@@ -111,7 +93,7 @@ static int config_set (char **var, char *value)
     return (0);
 }
 
-static int config (char *key, char *value)
+static int config (const char *key, const char *value)
 {
   if (strcasecmp (key, "url") == 0)
     return (config_set (&url, value));
@@ -119,38 +101,42 @@ static int config (char *key, char *value)
     return (config_set (&user, value));
   else if (strcasecmp (key, "password") == 0)
     return (config_set (&pass, value));
+  else if (strcasecmp (key, "verifypeer") == 0)
+    return (config_set (&verify_peer, value));
+  else if (strcasecmp (key, "verifyhost") == 0)
+    return (config_set (&verify_host, value));
   else if (strcasecmp (key, "cacert") == 0)
     return (config_set (&cacert, value));
   else
     return (-1);
-}
+} /* int config */
 
-static void init (void)
+static int init (void)
 {
-#if HAVE_LIBCURL
   static char credentials[1024];
 
   if (curl != NULL)
-  {
     curl_easy_cleanup (curl);
-  }
 
   if ((curl = curl_easy_init ()) == NULL)
   {
-    syslog (LOG_ERR, "nginx: `curl_easy_init' failed.");
-    return;
+    ERROR ("nginx plugin: curl_easy_init failed.");
+    return (-1);
   }
 
+  curl_easy_setopt (curl, CURLOPT_NOSIGNAL, 1L);
   curl_easy_setopt (curl, CURLOPT_WRITEFUNCTION, nginx_curl_callback);
-  curl_easy_setopt (curl, CURLOPT_USERAGENT, PACKAGE_NAME"/"PACKAGE_VERSION);
+  curl_easy_setopt (curl, CURLOPT_USERAGENT, COLLECTD_USERAGENT);
   curl_easy_setopt (curl, CURLOPT_ERRORBUFFER, nginx_curl_error);
 
   if (user != NULL)
   {
-    if (snprintf (credentials, 1024, "%s:%s", user, pass == NULL ? "" : pass) >= 1024)
+    int status = ssnprintf (credentials, sizeof (credentials),
+       "%s:%s", user, pass == NULL ? "" : pass);
+    if ((status < 0) || ((size_t) status >= sizeof (credentials)))
     {
-      syslog (LOG_ERR, "nginx: Credentials would have been truncated.");
-      return;
+      ERROR ("nginx plugin: Credentials would have been truncated.");
+      return (-1);
     }
 
     curl_easy_setopt (curl, CURLOPT_USERPWD, credentials);
@@ -161,74 +147,89 @@ static void init (void)
     curl_easy_setopt (curl, CURLOPT_URL, url);
   }
 
-  if (cacert != NULL)
+  curl_easy_setopt (curl, CURLOPT_FOLLOWLOCATION, 1L);
+  curl_easy_setopt (curl, CURLOPT_MAXREDIRS, 50L);
+
+  if ((verify_peer == NULL) || IS_TRUE (verify_peer))
   {
-    curl_easy_setopt (curl, CURLOPT_CAINFO, cacert);
+    curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 1L);
+  }
+  else
+  {
+    curl_easy_setopt (curl, CURLOPT_SSL_VERIFYPEER, 0L);
   }
-#endif /* HAVE_LIBCURL */
-} /* void init */
-
-static void connections_write (char *host, char *inst, char *val)
-{
-  char buf[1024];
 
-  if (snprintf (buf, 1024, connections_file, inst) >= 1024)
-    return;
+  if ((verify_host == NULL) || IS_TRUE (verify_host))
+  {
+    curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 2L);
+  }
+  else
+  {
+    curl_easy_setopt (curl, CURLOPT_SSL_VERIFYHOST, 0L);
+  }
 
-  rrd_update_file (host, buf, val,
-      connections_ds_def, connections_ds_num);
-}
+  if (cacert != NULL)
+  {
+    curl_easy_setopt (curl, CURLOPT_CAINFO, cacert);
+  }
 
-static void requests_write (char *host, char *inst, char *val)
-{
-  rrd_update_file (host, requests_file, val,
-      requests_ds_def, requests_ds_num);
-}
+  return (0);
+} /* void init */
 
-#if NGINX_HAVE_READ
 static void submit (char *type, char *inst, long long value)
 {
-  char buf[1024];
-  int  status;
+  value_t values[1];
+  value_list_t vl = VALUE_LIST_INIT;
+
+  if (strcmp (type, "nginx_connections") == 0)
+    values[0].gauge = value;
+  else if (strcmp (type, "nginx_requests") == 0)
+    values[0].derive = value;
+  else if (strcmp (type, "connections") == 0)
+    values[0].derive = value;
+  else
+    return;
 
-  DBG ("type = %s; inst = %s; value = %lli;",
-      type, (inst == NULL) ? "(nil)" : inst, value);
+  vl.values = values;
+  vl.values_len = 1;
+  sstrncpy (vl.host, hostname_g, sizeof (vl.host));
+  sstrncpy (vl.plugin, "nginx", sizeof (vl.plugin));
+  sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
+  sstrncpy (vl.type, type, sizeof (vl.type));
 
-  status = snprintf (buf, 1024, "%u:%lli", (unsigned int) curtime, value);
-  if ((status < 0) || (status >= 1024))
-  {
-    syslog (LOG_ERR, "nginx: snprintf failed");
-    return;
-  }
+  if (inst != NULL)
+    sstrncpy (vl.type_instance, inst, sizeof (vl.type_instance));
 
-  plugin_submit (type, inst, buf);
-}
+  plugin_dispatch_values (&vl);
+} /* void submit */
 
-static void nginx_read (void)
+static int nginx_read (void)
 {
   int i;
 
   char *ptr;
   char *lines[16];
   int   lines_num = 0;
+  char *saveptr;
 
   char *fields[16];
   int   fields_num;
 
   if (curl == NULL)
-    return;
+    return (-1);
   if (url == NULL)
-    return;
+    return (-1);
 
   nginx_buffer_len = 0;
-  if (curl_easy_perform (curl) != 0)
+  if (curl_easy_perform (curl) != CURLE_OK)
   {
-    syslog (LOG_WARNING, "nginx: curl_easy_perform failed: %s", nginx_curl_error);
-    return;
+    WARNING ("nginx plugin: curl_easy_perform failed: %s", nginx_curl_error);
+    return (-1);
   }
 
   ptr = nginx_buffer;
-  while ((lines[lines_num] = strtok (ptr, "\n\r")) != NULL)
+  saveptr = NULL;
+  while ((lines[lines_num] = strtok_r (ptr, "\n\r", &saveptr)) != NULL)
   {
     ptr = NULL;
     lines_num++;
@@ -259,6 +260,8 @@ static void nginx_read (void)
          && (atoll (fields[1]) != 0)
          && (atoll (fields[2]) != 0))
       {
+       submit ("connections", "accepted", atoll (fields[0]));
+       submit ("connections", "handled", atoll (fields[1]));
        submit ("nginx_requests", NULL, atoll (fields[2]));
       }
     }
@@ -276,20 +279,16 @@ static void nginx_read (void)
   }
 
   nginx_buffer_len = 0;
-}
-#else
-#  define nginx_read NULL
-#endif /* NGINX_HAVE_READ */
+
+  return (0);
+} /* int nginx_read */
 
 void module_register (void)
 {
-  plugin_register (MODULE_NAME, init, nginx_read, NULL);
-  plugin_register ("nginx_requests",   NULL, NULL, requests_write);
-  plugin_register ("nginx_connections", NULL, NULL, connections_write);
-  cf_register (MODULE_NAME, config, config_keys, config_keys_num);
-}
-
-#undef MODULE_NAME
+  plugin_register_config ("nginx", config, config_keys, config_keys_num);
+  plugin_register_init ("nginx", init);
+  plugin_register_read ("nginx", nginx_read);
+} /* void module_register */
 
 /*
  * vim: set shiftwidth=2 softtabstop=2 tabstop=8 :