Changeset 88

Show
Ignore:
Timestamp:
02/01/04 23:09:43 (8 years ago)
Author:
jimmyo
Message:

Documentation updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/ChangeLog

    • Property cvs2svn:cvs-rev changed from 1.34 to 1.35
    r84 r88  
    88    (SF#881046) 
    99  * Remove dependency on pgrep (use process groups instead). (SF#881049) 
     10  * Documentation updates. 
    1011 
    1112munin (1.0.0pre2) 

  • trunk/munin-doc-base.html

    • Property cvs2svn:cvs-rev changed from 1.6 to 1.7
    r87 r88  
    4444</pre> 
    4545The node supports quite a few options. 
    46 <tt> 
    47 <dl> 
    48 <dt>graph_title<dd>The title of the graph, defaults to the servicename. 
    49 <dt>create_args<dd>If set, the arguments will be passed on to rrdcreate. 
    50 <dt>graph_args<dd>If set, the arguments will be passed on to rrdgraph. 
    51 <dt>graph_order<dd>In witch order to draw the datasources. Can also include path aliases on the form alias=domain;host:graph.datasource. See further down for details. 
    52 <dt>graph_vlabel<dd>Y-axis label of the graph.  
    53 <dt>graph_vtitle<dd>Y-axis label of the graph. NOTE: Deprecated, use graph_vlabel. 
    54 <dt>graph_total<dd>If set, summarise all the datasources' values and use the value of graph_total as a label. 
    55 <dt>graph_scale<dd>Default on. If set, disables scaling of min/max/cur values. 
    56 <dt>graph<dd>Set to "yes" or "no". Decides wether to draw the graph. Defaults to "yes". 
    57 <dt>update<dd>Set to "yes" or "no". Decides wether munin-update should fetch data for the graph. Defaults to "yes". 
    58 <dt>host_name<dd>Override which host name this plugin is run for. Ugly - 
     46<dl> 
     47<dt><code>graph_title</code><dd>The title of the graph, defaults to the servicename.</dd> 
     48<dt><code>create_args</code><dd>If set, the arguments will be passed on to rrdcreate.</dd> 
     49<dt><code>graph_args</code><dd>If set, the arguments will be passed on to rrdgraph.</dd> 
     50<dt><code>graph_order</code><dd>In witch order to draw the datasources. Can also include path aliases on the form alias=domain;host:graph.datasource. See further down for details.</dd> 
     51<dt><code>graph_vlabel</code><dd>Y-axis label of the graph. </dd> 
     52<dt><code>graph_vtitle</code><dd>Y-axis label of the graph. NOTE: Deprecated, use graph_vlabel.</dd> 
     53<dt><code>graph_total</code><dd>If set, summarise all the datasources' values and use the value of graph_total as a label.</dd> 
     54<dt><code>graph_scale</code><dd>Default on. If set, disables scaling of min/max/cur values.</dd> 
     55<dt><code>graph</code><dd>Set to "yes" or "no". Decides wether to draw the graph. Defaults to "yes".</dd> 
     56<dt><code>update</code><dd>Set to "yes" or "no". Decides wether munin-update should fetch data for the graph. Defaults to "yes".</dd> 
     57<dt><code>host_name</code><dd>Override which host name this plugin is run for. Ugly - 
    5958see further down on how to do this in the node configuration files 
    60 instead, which is more elegant. 
    61 <dt>{name}.label<dd>REQUIRED. Name of the datasource. You can have many 
    62 datasouces in one graph. 
    63 <dt>{name}.cdef<dd>RPN-expression. Modify the values before graphing. See the FAQ for examples. 
    64 <dt>{name}.draw<dd>What to draw from the data source: AREA, LINE1-3. Defaults to LINE2. 
    65 <dt>{name}.graph<dd>Set to "no" or "yes. Decides wether to graph the data source. Defaults to yes. 
    66 <dt>{name}.max<dd>Maximum value. If the fetched value is below "max", it will be discarded. 
    67 <dt>{name}.min<dd>Minimum value. If the fetched value is below "min", it will be discarded. 
    68 <dt>{name}.negative<dd>Name of field to 'mirror' on the opposite side of zero. See the FAQ for examples. 
    69 <dt>{name}.skipdraw<dd>Disables drawing of datasource. NOTE: Deprecated - use {name}.graph instead. 
    70 <dt>{name}.type<dd>Type of datasource, COUNTER, ABSOLUTE, DERIVE and 
    71 GAUGE, defaults to GAUGE. Read "man rrdcreate" for more info.  
    72 <dt>{name}.warning<dd>Used by munin-nagios. Can be a max value or a range 
    73 sepereated by colon. E.g. "min:", ":max", "min:max", "max". 
    74 <dt>{name}.critical<dd>Same as above. 
    75 </dl> 
    76 </tt> 
     59instead, which is more elegant.</dd> 
     60<dt><code>{name}.label</code><dd>REQUIRED. Name of the datasource. You can have many 
     61datasouces in one graph.</dd> 
     62<dt><code>{name}.cdef</code><dd>RPN-expression. Modify the values before graphing. See the FAQ for examples.</dd> 
     63<dt><code>{name}.draw</code><dd>What to draw from the data source: AREA, LINE1-3. Defaults to LINE2.</dd> 
     64<dt><code>{name}.graph</code><dd>Set to "no" or "yes. Decides wether to graph the data source. Defaults to yes.</dd> 
     65<dt><code>{name}.max</code><dd>Maximum value. If the fetched value is below "max", it will be discarded.</dd> 
     66<dt><code>{name}.min</code><dd>Minimum value. If the fetched value is below "min", it will be discarded.</dd> 
     67<dt><code>{name}.negative</code><dd>Name of field to 'mirror' on the opposite side of zero. See the FAQ for examples.</dd> 
     68<dt><code>{name}.skipdraw</code><dd>Disables drawing of datasource. NOTE: Deprecated - use {name}.graph instead.</dd> 
     69<dt><code>{name}.type</code><dd>Type of datasource, COUNTER, ABSOLUTE, DERIVE and 
     70GAUGE, defaults to GAUGE. Read "man rrdcreate" for more info. </dd> 
     71<dt><code>{name}.warning</code><dd>Used by munin-nagios. Can be a max value or a range 
     72sepereated by colon. E.g. "min:", ":max", "min:max", "max".</dd> 
     73<dt><code>{name}.critical</code><dd>Same as above.</dd> 
     74</dl> 
    7775{name} is limited to 19 characters, and the characters [a-zA-Z0-9_].<br> 
    7876<p> 
    …… 
    9492 <dt>[&lt;plugin-name&gt;]<dd>The following lines are for 
    9593 <code>plugin-name</code>. 
    96  <dt>user &lt;username|userid&gt;<dd>Run plugin as this user 
    97  <dt>group &lt;groupname|groupid&gt;[, &lt;groupname|groupid&gt;] [...]<dd>Run plugin as this group. If group is inside paranthesis, don't croak if it's nonexistant. 
    98  <dt>command &lt;command&gt;<dd>Run command instad of plugin. "%c" will 
     94 <dt><code>user &lt;username|userid&gt;</code><dd>Run plugin as this user 
     95 <dt><code>group &lt;groupname|groupid&gt;[, &lt;groupname|groupid&gt;] [...]</code><dd>Run plugin as this group. If group is inside paranthesis, don't croak if it's nonexistant. 
     96 <dt><code>command &lt;command&gt;</code><dd>Run command instad of plugin. "%c" will 
    9997 be expanded to what would otherwise have been run. E.g. "<code>command sudo 
    10098 -u root %c</code>". 
    101  <dt>env.&lt;var&gt; &lt;contents&gt;<dd>Will cause the environment 
    102  variable "<code>var</code> to be set to "<code>contents</code>" when 
     99 <dt><code>env.&lt;var&gt; &lt;contents&gt;</code><dd>Will cause the environment 
     100 variable <code>var</code> to be set to <code>contents</code> when 
    103101 running the plugin. 
    104102</dl>