This document describes the configuration file syntax of the cgi script 14all.cgi.
14all.cgi displays web pages and graphics from rrdtool files. In most cases it will be used together with MRTG.
14all uses roughly the same configuration file syntax as MRTG. In fact in a standard installation 14all and MRTG will use the same config file. 14all version 1.1 even uses the configuration file parser of MRTG.
This file is an addition to the documentation of MRTG. Please look there first to get an overall picture.
The general format is:
A config line can have one of the following formats:
Setting: Value
This is used for global settings. This includes WorkDir, HtmlDir,
ImageDir, LogDir, LogFormat, Language,
Interval, IconDir, WriteExpires, Refresh, UseRRDTool,
14all*Columns, 14all*Background, 14all*RRDToolLog, 14all*ErrorPic,
14all*GraphErrorsToBrowser
Setting[target]: value
This is used for the target settings. This includes Target,
RouterUptime, MaxBytes, MaxBytes1, MaxBytes2, Title,
PageTop, AddHead, AbsMax, Unscaled, WithPeak,
Suppress, Directory, XSize, YSize, Options, Kilo,
kMG, Background, Ylegend, ShortLegend, Legend1,
Legend2, Legend3, Legend4, LegendI, LegendO, XZoom,
YZoom, XScale, YScale, YTics, YTicsFactor, Colours,
Step, Timezone, Weekformat, TreshDir, ThreshMinI,
ThreshMaxI, ThreshProgI, ThreshProgOKI, ThreshMinO,
ThreshMaxO, ThreshProgO, ThreshProgOKO,
14all*Logarithmic, 14all*GraphTotal, 14all*DontShowIndexGraph,
14all*IndexGraphSize
To distinguish these settings from the globals they will be written as
Target[] in this document (i.e. with []).
Some settings share the syntax of the values:
WriteExpires, UseRRDTool, 14all*GraphErrorsToBrowser,
14all*Logarithmic[], 14all*GraphTotal[], 14all*DontShowIndexGraphp[],
14all*stackgraph.
The values ``0'' (zero) and ``no'' will be interpreted as false, every
other value counts as true. If the setting isn't found in the config
it defaults to 0.
(UseRRDTool is only available for 14all v1.0. Use LogFormat with
version v1.1)
Columns, Interval, Refresh,
MaxBytes, MaxBytes1, MaxBytes2, AbsMax, XSize, YSize,
YTics, Kilo, ThreshMinI, ThreshMaxI, ThreshMinO,
ThreshMaxO.
Kilo is special as it only accepts the values 1000 and 1024.
WorkDir takes precedence over the other three, they
are only used when WorkDir isn't given.
14all uses LogDir to look for the rrd files. It writes the graph files
to ImageDir (or /tmp if this isn't writeable).
Interval setting. If Refresh is set to a
number (that value will be used as refresh interval (unit: seconds)).
(14all v1.1 ignores this setting and emits the expire header all the time).
LogFormat.
This tells MRTG to use rrdtool instead of it's own rateup program to log the data. MRTG won't create any graphs or web pages any more with this option set.
If you want to test rrdtoll/14all on some targets first please
check the per-target setting UseRRDTool[]
The global option UseRRDTool can have the value columns: 2 where
the number confiures how many columns will be used for the group
(directory) pages.
UseRRDTool.
This setting selects whether MRTG uses rateup or rrdtool to store the measured data. 14all needs this to be set to rrdtool.
This file can get very big - only enable it if you want to debug 14all or find out why something doesn't work.
When 14all encounters an error while creating a graph it displays an error picture. The default error picture contains the text ``error: cannot create graph''. If this option is set the given file will be sent as error picture.
The error message might expose internal information about the installation or configuration to WWW clients. Be careful when setting this.
The targets have to be specified between the brackets []
14all uses this setting (and MaxBytes1, MaxBytes2, AbsMax) to
calculate the usage percentage (if option nopercent isn't set) and to set
the upper bound of the graph if unscaled is set.
WorkDir (ImageDir/LogDir)
where MRTG will store the log files. 14all will group the targets of one
directory in one web page. The start page will contain links to the
directories.
MaxBytes. The given graphs will be displayed unscaled.
MRTG allows this to be set to 'd' too but you will get strange graphs so don't do it.
Unscaled.
UseRRDTool[]: graphsize ...: ... (only with 14all v1.0).
YLegend[] - The Y-axis lable of the graph.
| ShortLegend[] - The unit string used for Max, Average and Current (default | |
| b/s). |
other settings - The strings for the colour legend.
global option with the same name)
This setting is only available for 14all v1.0!
This setting has two purposes:
1. You can configure MRTG to use rrdtool on a per-target basis.
| 2. MRTG will stop if it finds any unknown config settings. UseRRDTool is a | |
| workaround to provide additional settings for 14all without the need to | |
| change MRTG every now and then. |
See below for syntax and options.
14all recognizes several mrtg options. Please look into the MRTG
documentation if you want to find more about all of these. The options are
separated by comma or space. An example:
Options[target]: bits, perminute
14all v1.0 makes one difference to MRTG: If there are several Options
lines MRTG uses only the options from the last and ignores the rest (the last
line overrides the other). 14all merges the options from all of the options
lines.
The options recognized by 14all are:
bits changes
this to bits/sec. This changes the Y legend too.
unknaszero the graph will show a zero (0) value
for unknown values.
This paragraph applies to 14all v1.0 only!
The settings UseRRDTool[] can have additional settings with a special syntax.
The main difference is that every ``file line'' is now a ``config line''.
An example:
UseRRDTool[example]:
# name start end maxage
graph daily: -2000m now 300
# index pictures: size and range
graphsize daily.s: 250 100
graph daily.s: -1250m now 300
indexgraph: daily.s
logarithmic: yes
In the example are six (6) settings: ``showgrahs'', ``graph daily'', ``graphsize daily.s'', ``graph daily.s'', ``indexgraph'', ``logarithmic''. Option and value are separated with a ``:''. You cannot break a 14all extended option into several lines.
The possible settings:
rrdgraph documentation). The third value says how long this
graph is valid (this value will be used for the expire/refresh http headers).
<graphname> is any name you like. 14all only uses the graphs ``daily'', ``weekly'', ``monthly'', ``yearly'' in the html target pages and ``daily.s'' as indexgraph. 14all will happily create any other graph if someone calls it with appropriate ``png='' cgi parameter.
graphsize daily: 500 150
graphsize: 400 100
Version 1.1 of 14all uses a different way for additional configuration. The extended 14all settings all have the prefix 14all* and have the same syntax as the standard MRTG settings. Look in the list of settings above.