config.pod

主要用于监控网络流量并动态产生可视化结果

By default, mrtg puts all the files that it generates for each
target (the GIFs, the HTML page, the log file, etc.) in I<WorkDir>.

If the I<Directory> option is specified, the files are instead put
into a directory under I<WorkDir>.  (For example the I<Directory>
option below would cause all the files for a target ezwf
to be put into directory /usr/tardis/pub/www/stats/mrtg/ezwf/ .)

The directory must already exist; mrtg will not create it.

Example:

 WorkDir: /usr/tardis/pub/www/stats/mrtg
 Directory[ezwf]: ezwf

=head2 XSize and YSize

By default mrtgs graphs are 100 by 400 pixels wide (plus
some more for the labels. In the example we get almost
square graphs ...

Note: XSize must be between 20 and 600; YSize must be larger than 20

Example:

 XSize[ezwf]: 300
 YSize[ezwf]: 300

=head2 XZoom and YZoom

If you want your graphs to have larger pixels, you can
"Zoom" them.

Example:

 XZoom[ezwf]: 2.0
 YZoom[ezwf]: 2.0

=head2 XScale and YScale

If you want your graphs to be actually scaled use I<XScale>
and I<YScale>. (Beware while this works, the results look ugly 
(to be frank) so if someone wants to fix this: patches are welcome.

Example:

 XScale[ezwf]: 1.5
 YScale[ezwf]: 1.5


=head2 YTics and YTicsFactor

If you want to show more than 4 lines per graph, use YTics.
If you want to scale the value used for the YLegend of these
tics, use YTicsFactor.
The default value for YTics is 4 and the default value for
YTicsFactor is 1.0 .


Example:

  Suppose you get values ranging from 0 to 700.
  You want to plot 7 lines and want to show 
  0, 1, 2, 3, 4, 5, 6, 7 instead of 0, 100, 200,
  300, 400, 500, 600, 700.  You should write then:

  YTics[ezwf]: 7
  YTicsFactor[ezwf]: 0.01

=head2 Step

Change the default step from 5 * 60 seconds to 
something else (I have not tested this well ...)

Example:

 Step[ezwf]: 60

=head2 Options

The I<Options> Keyword allows you to set some boolean 
switches:

=over 4

=item growright 

The graph grows to the left by default.
This option flips the direction of growth
causing the current time to be at the right edge
of the graph and the history values to the left of it.

=item bits 

All the monitored variable values are multiplied by 8
(i.e. shown in bits instead of bytes) ... looks much more impressive :-)
It also affects the 'factory default' labeling and units
for the given target.

=item perminute

All the monitored variable values are multiplied by 60
(i.e. shown in units per minute instead of units per second) in case
of small values more accurate graphs are displayed.
It also affects the 'factory default' labeling and units
for the given target.

=item perhour

All the monitored variable values are multiplied by 3600
(i.e. shown in units per hour instead of units per second) in case
of small values more accurate graphs are displayed.
It also affects the 'factory default' labeling and units
for the given target.

=item noinfo

Suppress the information about uptime and
device name in the generated webpage.

=item nopercent

Don't print usage percentages

=item transparent

make the background of the generated gifs transparent ...

=item integer

Print summary lines below graph as integers without comma

=item dorelpercent

The relative percentage of IN-traffic to OUT-traffic is calculated
and displayed in the graph as an additional line.
Note: Only a fixed scale is available (from 0 to 100%). Therefore
for IN-traffic greater than OUT-traffic also 100% is displayed.
If you suspect that your IN-traffic is not always less than or equal
to your OUT-traffic you are urged to not use this options.
Note: If you use this option in combination with the I<Colours>
options, a fifth colour-name colour-value pair is required there.

=item gauge

Treat the values gathered from target as absolute
and not as ever incrementing counters.
This would be useful to monitor things like disk space,
processor load, temperature, and the like ...

In the absence of 'gauge' and 'absolute' options,
MRTG treats variable as a counter and calculates
the difference between the current and the previous value
and divides that by the elapsed time between
the last two readings to get the value to be plotted.

=item absolute

This is for data sources which reset their value when they are read. This
means that rateup does not havt to build the difference between this and the
last value read from the data source. The value obtained is still divided by
the elapsed time between the last two readings, which makes it different
from the 'gauge' option. Useful for external data gatherers.

=item unknaszero

Log unknown data as zero instead of the default behaviour of repeating the
last value seen. Be careful with this, often a flat line in the graph is
much more obvious than a line at 0.

=back

Example:

 Options[ezwf]: growright, bits


=head2 kilo

Use this option to change the multiplier value for building
prefixes. Defaultvalue is 1000. This tag is for the special
case that 1kB = 1024B, 1MB = 1024kB and so far.

Example:

 kilo[ezwf]: 1024


=head2 kMG

Change the default multiplier prefixes (,k,M,G,T,P). In the tag
I<ShortLegend> define only the basic units.
Format: Comma seperated list of prefixed. Two consecutive commas
or a comma at start or end of the line gives no prefix on this item.
Note: If you do not want prefixes, then leave this line blank.

Example: velocity in nm/s (nanometers per second) displayed in nm/h.

 ShortLegend[ezwf]: m/min
 kMG[ezwf]: n,u,m,,k,M,G,T,P
 options[ezwf]: perhour


=head2 Colours

The I<Colours> tag allows you to override the default colour
scheme.  Note: All 4 of the required colours must be
specified here. The colour name ('Colourx' below) is the
legend name displayed, while the RGB value is the real
colour used for the display, both on the graph and in the
html doc.

Format is: Colour1#RRGGBB,Colour2#RRGGBB,Colour3#RRGGBB,Colour4#RRGGBB

Important:
If you use the I<dorelpercent> options tag a fifth colour name
colour value pair is required:
Colour1#RRGGBB,Colour2#RRGGBB,Colour3#RRGGBB,Colour4#RRGGBB,Colour5#RRGGBB

=over 4

=item Colour1

First variable (normally Input) on default graph

=item Colour2

Second variable (normally Output) on default graph

=item Colour3

Max first variable (input)

=item Colour4

Max second variable (output)

=item RRGGBB

2 digit hex values for Red, Green and Blue

=back 

Example:

 Colours[ezwf]: GREEN#00eb0c,BLUE#1000ff,DARK GREEN#006600,VIOLET#ff00ff

=head2 Background

With the I<Background> tag you can configure the background
colour of the generated HTML page

Example:

 Background[ezwf]: #a0a0a0a

=head2 YLegend, ShortLegend, Legend[1234]

The following keywords allow you to override the text
displayed for the various legends of the graph and in the
HTML document

=over 4

=item YLegend

The Y-axis label of the graph. Note that a text which is too long
to fit in the graph will be silently ignored.

=item ShortLegend

The units string (default 'b/s') used for Max, Average and Current

=item Legend[1234IO]

The strings for the colour legend

=back

Example:

  YLegend[ezwf]: Bits per Second
  ShortLegend[ezwf]: b/s
  Legend1[ezwf]: Incoming Traffic in Bits per Second
  Legend2[ezwf]: Outgoing Traffic in Bits per Second
  Legend3[ezwf]: Maximal 5 Minute Incoming Traffic
  Legend4[ezwf]: Maximal 5 Minute Outgoing Traffic
  LegendI[ezwf]: &nbsp;In:
  LegendO[ezwf]: &nbsp;Out:

Note, if I<LegendI> or I<LegendO> are set to an empty string with

 LegendO[ezwf]:

The corresponding line below the graph will not be printed at all.

=head2 Timezone

If you live in an international world, you might want to 
generate the graphs in different timezones. This is set in the 
TZ variable. Under certain operating systems like Solaris, 
this will provoke the localtime call to give the time in 
the selected timezone ...

Example:

 Timezone[ezwf]: Japan

The Timezone is the standard Solaris timezone, ie Japan, Hongkong,
GMT, GMT+1 etc etc.

=head2 Weekformat

By default, mrtg (actually rateup) uses the strftime(3) '%W' option
to format week numbers in the monthly graphs.  The exact semantics
of this format option vary between systems.  If you find that the
week numbers are wrong, and your system's strftime(3) routine
supports it, you can try another format option.  The POSIX '%V'
option seems to correspond to a widely used week numbering
convention.  The week format character should be specified as a
single letter; either W, V, or U.

Example:

 Weekformat[ezwf]: V

=head1 Threshold Checking

Through its threshold checking functionality mrtg is able to detect
threshold problems for the various targets and can call external
scripts to handle those problems (send email or a page to an administrator). 

Threshold checking is configured through the following parameters:

=head2 ThreshDir (GLOBAL)

If you want to be able to detect when a parameter is OK again (back within
threshold), you must define this directory.  Temporary files will be stored
here between runnings to indicate which parameters had threshold problems on
the previous running.

=head2 ThreshMinI  (PER TARGET)

This is the minimum acceptable value for the Input (first) parameter.  If
the parameter falls below this value, the program specified in ThreshProgI
will be run.

=head2 ThreshMaxI (PER TARGET)

This is the maximum acceptable value for the Input (first) parameter.  If
the parameter falls above this value, the program specified in ThreshProgI
will be run.

=head2 ThreshDesc (PER TARGET)

Its value will be assigned to the environment variable THRESH_DESC before
any of the programs mentioned below are called. The programms can use the value
of this variable to produce more userfriendly output.

=head2 ThreshProgI  (PER TARGET)

This defines a program to be run if ThreshMinI or ThreshMaxI is broken.  (It
currently passes 3 arguments: the $router variable, the threshold value
broken, and the current parameter value.  This can be changed as required.)

=head2 ThreshProgOKI  (PER TARGET)

This defines a program to be run if the parameter is currently OK (based on
ThreshMinI and ThreshMaxI), but wasn't OK on the previous running -- based
on the files found in ThreshDir.

=head2 ThreshMinO, ThreshMaxO, ThreshProgO, and ThreshProgOKO 

They work the same as their *I counterparts, except on the Output (second)
parameter.

=head1 Two very special Target names

To save yourself some typing you can define a target
called '^'. The text of every Keyword you define for this
target will be PREPENDED to the corresponding Keyword of
all the targets defined below this line. The same goes for
a Target called '$' but its text will be APPENDED.

Note that a space is inserted between the prepended text
and the Keyword value, as well as between the Keyword value
and the appended text. This works well for text-valued Keywords,
but is not very useful for other Keywords. See the "default"
target description below.

The example will make mrtg use a common header and a
common contact person in all the pages generated from
targets defined later in this file.

Example:

 PageTop[^]: <H1>NoWhere Unis Traffic Stats</H1><HR>
 PageTop[$]: Contact Peter Norton if you have any questions<HR>

To remove the prepend/append value, specify an empty value, e.g.:

 PageTop[^]:
 PageTop[$]:

=head1 And one more very special Target name

The target name '_' specifies a default value for that
Keyword. In the absence of explicit Keyword value, the prepended
and the appended keyword value, the default value will be used.

Example:

 YSize[_]: 150
 Options[_]: growright,bits,nopercent
 WithPeak[_]: ymw
 Suppress[_]: y
 MaxBytes[_]: 1250000

To remove the default value and return to the 'factory default',
specify an empty value, e.g.:

 YLegend[_]:

There can be several instances of setting the default/prepend/append
values in the configuration file. The later setting replaces the
previous one for the rest of the configuration file.
The default/prepend/append values used for a given
keyword/target pair are the ones that were in effect
at the point in the configuration file where the target
was mentioned for the first time.

Example:

 MaxBytes[_]: 1250000
 Target[myrouter.somplace.edu.2]: 2:[e-mail]
 MaxBytes[_]: 8000
 Title[myrouter.somplace.edu.2]: Traffic Analysis for myrouter.somplace.edu IF 2

The default I<MaxBytes> for the target myrouter.somplace.edu.2
in the above example will be 1250000, which was in effect
where the target name myrouter.somplace.edu.2 first appeared
in the config file.

=head1 NoSpaceChar

With PREPEND and APPEND there is normally a space inserted between the local
value and the PRE- or APPEND value. Sometimes this is not desirable. You can
use the I<NoSpaceChar> config option to define a character which can be
mentioned at the end of a $ or ^ definition in order to supress the space.

Example:

  NoSpaceChar: ~
  Target[^]: 1.3.6.1.4.1.482.50.2.4.20.0&1.3.6.1.4.1.482.50.2.4.21.0:get@~
  Target[a]: a.tolna.net
  Target[b]: b.tolna.net
  Target[c]: c.tolna.net
  Target[d]: d.tolna.net

=head1 Some example mrtg.cfg files


=head2 Minimal mrtg.cfg

 WorkDir: /usr/tardis/pub/www/stats/mrtg
 Target[r1]: 2:[e-mail]
 MaxBytes[r1]: 8000
 Title[r1]: Traffic Analysis ISDN
 PageTop[r1]: <H1>Stats for our ISDN Line</H1>


=head2 Cfg for several Routers.

 WorkDir: /usr/tardis/pub/www/stats/mrtg
 Title[^]: Traffic Analysis for
 PageTop[^]: <H1>Stats for
 PageTop[$]: Contact The Chief if you notice anybody<HR>
 MaxBytes[_]: 8000
 Options[_]: growright

 Title[isdn]: our ISDN Line
 PageTop[isdn]: our ISDN Line</H1>
 Target[isdn]: 2:[e-mail]

 Title[backb]: our Campus Backbone
 PageTop[backb]: our Campus Backbone</H1>
 Target[backb]: 1:[e-mail]
 MaxBytes[backb]: 1250000

 # the following line removes the default prepend value
 # defined above

 Title[^]:

 Title[isdn2]: Traffic for the Backup ISDN Line
 PageTop[isdn2]: our ISDN Line</H1>
 Target[isdn2]: 3:[e-mail]


=begin html
<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0>
  <TR>
    <TD WIDTH=63><A ALT="MRTG"
    HREF="http://ee-staff.ethz.ch/~oetiker/webtools/mrtg/mrtg.html"><IMG
    BORDER=0 SRC="mrtg-l.gif"></A></TD>
    <TD WIDTH=25><A ALT=""
    HREF="http://ee-staff.ethz.ch/~oetiker/webtools/mrtg/mrtg.html"><IMG
    BORDER=0 SRC="mrtg-m.gif"></A></TD>
    <TD WIDTH=388><A ALT=""
    HREF="http://ee-staff.ethz.ch/~oetiker/webtools/mrtg/mrtg.html"><IMG
    BORDER=0 SRC="mrtg-r.gif"></A></TD>
  </TR>
</TABLE>
<SPACER TYPE=VERTICAL SIZE=4>
<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0>
  <TR VALIGN=top>
  <TD WIDTH=388 ALIGN=LEFT><FONT FACE="Arial,Helvetica" SIZE=2>
  <A HREF="http://ee-staff.ethz.ch/~oetiker/">Tobias Oetiker</A>
  <A HREF="mailto:[e-mail]">&lt;[e-mail]&gt;</A> 
  and&nbsp;<A HREF="http://www.bungi.com">Dave&nbsp;Rand</A>&nbsp;<A HREF="mailto:[e-mail]">&lt;[e-mail]&gt;</A></FONT>
  </TD>
</TR>
</TABLE>

=end html