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

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

pull docs into master

  • Property mode set to 100644
Line 
1 <?xml version="1.0"?>
2 <section>
3   <title>varnish</title>
4   <para>Monitor maagement metrics of a Varnish instance.</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.varnish</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>port</term>
27         <listitem>
28           <variablelist>
29             <varlistentry>
30               <term>required</term>
31               <listitem>
32                 <para>optional</para>
33               </listitem>
34             </varlistentry>
35             <varlistentry>
36               <term>default</term>
37               <listitem>
38                 <para>8081</para>
39               </listitem>
40             </varlistentry>
41             <varlistentry>
42               <term>allowed</term>
43               <listitem>
44                 <para>\d+</para>
45               </listitem>
46             </varlistentry>
47           </variablelist>
48           <para>Specifies the port on which the management interface can be reached.</para>
49         </listitem>
50       </varlistentry>
51     </variablelist>
52   </section>
53   <example>
54     <title>Monitor two varnish instances with management on port 8081</title>
55     <para>The following example pulls are metrics available from Varnish running on 10.1.2.3 and 10.1.2.4</para>
56     <programlisting>
57       &lt;noit&gt;
58         &lt;modules&gt;
59           &lt;loader image="lua" name="lua"&gt;
60             &lt;config&gt;&lt;directory&gt;/opt/reconnoiter/libexec/modules-lua/?.lua&lt;/directory&gt;&lt;/config&gt;
61           &lt;/loader&gt;
62           &lt;module loader="lua" name="varnish" object="noit.module.varnish"/&gt;
63         &lt;/modules&gt;
64         &lt;checks&gt;
65           &lt;check uuid="2d42adbc-7c7a-11dd-a48f-4f59e0b654d3" module="varnish" target="10.1.2.3" /&gt;
66           &lt;check uuid="324c2234-7c7a-11dd-8585-cbb783f8267f" module="varnish" target="10.1.2.4" /&gt;
67         &lt;/checks&gt;
68       &lt;/noit&gt;
69       </programlisting>
70   </example>
71 </section>
Note: See TracBrowser for help on using the browser.