Blame doc/mrtg-rrd.1

Packit 667938
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
Packit 667938
.\"
Packit 667938
.\" Standard preamble:
Packit 667938
.\" ========================================================================
Packit 667938
.de Sp \" Vertical space (when we can't use .PP)
Packit 667938
.if t .sp .5v
Packit 667938
.if n .sp
Packit 667938
..
Packit 667938
.de Vb \" Begin verbatim text
Packit 667938
.ft CW
Packit 667938
.nf
Packit 667938
.ne \\$1
Packit 667938
..
Packit 667938
.de Ve \" End verbatim text
Packit 667938
.ft R
Packit 667938
.fi
Packit 667938
..
Packit 667938
.\" Set up some character translations and predefined strings.  \*(-- will
Packit 667938
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
Packit 667938
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
Packit 667938
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
Packit 667938
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
Packit 667938
.\" nothing in troff, for use with C<>.
Packit 667938
.tr \(*W-
Packit 667938
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
Packit 667938
.ie n \{\
Packit 667938
.    ds -- \(*W-
Packit 667938
.    ds PI pi
Packit 667938
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
Packit 667938
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
Packit 667938
.    ds L" ""
Packit 667938
.    ds R" ""
Packit 667938
.    ds C` ""
Packit 667938
.    ds C' ""
Packit 667938
'br\}
Packit 667938
.el\{\
Packit 667938
.    ds -- \|\(em\|
Packit 667938
.    ds PI \(*p
Packit 667938
.    ds L" ``
Packit 667938
.    ds R" ''
Packit 667938
.    ds C`
Packit 667938
.    ds C'
Packit 667938
'br\}
Packit 667938
.\"
Packit 667938
.\" Escape single quotes in literal strings from groff's Unicode transform.
Packit 667938
.ie \n(.g .ds Aq \(aq
Packit 667938
.el       .ds Aq '
Packit 667938
.\"
Packit 667938
.\" If the F register is turned on, we'll generate index entries on stderr for
Packit 667938
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
Packit 667938
.\" entries marked with X<> in POD.  Of course, you'll have to process the
Packit 667938
.\" output yourself in some meaningful fashion.
Packit 667938
.\"
Packit 667938
.\" Avoid warning from groff about undefined register 'F'.
Packit 667938
.de IX
Packit 667938
..
Packit 667938
.nr rF 0
Packit 667938
.if \n(.g .if rF .nr rF 1
Packit 667938
.if (\n(rF:(\n(.g==0)) \{
Packit 667938
.    if \nF \{
Packit 667938
.        de IX
Packit 667938
.        tm Index:\\$1\t\\n%\t"\\$2"
Packit 667938
..
Packit 667938
.        if !\nF==2 \{
Packit 667938
.            nr % 0
Packit 667938
.            nr F 2
Packit 667938
.        \}
Packit 667938
.    \}
Packit 667938
.\}
Packit 667938
.rr rF
Packit 667938
.\"
Packit 667938
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Packit 667938
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
Packit 667938
.    \" fudge factors for nroff and troff
Packit 667938
.if n \{\
Packit 667938
.    ds #H 0
Packit 667938
.    ds #V .8m
Packit 667938
.    ds #F .3m
Packit 667938
.    ds #[ \f1
Packit 667938
.    ds #] \fP
Packit 667938
.\}
Packit 667938
.if t \{\
Packit 667938
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
Packit 667938
.    ds #V .6m
Packit 667938
.    ds #F 0
Packit 667938
.    ds #[ \&
Packit 667938
.    ds #] \&
Packit 667938
.\}
Packit 667938
.    \" simple accents for nroff and troff
Packit 667938
.if n \{\
Packit 667938
.    ds ' \&
Packit 667938
.    ds ` \&
Packit 667938
.    ds ^ \&
Packit 667938
.    ds , \&
Packit 667938
.    ds ~ ~
Packit 667938
.    ds /
Packit 667938
.\}
Packit 667938
.if t \{\
Packit 667938
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
Packit 667938
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
Packit 667938
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
Packit 667938
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
Packit 667938
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
Packit 667938
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
Packit 667938
.\}
Packit 667938
.    \" troff and (daisy-wheel) nroff accents
Packit 667938
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
Packit 667938
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
Packit 667938
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
Packit 667938
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
Packit 667938
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
Packit 667938
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
Packit 667938
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
Packit 667938
.ds ae a\h'-(\w'a'u*4/10)'e
Packit 667938
.ds Ae A\h'-(\w'A'u*4/10)'E
Packit 667938
.    \" corrections for vroff
Packit 667938
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
Packit 667938
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
Packit 667938
.    \" for low resolution devices (crt and lpr)
Packit 667938
.if \n(.H>23 .if \n(.V>19 \
Packit 667938
\{\
Packit 667938
.    ds : e
Packit 667938
.    ds 8 ss
Packit 667938
.    ds o a
Packit 667938
.    ds d- d\h'-1'\(ga
Packit 667938
.    ds D- D\h'-1'\(hy
Packit 667938
.    ds th \o'bp'
Packit 667938
.    ds Th \o'LP'
Packit 667938
.    ds ae ae
Packit 667938
.    ds Ae AE
Packit 667938
.\}
Packit 667938
.rm #[ #] #H #V #F C
Packit 667938
.\" ========================================================================
Packit 667938
.\"
Packit 667938
.IX Title "MRTG-RRD 1"
Packit 667938
.TH MRTG-RRD 1 "2018-07-13" "2.17.7" "mrtg"
Packit 667938
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
Packit 667938
.\" way too many mistakes in technical documents.
Packit 667938
.if n .ad l
Packit 667938
.nh
Packit 667938
.SH "NAME"
Packit 667938
mrtg\-rrd \- How to use RRDtool with MRTG
Packit 667938
.SH "SYNOPSIS"
Packit 667938
.IX Header "SYNOPSIS"
Packit 667938
After using \s-1MRTG\s0 for some time you may find some limitations, mostly in the
Packit 667938
areas of performance and graphing flexibility. These are exactly the areas
Packit 667938
addressed by RRDtool. To learn more about RRDtool check out its website on
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& http://oss.oetiker.ch/rrdtool
Packit 667938
.Ve
Packit 667938
.SH "RRDTOOL INTEGRATION"
Packit 667938
.IX Header "RRDTOOL INTEGRATION"
Packit 667938
When using mrtg with RRDtool you are replacing \fIrateup\fR with the
Packit 667938
RRDtool perl module \fIRRDs.pm\fR. To enable RRDtool support in mrtg
Packit 667938
you have to add the line
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& LogFormat: rrdtool
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
to your mrtg config file.
Packit 667938
.PP
Packit 667938
\&\s-1MRTG\s0 needs access to both the RRDtool perl module \fBRRDs.pm\fR and to the
Packit 667938
\&\fBrrdtool\fR executable.
Packit 667938
.PP
Packit 667938
If these two items are not installed in locations where perl can find them
Packit 667938
on its own, then you can use the following two parameters to supply the
Packit 667938
appropriate directories.
Packit 667938
.PP
Packit 667938
For the location of the \fBrrdtool\fR executable you put
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& PathAdd: /usr/local/rrdtool/bin/
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
or
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& PathAdd: c:\errdtool\ebin
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
For the location of the perl module it would be:
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& LibAdd: /usr/local/rrdtool/lib/perl/
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
or
Packit 667938
.PP
Packit 667938
.Vb 1
Packit 667938
\& LibAdd: c:\errdtool\ebin\elib\eperl
Packit 667938
.Ve
Packit 667938
.PP
Packit 667938
When you have made this modification to the configuration file, several
Packit 667938
things will happen when you run mrtg again with the new config file:
Packit 667938
.IP "1." 4
Packit 667938
mrtg will take all your old \f(CW\*(C`.log\*(C'\fR files and \fBconvert\fR them to \f(CW\*(C`.rrd\*(C'\fR
Packit 667938
format. (The \f(CW\*(C`.log\*(C'\fR files don't get touched in the process, so if things
Packit 667938
don't work out they are still there.)
Packit 667938
.IP "2." 4
Packit 667938
mrtg will use \fBrrdtool\fR to update its databases. These will have a new format
Packit 667938
called \fIrrd\fR which is totally different than the native \fIlog\fR format of
Packit 667938
the classic mrtg.
Packit 667938
.IP "3." 4
Packit 667938
mrtg will \fBnot\fR create any webpages of graphs anymore.
Packit 667938
It will only query the routers for traffic information and update its \fIrrd\fR
Packit 667938
databases.
Packit 667938
.PP
Packit 667938
The advantage of whole thing is that the mrtg will become \fBmuch\fR
Packit 667938
faster. Expect the runtime to drop to 20% of the previous value. (I would like
Packit 667938
to get some feedback on this from folks with large installations.)
Packit 667938
.PP
Packit 667938
Mind you, though, while the logging process of RRDtool is \fBvery\fR fast, you
Packit 667938
are also gaining some time by neither creating graphs nor updating webpages.
Packit 667938
The idea behind this is that it is more efficient to create
Packit 667938
graphs and webpages on demand by using a cgi script.
Packit 667938
.PP
Packit 667938
At the moment there is no \fBofficial\fR script to do this, but two
Packit 667938
contributers have created such scripts:
Packit 667938
.IP "One4All aka 14all.cgi" 4
Packit 667938
.IX Item "One4All aka 14all.cgi"
Packit 667938
This was the first program to take over the webpage creation and graphing task.
Packit 667938
It has been developed by Rainer Bawidamann
Packit 667938
rainer.bawidamann@web.de. You can find a copy 
Packit 667938
on Rainers website: http://my14all.sourceforge.net/
Packit 667938
The program comes with its own documentation
Packit 667938
.IP "\fBrouters2.cgi\fR" 4
Packit 667938
.IX Item "routers2.cgi"
Packit 667938
This is another \s-1CGI\s0 frontend for mrtg running with rrdtool. The main difference between this and 14all is
Packit 667938
that the web pages it creates are much more stylish than the ones from mrtg, plus they support User
Packit 667938
Defined summary graphs and different levels of Authentication and Authorisation. This has been written by
Packit 667938
Steve Shipway (steve@steveshipway.org). You obtain a copy, and find a forum and demonstration system at
Packit 667938
http://www.steveshipway.org/software/
Packit 667938
The program comes with its own installation instructions and install script.
Packit 667938
.IP "\fBmrtg-rrd\fR" 4
Packit 667938
.IX Item "mrtg-rrd"
Packit 667938
The mrtg-rrd script is a CGI/FastCGI application by Jan \*(L"Yenya\*(R" Kasprzak for
Packit 667938
displaying \s-1MRTG\s0 graphs from data in the RRDtool format. It is an intended
Packit 667938
replacement for the 14all.cgi script. It can make your monitoring system
Packit 667938
faster because \s-1MRTG\s0 does not have to generate all the \s-1PNG\s0 files with graphs
Packit 667938
every 5 minutes or so. Instead of this the graphs are generated on-demand
Packit 667938
when the user wants to see them. http://www.fi.muni.cz/~kas/mrtg\-rrd/
Packit 667938
.SH "FUTURE"
Packit 667938
.IX Header "FUTURE"
Packit 667938
Just as a side note: \s-1MRTG\-3\s0 will be based entirely on rrdtool technology.
Packit 667938
But don't wait for it ... get going \fBnow\fR!
Packit 667938
.SH "AUTHOR"
Packit 667938
.IX Header "AUTHOR"
Packit 667938
Tobias Oetiker <tobi@oetiker.ch>