root/docs/config/modules/selfcheck.xml

Revision 23dea7e00df87480acb58bb3398283c2bb227949, 2.0 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>selfcheck</title>
4   <para>The selfcheck module performs a self assessment on the host noitd instance.</para>
5   <variablelist>
6     <varlistentry>
7       <term>loader</term>
8       <listitem>
9         <para>C</para>
10       </listitem>
11     </varlistentry>
12     <varlistentry>
13       <term>image</term>
14       <listitem>
15         <para>selfcheck.so</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>feedname</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>default</term>
37               <listitem>
38                 <para>feed</para>
39               </listitem>
40             </varlistentry>
41             <varlistentry>
42               <term>allowed</term>
43               <listitem>
44                 <para>.+</para>
45               </listitem>
46             </varlistentry>
47           </variablelist>
48           <para>The name of the feed that will be sized.</para>
49         </listitem>
50       </varlistentry>
51     </variablelist>
52   </section>
53   <example>
54     <title>Testing the local noitd instance.</title>
55     <para>We self check the noitd instance every 5 seconds.  Here, the target doesn't mean anything in particular as the check is entirely internal.  The target should match the local noitd's IP address from the perspective of stratcond.</para>
56     <programlisting>
57       &lt;noit&gt;
58         &lt;modules&gt;
59           &lt;module image="selfcheck" name="selfcheck"/&gt;
60         &lt;/modules&gt;
61         &lt;checks&gt;
62           &lt;check uuid="6e65ffdc-f174-11dd-86fe-b7da9645ce7c" target="10.225.209.90" period="5000" timeout="4000"/&gt;
63         &lt;/checks&gt;
64       &lt;/noit&gt;
65     </programlisting>
66   </example>
67 </section>
Note: See TracBrowser for help on using the browser.