root/src/modules/resmon.xml

Revision b0e455c7afe4f98214b30df656b76b2c28d67328, 2.6 kB (checked in by Theo Schlossnagle <jesus@omniti.com>, 6 years ago)

resmon and resmon_part docs

  • Property mode set to 100644
Line 
1 <module>
2   <name>resmon</name>
3   <description><para>The resmon module performs services checks against a Resmon service.</para>
4   <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>
5   <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>
6   </description>
7   <loader>C</loader>
8   <image>http.so</image>
9   <moduleconfig>
10     <parameter name="url"
11                required="optional"
12                allowed="http://target:81/">The default URL to be used by checks that do not specify an explicit URL.</parameter>
13     <parameter name="ca_chain"
14                required="optional"
15                allowed=".+">A path to a file containing all the certificate authorities that should be loaded to validate the remote certificate (for SSL checks).  This is used for SSL checks if this paramter is not set explicitly in the check config.</parameter>
16     <parameter name="certificate_file"
17                required="optional"
18                allowed=".+">A path to a file containing all the client certificate that will be presented to the remote server (for SSL checks).  This is used for SSL checks if this paramter is not set explicitly in the check config.</parameter>
19   </moduleconfig>
20   <checkconfig>
21     <parameter name="url"
22                required="required"
23                allowed=".+">The URL including schema and hostname (as you would type into a browser's location bar).</parameter>
24     <parameter name="ca_chain"
25                required="optional"
26                allowed=".+">A path to a file containing all the certificate authorities that should be loaded to validate the remote certificate (for SSL checks).</parameter>
27     <parameter name="certificate_file"
28                required="optional"
29                allowed=".+">A path to a file containing all the client certificate that will be presented to the remote server (for SSL checks).</parameter>
30   </checkconfig>
31   <examples>
32     <example>
33       <title>Checking resmon services on OmniTI Labs.</title>
34       <para>This example checks the Resmon service on OmniTI Labs.</para>
35       <programlisting><![CDATA[
36       <noit>
37         <modules>
38           <module image="http" name="resmon" />
39         </modules>
40         <checks>
41           <labs target="8.8.38.5" module="resmon">
42             <check uuid="36b8ba72-7968-11dd-a67f-d39a2cc3f9de"/>
43           </labs>
44         </checks>
45       </noit>
46     ]]></programlisting>
47     </example>
48   </examples>
49 </module>
Note: See TracBrowser for help on using the browser.