config.pod

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

=for html
<img src="mrtg-ti.gif">

=head1 Multi Router Traffic Grapher -- Configuration File Format

This file is for use with MRTG 2.8.12

Note:

=over 4

=item * 

Keywords must start at the beginning of a line.

=item * 

Lines which follow a keyword line which do start 
with a blank are appended to the keyword line

=item * 

Empty Lines are ignored

=item * 

Lines starting with a # sign are comments.

=back

=head1 Global Configuration 

Workdir specifies where the logfiles and the webpages should 
be created.

Example:

 WorkDir: /usr/tardis/pub/www/stats/mrtg

=head1 Optional Global Parameters

=head2 Refresh

How many seconds apart should the browser (Netscape) be 
 instructed to reload the page? If this is not defined, the 
 default is 300 seconds (5 minutes).

Example:

 Refresh: 600

=head2 Interval

How often do you call mrtg? The default is 5 minutes. If
you call it less often, you should specify it here. This
does two things:

=over 4

=item *

the generated HTML page does contain the right
information about the calling interval ...

=item *

a META header in the generated HTML page will instruct
caches about the time to live of this page .....

=back


In this example we tell mrtg that we will be calling it
every 10 minutes. If you are calling mrtg every 5
minutes, you can leave this line commented out.

Example:

 Interval: 10

=head2 WriteExpires

With this switch mrtg will generate .meta files for CERN
and Apache servers which contain Expiration tags for the
html and gif files. The *.meta files will be created in
the same directory as the other files, so you will have
to set "MetaDir ." and "MetaFiles on"
in your apache.conf or .htaccess file for this to work

NOTE: If you are running Apache-1.2 or later, you can use the mod_expire
to achieve the same effect ... see the file htaccess.txt

Example:

 WriteExpires: Yes

=head2 IconDir

If you want to keep the mrtg icons in some place other than the 
working directory, use the I<IconDir> variable to give its url.

Example:

 IconDir: /mrtgicons/

=head2 LoadMIBs

Load the MIB file(s) specified and make its OIDs available as
symbolic names. For better efficiancy, a cache of MIBs is maintained
in the WorkDir.

Example:

 LoadMIBs: /dept/net/mibs/netapp.mib,/usr/local/lib/ft100m.mib

=head2 Language

Switch output format to the selected Language (At the moment, the values:
danish, french, english, dutch, brazilian, russian, spanish, greek and italian are supported)

Example:

 Language: danish

=head2 UseRRDTool

Setting UseRRDTool to Yes in your mrtg.cfg file enables rrdtool mode. In
rrdtool mode, mrtg relies on rrdtool to do its logging. Graphs and html
pages will be generated on the fly by the 14all.cgi which can be found in
the contrib section together with a short readme ... This feature has been
contributed by [e-mail]. Please check his
website for more information: http://www.uni-ulm.de/~rbawidam/mrtg-rrd/

Example:

 UseRRDTool: Yes

=head2 RunAsDaemon

The RunAsDaemon keyword enables daemon mode operation. The purpose of daemon
mode is that MRTG is launched once and not at regular basis by cron as in
native mode. This behavior saves computing resourses as loading and parsing
of configuration files only hapens once.

Using daemon mode MRTG itself is responible for timing the measurement
intervals. Therfore its important to set the Interval keyword to an
apropiate value.

Note that using daemon mode MRTG should no longer be started from cron by
regular basis as each started process runs forever. Instead MRTG should be
started from the command prompt or by a system startup script.

Also note that in daemon mode restart of the process is required in order to
activate changes in the config file.

Under UNIX, the Daemon switch causes mrtg to fork into background after
checking its config file.

Example

 RunAsDaemon:Yes
 Interval:5

Makes MRTG run as a daemon beginning data collection every 5 minutes

=head1 Configuration for each Target you want to monitor

The configuration keywords I<Target> must be followed by a
unique name. This will also be the name used for the
webpages, logfiles and gifs created for that target.

Note that the I<Target> sections can be auto-generated with
the B<cfgmaker> tool. Check F<readme.html> for instructions.

=head2 Target

With the I<Target> keyword you tell mrtg what it should
monitor. The I<Target> keyword takes arguments in a wide
range of formats:

=over 4

=item * 

The most basic format is "port:community@router"
This will generate a traffic graph for the interface 'port'
of the host 'router' (dns name or IP address)
and it will use the community 'community' (snmp password)
for the snmp query.

Example:

 Target[ezwf]: 2:[e-mail]

=item * 

Sometimes you are sitting on the wrong side of the
link, and you would like to have mrtg report Incoming
traffic as outgoing and vice versa. This can be achieved
by adding the '-' sign in front of the "Target"
description. It flips the incoming and outgoing traffic rates.

Example:

 Target[ezci]: -1:[e-mail]

=item * 

You can also explicitly define the OID to query by using the
following syntax 'OID_1&OID_2:community@router'
The following example will retrieve error counts for input and output
on interface 1.  MRTG needs to graph two variables,
so you need to specify two OID's such as temperature and humidity
or error input and error output.

Example:

 Target[ezwf]: 1.3.6.1.2.1.2.2.1.14.1&1.3.6.1.2.1.2.2.1.20.1:public@myrouter

=item * 

MRTG knows a number of symbolical SNMP variable names.
See the file mibhelp.txt for a list of known names.
One example are the ifInErrors and ifOutErrors.
This means you can specify the above as:

Example:

 Target[ezwf]: ifInErrors.1&ifOutErrors.1:public@myrouter

=item *

Sometimes SNMP interface index can change, like when new interfaces are
added or removed. This can cause all Target entries in your config file
to become wrong by offset, causing MRTG to graphs wrong instances etc.
MRTG supports IP address instead of ifindex in target definition. Then
MRTG will query snmp device and try to map IP address to current ifindex,
You can use IP address in every type of target definition, by adding
IP address of the numbered interface after OID and separation char '/'

Make sure that given IP address is used on your same target router,
your same target router, especially when graphing two different OIDs
and/or interface split by '&' delimiter.

Example:

 Target[ezwf]: /1.2.3.4:[e-mail]
 Target[ezci]: -/1.2.3.4:[e-mail]
 Target[ezwf]: 1.3.6.1.2.1.2.2.1.14/1.2.3.4&/1.2.3.4:public@myrouter
 Target[ezwf]: ifInErrors/1.2.3.4&ifOutErrors/1.2.3.4:public@myrouter


=item *

When the SNMP interface index changes, you can key that interface by its
'Physical Address', sometimes called a 'hard address', which is the SNMP
variable 'ifPhysAddress'.  Internally, MRTG matches the Physical Address from
the *.cfg file to its current index, and then uses that index for the rest of
the session.

You can use the Physical Address in every type of target definition, by adding
the Physical Address after the OID and separation char '!' (analogous to the IP
address option).  The Physical address is specified as either '-' delimited
octets, such as "0a-0-f1-5-23-18" (omit the double quotes) or a string with
exactly two chars per octet such as "0a00f1052318".  Note that there are 6
octets for for ethernet hard addresses but other types of network connections
may differ.

There is a utility 'cfgmaker_phys' that can be used to convert every interface index
or IP addresses to the new Physical Address format, "cfgmaker_phys old.cfg > new.cfg"
or it can be combined with 'cfgmaker' as follows "cfgmaker public@1.2.3.4 |
cfgmaker_phys > new.cfg".  If however you only want to convert some - not all - of the
interfaces, this must be done manually.

Example:

 Target[ezwf]: !0a-0b-0c-0d:[e-mail]
 Target[ezci]: -!0-f-bb-05-71-22:[e-mail]
 Target[ezwf]: 1.3.6.1.2.1.2.2.1.14!0a-00-10-23-44-51&!0a-00-10-23-44-51:public@myrouter
 Target[ezwf]: ifInErrors!0a-00-10-23-44-51&ifOutErrors!0a-00-10-23-44-51:public@myrouter


=for html
<A NAME="Target-SNMP-Parameters"></A>

=item *

In all places where ``community@router'' is accepted, you can add
additional parameters for the SNMP communication using
colon-separated suffixes. The full syntax is as follows:

 community@router[:port[:timeout[:retries[:backoff]]]]

where the meaning of each parameter is as follows:

=over 4

=item port

the UDP port under which to contact the SNMP agent (default: 161)

=item timeout

initial timeout for SNMP queries, in seconds (default: 2.0)

=item retries

number of times a timed-out request will be retried (default: 5)

=item backoff

factor by which the timeout is multiplied on every retry (default: 1.0).

=back

A value that equals the default value can be omitted.  Trailing colons
can be omitted, too.

Example:

  Target[ezci]: 1:[e-mail]:9161::4

This would refer to the input/output octet counters for the interface
with I<ifIndex 1> on I<ezci-ether.ethz.ch>, as known
by the SNMP agent listening on UDP port 9161.  The standard initial
timeout (2.0 seconds) is used, but the number of retries is set to
four.  The backoff value is the default.

=item * 

if you want to monitor something which does not provide
data via snmp you can use some external program to do
the data gathering.

The external command must return 4 lines of output:

=over 4

=item Line 1

current state of the first variable, normally 'incoming bytes count'

=item Line 2

current state of the second variable, normally 'outgoing bytes count'
   

=item Line 3

string (in any human readable format), telling the uptime of the target.

=item Line 4

string, telling the name of the target. 

=back

Depending on the type of data your script returns you
might want to use the 'gauge' or 'absolute' arguments
for the I<Options> keyword.

Example:

 Target[ezwf]: `/usr/local/bin/df2mrtg /dev/dsk/c0t2d0s0`

Note the use of the backticks (`), not apostrophes (')
around the command.

=item * 

You can also use several statements in a mathematical 
expression.  This could be used to aggregate both B channels
in an ISDN connection or multiple T1s that are aggregated
into a single channel for greater bandwidth.
Note the whitespace arround the target definitions.

Example:

 Target[ezwf]: 2:public@wellfleetA + 1:public@wellfleetA
              * 4:public@ciscoF

=back

=head2 RouterUptime

In cases where you calculate the used bandwidth from
several interfaces you normaly don't get the router uptime
and router name displayed on the web page.

If these interfaces are on the same router and the uptime and
name should be displayed nevertheless you have to specify
its community and address again with the I<RouterUptime> keyword.


Example:

 Target[kacisco.comp.edu]: 1:public@194.64.66.250 + 2:public@194.64.66.250
 RouterUptime[kacisco.comp.edu]: public@194.64.66.250

=head2 MaxBytes

The maximum value either of the two variables monitored
are allowed to reach. For monitoring router traffic
this is normally specified in bytes per second this
interface port can carry.

If a number higher than I<MaxBytes> is returned, it is ignored.
Also read the section on I<AbsMax> for further info.
The I<MaxBytes> value is also used in calculating the Y range
for unscaled graphs (see the section on I<Unscaled>).

Since most links are rated in bits per second, you need to divide
their maximum bandwidth (in bits) by eight (8) in order to get
bytes per second.  This is very important to make your
unscaled graphs display realistic information.
T1 = 193000, 56K = 7000, Ethernet = 1250000. The I<MaxBytes>
value will be used by mrtg to decide whether it got a
valid response from the router.

If you need two different MaxBytes values for the two monitored
variables, you can use MaxBytes1 and MaxBytes2 instead of MaxBytes.

Example:

 MaxBytes[ezwf]: 1250000

=head2 MaxBytes1

Same as MaxBytes, for variable 1.

=head2 MaxBytes2

Same as MaxBytes, for variable 2.

=head2 Title

Title for the HTML page which gets generated for the graph.

Example:

 Title[ezwf]: Traffic Analysis for Our Nice Company

=head2 PageTop

Things to add to the top of the generated HTML page.  Note
that you can have several lines of text as long as the
first column is empty.

Note that the continuation lines will all end up on the same
line in the html page. If you want linebreaks in the generated 
html use the '\n' sequence.

Example:

 PageTop[ezwf]: <H1>Traffic Analysis for ETZ C95.1</H1>
   Our Campus Backbone runs over an FDDI line\n
   with a maximum transfer rate of 12.5 megabytes per
   Second.


=head1 Optional Target Configuration Tags


=head2 AddHead

Use this tag like the I<PageTop> header, but its contents
will be added between </TITLE> and </HEAD>.

Example:

 AddHead[ezwf]: <link rev="made" href="mailto:[e-mail]">

=head2 AbsMax 

If you are monitoring a link which can handle more traffic
than the I<MaxBytes> value. Eg, a line which uses compression
or some frame relay link, you can use the I<AbsMax> keyword
to give the absolute maximum value ever to be reached.
We need to know this in order to sort out unrealistic values
returned by the routers. If you do not set I<AbsMax>, rateup
will ignore values higher than I<MaxBytes>.

Example:

 AbsMax[ezwf]: 2500000

=head2 Unscaled

By default each graph is scaled vertically to make the
actual data visible even when it is much lower than
I<MaxBytes>.  With the I<Unscaled> variable you can suppress
this.  It's argument is a string, containing one letter
for each graph you don't want to be scaled: d=day w=week
m=month y=year.  In the example scaling for the
yearly and the monthly graph are suppressed.

Example:

 Unscaled[ezwf]: ym

=head2 WithPeak

By default the graphs only contain the average
values of the monitored variables - normally the
transfer rates for incoming and outgoing traffic.
The following option instructs mrtg to display the peak
5 minute values in the [w]eekly, [m]onthly and
[y]early graph. In the example we define the monthly
and the yearly graph to contain peak as well as average
values.

Examples:

 WithPeak[ezwf]: ym

=head2 Suppress

By default mrtg produces 4 graphs. With this option
you can suppress the generation of selected graphs.
The option value syntax is analogous to the above two options.
In this example we suppress the yearly graph
as it is quite empty in the beginning.

Example:

 Suppress[ezwf]: y

=head2 Directory