root/docs/config/modules/noit.module.nginx.xml

Revision fbf2b3181e1cc48410fe39bb0f0c291d73095a8f, 2.2 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 3 years ago)

fix a horribly broken XML description

  • Property mode set to 100644
Line 
1 <?xml version="1.0"?>
2 <section>
3   <title>nginx</title>
4   <para>The nginx module gathers information from the nginx stub_status module</para>
5   <variablelist>
6     <varlistentry>
7       <term>loader</term>
8       <listitem>
9         <para>lua</para>
10       </listitem>
11     </varlistentry>
12     <varlistentry>
13       <term>object</term>
14       <listitem>
15         <para>noit.module.nginx</para>
16       </listitem>
17     </varlistentry>
18   </variablelist>
19   <section>
20     <title>Module Configuration</title>
21   </section>
22   <section>
23     <title>Check Configuration</title>
24     <variablelist>
25       <varlistentry>
26         <term>url</term>
27         <listitem>
28           <variablelist>
29             <varlistentry>
30               <term>required</term>
31               <listitem>
32                 <para>required</para>
33               </listitem>
34             </varlistentry>
35             <varlistentry>
36               <term>allowed</term>
37               <listitem>
38                 <para>.+</para>
39               </listitem>
40             </varlistentry>
41           </variablelist>
42           <para>The URL including schema and hostname for the status output from nginx.</para>
43         </listitem>
44       </varlistentry>
45     </variablelist>
46   </section>
47   <example>
48     <title>Monitor an nginx server with a status page available at http://10.1.2.3/nginx_status</title>
49     <para>The following example pulls metrics from Nginx's status module (http://wiki.nginx.org/HttpStubStatusModule) from http://10.1.2.3/nginx_status</para>
50     <programlisting>
51       &lt;noit&gt;
52         &lt;modules&gt;
53           &lt;loader image="lua" name="lua"&gt;
54             &lt;config&gt;&lt;directory&gt;/opt/reconnoiter/libexec/modules-lua/?.lua&lt;/directory&gt;&lt;/config&gt;
55           &lt;/loader&gt;
56           &lt;module loader="lua" name="nginx" object="noit.module.nginx"/&gt;
57         &lt;/modules&gt;
58         &lt;checks&gt;
59          &lt;check uuid="CAC1A58F-1670-4F71-8D15-21461D3F6624" name="nginx_10123" module="nginx" target="10.1.2.3"&gt;
60            &lt;config&gt;
61              &lt;url&gt;http://10.1.2.3/nginx_status&lt;/url&gt;
62            &lt;/config&gt;
63         &lt;/checks&gt;
64       &lt;/noit&gt;
65       </programlisting>
66   </example>
67 </section>
Note: See TracBrowser for help on using the browser.