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

Revision 23dea7e00df87480acb58bb3398283c2bb227949, 3.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>resmon</title>
4   <para>The resmon module performs services checks against an HTTP server serving with Resmon XML or JSON.</para>
5   <para><ulink url="https://labs.omniti.com/trac/resmon"><citetitle>Resmon</citetitle></ulink> is a light-weight resource monitor that exposes health of services over HTTP in XML.</para>
6   <para>This module rides on the http module and provides a secondary phase of XML parsing on the contents that extracts Resmon status messages into metrics that can be trended.</para>
7   <variablelist>
8     <varlistentry>
9       <term>loader</term>
10       <listitem>
11         <para>lua</para>
12       </listitem>
13     </varlistentry>
14     <varlistentry>
15       <term>object</term>
16       <listitem>
17         <para>noit.module.resmon</para>
18       </listitem>
19     </varlistentry>
20   </variablelist>
21   <section>
22     <title>Module Configuration</title>
23   </section>
24   <section>
25     <title>Check Configuration</title>
26     <variablelist>
27       <varlistentry>
28         <term>url</term>
29         <listitem>
30           <variablelist>
31             <varlistentry>
32               <term>required</term>
33               <listitem>
34                 <para>required</para>
35               </listitem>
36             </varlistentry>
37             <varlistentry>
38               <term>allowed</term>
39               <listitem>
40                 <para>.+</para>
41               </listitem>
42             </varlistentry>
43           </variablelist>
44           <para>The URL including schema and hostname (as you would type into a browser's location bar).</para>
45         </listitem>
46       </varlistentry>
47     </variablelist>
48     <variablelist>
49       <varlistentry>
50         <term>port</term>
51         <listitem>
52           <variablelist>
53             <varlistentry>
54               <term>required</term>
55               <listitem>
56                 <para>optional</para>
57               </listitem>
58             </varlistentry>
59             <varlistentry>
60               <term>allowed</term>
61               <listitem>
62                 <para>\d+</para>
63               </listitem>
64             </varlistentry>
65           </variablelist>
66           <para>The TCP port can be specified to overide the default of 81.</para>
67         </listitem>
68       </varlistentry>
69     </variablelist>
70   </section>
71   <example>
72     <title>Checking resmon services on OmniTI Labs.</title>
73     <para>This example checks the Resmon service on OmniTI Labs.</para>
74     <programlisting>
75       &lt;noit&gt;
76         &lt;modules&gt;
77           &lt;loader image="lua" name="lua"&gt;
78             &lt;config&gt;&lt;directory&gt;/opt/reconnoiter/libexec/modules-lua/?.lua&lt;/directory&gt;&lt;/config&gt;
79           &lt;/loader&gt;
80           &lt;module loader="lua" name="resmon" object="noit.module.resmon"/&gt;
81         &lt;/modules&gt;
82         &lt;checks&gt;
83           &lt;labs target="8.8.38.5" module="resmon"&gt;
84             &lt;check uuid="36b8ba72-7968-11dd-a67f-d39a2cc3f9de"&gt;
85               &lt;config&gt;
86                 &lt;auth_user&gt;foo&lt;/auth_user&gt;
87                 &lt;auth_password&gt;bar&lt;/auth_password&gt;
88               &lt;/config&gt;
89             &lt;/check&gt;
90           &lt;/labs&gt;
91         &lt;/checks&gt;
92       &lt;/noit&gt;
93     </programlisting>
94   </example>
95 </section>
Note: See TracBrowser for help on using the browser.