Starting with version 2.34.3 1 opReports supports user-defined detail levels for the WAN reports, and this document briefly describes how to configure this feature.
...
Option Name | Option Description |
---|---|
ResponseTime | shows the system's response time |
InOutErrorDiscards | includes packet discard and error statistics |
AvgMaxInOutBits | includes average and maxima of the data transfer rates |
ErrPct | include maxima of input and output error percentages |
ErrExc | include number of exceptions above |
DiscPct | include maxima of input and output packet discard percentages |
DiscExc | include number of exceptions above wan_discards_exception_threshold |
Util95 | include the 95th percentile of input and output interface utilisation |
UtilExc | include number of exceptions above wan_utilwanutil_exception_threshold |
To define your own detail level, open conf/opCommon.nmis
(for opReports 3.X, or conf/opReports.nmis
for opReports 2.x) in an editor and look for the block named ''report_wan_levels
", which should look like this:
Code Block | ||
---|---|---|
| ||
'report_wan_levels' => { '1' => { "name"=>"Default", "description" => "The Default report contains a modest default level of details.", "extras" => "ResponseTime,InOutErrorDiscards,AvgMaxInOutBits", }, '2' => { "name"=>"Full Detail", "description" => "The Full Detail report includes all known options.", "extras" => "ResponseTime,InOutErrorDiscards,AvgMaxInOutBits,ErrPct,ErrExc,DiscPct,DiscExc,Util95,UtilExc", }, }, |
Simply copy one of the default existing definition block blocks and paste it after just before the first last closing curly brace, then amend the level definition: First your custom detail level needs to be given an index number and name which define the order and entry text on the menu page. Second, the description text for all report levels will be shown in the right column on the menu page, so it should be kept short. Finally, the entry headed extras
defines what extra columns are to be included in your report. Insert only option names from the table above and separate them by single commas. The order of columns in the report is fixed and how you order your extras
is not relevant.
...
Code Block | ||
---|---|---|
| ||
'wan_error_exception_threshold' => 51.0, 'wan_discards_exception_threshold' => 1.0, 'wanwanutil_util_exception_threshold' => 33.360, |
The three values above are given in percent and specify the thresholds for counting exceptions in terms of packet errors, packet discards and interface utilisation percentages, respectively.
Your In opReports 2.x your new report detail levels will show up on the Reporting Option Menu page immediatly after you save the configuration file. To use these detail levels from the command line simply add the opReports.nmis
fileargument level=N
to your invocation of opReports.pl, with N
being the index of the desired detail level.
For opReports 3.x you need to restart the Opmantek Web Service (with sudo service omkd restart
or similar) to see them in the report creation GUI; the command line tool opreports-cli.pl uses the option report_wan_level=<name or number>
to select the level.