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

Revision 23dea7e00df87480acb58bb3398283c2bb227949, 3.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>munin</title>
4   <para>Monitor metrics exposed by a munin-node 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.munin</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>4949</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     <variablelist>
53       <varlistentry>
54         <term>plugins</term>
55         <listitem>
56           <variablelist>
57             <varlistentry>
58               <term>required</term>
59               <listitem>
60                 <para>optional</para>
61               </listitem>
62             </varlistentry>
63             <varlistentry>
64               <term>allowed</term>
65               <listitem>
66                 <para>.+</para>
67               </listitem>
68             </varlistentry>
69           </variablelist>
70           <para>A list of space separated plugins from which to fetch metrics. If not specified, a list will be retrieved from the munin node.</para>
71         </listitem>
72       </varlistentry>
73     </variablelist>
74   </section>
75   <example>
76     <title>Monitor a node running munun-node</title>
77     <para>The following example pulls all munin metrics from 10.1.2.3 and just "processes" metrics from 10.1.2.4</para>
78     <programlisting>
79       &lt;noit&gt;
80         &lt;modules&gt;
81           &lt;loader image="lua" name="lua"&gt;
82             &lt;config&gt;&lt;directory&gt;/opt/reconnoiter/libexec/modules-lua/?.lua&lt;/directory&gt;&lt;/config&gt;
83           &lt;/loader&gt;
84           &lt;module loader="lua" name="munin" object="noit.module.munin"/&gt;
85         &lt;/modules&gt;
86         &lt;checks&gt;
87           &lt;check uuid="535cc224-9f66-11df-b198-8b094b17808a" module="munin" target="10.1.2.3" /&gt;
88           &lt;check uuid="5acce980-9f66-11df-8027-ebfe9d8b53e1" module="munin" target="10.1.2.4"&gt;
89             &lt;config&gt;&lt;plugins&gt;processes&lt;/plugins&gt;&lt;/config&gt;
90           &lt;/check&gt;
91         &lt;/checks&gt;
92       &lt;/noit&gt;
93       </programlisting>
94   </example>
95 </section>
Note: See TracBrowser for help on using the browser.