From: Florian Forster <octo@noris.net>
Date: Tue, 23 Oct 2007 14:33:49 +0000 (+0200)
Subject: collectd.conf(5): Documented the new nginx plugin.
X-Git-Tag: collectd-4.2.0~21^2
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=228f99e5802dc8a7b88fbda272b1e3d75bfcd910;p=collectd.git

collectd.conf(5): Documented the new nginx plugin.
---

diff --git a/README b/README
index 338ea4b2..9c1faac2 100644
--- a/README
+++ b/README
@@ -110,6 +110,10 @@ Features
       NFS Procedures: Which NFS command were called how often. Only NFSv2 and
       NFSv3 right now.
 
+    - nginx
+      Collects statistics from `nginx' (speak: engine X), a HTTP and mail
+      server/proxy.
+
     - ntp
       NTP daemon statistics: Local clock drift, offset to peers, etc.
 
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 9dcff259..2f4accc8 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -569,6 +569,39 @@ either.
 
 =back
 
+=head2 Plugin C<nginx>
+
+This plugin collects the number of connections and requests handeled by the
+C<nginx daemon> (speak: engineE<nbsp>X), a HTTP and mail server/proxy. It
+queries the page provided by the C<ngx_http_stub_status_module> module, which
+isn't compiled by default. Please refer to
+L<http://wiki.codemongers.com/NginxStubStatusModule> for more information on
+how to compile and configure nginx and this module.
+
+The following options are accepted by the C<nginx plugin>:
+
+=over 4
+
+=item B<URL> I<http://host/nginx_status>
+
+Sets the URL of the C<ngx_http_stub_status_module> output.
+
+=item B<User> I<Username>
+
+Optional user name needed for authentication.
+
+=item B<Password> I<Password>
+
+Optional password needed for authentication.
+
+=item B<CACert> I<File>
+
+File that holds one or more SSL certificates. If you want to use HTTPS you will
+possibly need this option. What CA certificates come bundled with C<libcurl>
+and are checked by default depends on the distribution you use.
+
+=back
+
 =head2 Plugin C<ntpd>
 
 =over 4