This document outlines the various report types that opReports offers; the various source selection mechanisms and their precision is documented on this separate page.
Node Report
The Node Report provides a detailed summary of one node. Node details such as status, sysName, ip address, type, model, uptime, interfaces, location, contact, description, last update, vendor, object name, group role and net and the interface table are presented.
Interfaces and storage items are details if present.
Graphs are provided which details the following: reachability, availability and health, response time, CPU utilisation, number of routes, ip utilisation, IP fragmentation/reassembly (as a % of packets received), buffer utilisation.
Items of note:
- This report cannot be created for more than one node. If your node selection contains more than one node, then the report is created for the first node in your list.
- This report relies directly on NMIS for inline graphs, and therefore won't work unless the configuration item
nmis_host_baseis correctly set (i.e. has the public web address of your NMIS server). - Business Hours reporting is not supported for this report.
- This report cannot be generated in formats other than HTML.
- While it can be saved it is not self-contained (the NMIS graphs are live and created on viewing!), therefore it's primarily of use as an on-demand report for immediate consumption.
Node Health Report
The Node Health report display health-related attributes for all selected nodes for a given period. Attributes displayed are: Status, Device, Availability, Interface Availability, %CPU, 95th% CPU, Max %CPU, CPU Exc., %Mem Free, 95th% Mem Used, Max %Mem Used, %Mem Util, %IO/VIR Mem Free, 95th% IO Mem Used, Max %IO Mem Used, %IO/VIR Mem Util.
The report also includes two columns with the detected (abnormal) Conditions and the recommended Actions.
If you pass this report the option exceptions=true, then only nodes with exceptional conditions present are shown; the default is to show all nodes.
The formulas used for calculation of the reporting conditions can be tuned and adjusted by the user:
The section opreports_rules (in conf/opCommon.nmis in opReports 3.x, or opReports.nmis in version 2.x) defines the threshold values for the following conditions:
Device Availability = Condition: "Device has LOW or VERY LOW availability"
Action: Investigate causes for low availability
Formula used for Calculation:
- Very Low device availability less than 99.9
- Low device availability less than 99.999
Interface Availability = Condition: "Device has LOW or VERY LOW interface availability"
Action: Investigate causes for low interface availability
Formula used for Calculation:
- Very Low interface availability less than 80
- Low interface availability less than 95
CPU Utilisation = Condition: "Device has VERY HIGH, HIGH or MODERATE CPU utilisation"
Action: Investigate causes for CPU utilisation
Formula used for Calculation:
- Very High CPU utilisation: greater than 30%
- High CPU utilisation: greater than 20%
- Moderate CPU utilisation: greater than 12%
If the node has multiple CPUs then the utilisation measure is averaged over all CPUs.
CPU Exceptions
The count of times the CPU utilisation exceeded the "CPU Exception Threshold" of 20%. If the node has multiple CPUs then this is the sum of the exception counts of all CPUs.
Memory Utilisation = Condition: "Device has VERY LOW or LOW main memory free"
Action: Investigate causes for free low main memory
Formula used for Calculation:
- Very Low free main memory less than 10
- Low free main memory less than 25
IO or Virtual Memory Utilisation = Condition: "Device has VERY LOW or LOW IO or Virtual memory free"
Action: Investigate causes for low free IO or Virtual memory
Formula used for Calculation:
- Very Low free main memory less than 10
- Low free main memory less than 25
WAN Report
The WAN report displays the WAN Link performance for selected nodes. As of version 3.0.4, selection by interface is not supported and all interfaces of selected nodes whose network type is "wan" are processed.
Node details displayed are: status, conditions, actions, device, availability and response time.
For each interface on the node, the following are displayed: interface, speed, average utilisation, maximum utilisation, average inbound errors (in %), average outbound errors (in %), average inbound discards (in %), average outbound discards (in %), average inbound utilisation (in %), average outbound utilisation (in %), maximum inbound utilisation (in %), maximum outbound utilisation (in %).
The WAN report health rules are configurable (section opreport_rules) and the report type supports customisable detail levels for the display.
Formula used for Calculation
Maximum and Average input and output utilisation is calculated for the interface. The larger of maximum and average input and output utilisation is used in formula.
Link Availability = Condition: "Router has LOW interface availability"
Action: Investigate carrier for interface problems
Interface availability less than 99.9%
Link Availability = Condition: "Router has VERY LOW interface availability"
Action: Investigate carrier for interface problems
Interface availability less than 95%
Over-utilised Links = Condition: "WAN link has VERY HIGH utilisation"
Action: Investigate WAN Upgrade Urgently
Average link utilisation is above 80% average utilisation
Over-utilised Links = Condition: "WAN link has HIGH utilisation"
Action: Investigate WAN Upgrade
Average link utilisation is above 65% average utilisation
Links Considered Normal = Condition: "WAN link has acceptable utilisation"
Action: WAN utilisation is OK
Average link utilisation is less than 65%
Input and/or Output Errors = Condition: "WAN link has input/output errors"
Action: Investigate cause of interface errors, likely transmission
Error rates higher than 1% of input or output packets
Input and/or Output Discards = Condition: "WAN link has input/output discards"
Action: Investigate cause of interface discards, likely related to QoS or buffer overruns.
Discard rates higher than 1% of input or output packets
QoS Report
The QoS report is intended to provide an overview of the Qality of Service configuration and utilisation of the selected nodes.
Rules
To assist in the assimilation of the data, a few simple rules have been applied to the statistics to assist with highlighting some possible problem areas.
Queue Drop
This condition indicates that a QoS Policy is being exceeded and packets in this class have been dropped. It may or may not be impacting applications, depending on how they handle packet loss. For example, HTTP will generally handle packet loss with no problems, while voice and video do not suffer packet loss very well at all.
If an interface utilisation is greater than 0% input and 0% output;
AND DropPkt is greater than 1 packet per second;
THEN this class is highlighted yellow.
Class Under Utilised
This condition indicates that the QoS class was configured to be used for traffic, and there are VERY low levels of traffic in that class. It might be possible to update the QoS policy allocating some of this bandwidth to other classes.
If an interface utilisation is greater than 0% input and 0% output;
AND the Policy Percent is greater than 0 percent;
AND PrePolicyUtil is less than 1 percent;
THEN this class is highlighted yellow.
Class Utilisation Exceeding Policy
This condition indicates that QoS class was configured for a certain bandwidth and the traffic levels have exceeded the configured policy. This may not be a problem, depending on QoS configuration, traffic may be being forwarded or discarded, if necessary increase the bandwidth allocated to this class.
If an interface utilisation is greater than 0% input and 0% output;
AND PrePolicyUtil exceeds the classes configured bandwidth Percent;
THEN this class is highlighted yellow.
Uptime Report
The uptime repors provides an overview of recently restarted devices, as well as very long running ones.
The configuration items uptime_shortest_days (default 7) and uptime_longest_days (default:365) define which nodes should be selected for display.
Response Time Report
The Response Time report tabulates the selected nodes in descending order of their average response time. Besides the average and maximum measurements, the report also shows the 95th percentile of the response time. These readings are in milliseconds.
Response Time Exceptions
This column shows the number of times a device's response time has exceeded the exception threshold during the reporting period. This threshold is configurable (property response_exception_threshold), and its default value is 10 ms.
Interface Utilisation Report
The interface utilisation report shows the interface utilisation statistics for one or more interfaces. By default it will display the averages for input, output, combined and higher-of-in-and-output bandwidth utilisation, as well as exception counts and cumulative exception period.
Exceptions are defined as any of the utilisation readings rising above option util_threshold (default: 80%). The exception period is defined as all the intervals with over-threshold readings. In addition to those raw readings, the labelling of an interface as in exceptional or normal state is controlled by option util_threshold_mincount (default: 1), which defines how many exceptions have to be observed before the interface is labelled "bad".
This report can be further adjusted with these options:
- Option
show_threshold(default: true)
If set to false, no thresholds are shown; instead the bandwidth, average traffic and average utilisation are presented (plus a shortened report period column). - Option
show_only_util(default: false)
Ifshow_tresholdis false, and ifshow_only_utilis set to true, then only bandwidth and average utilisation are shown (ie. average traffic is omitted).
CPU Report
This report shows the average CPU utilisation for Cisco devices, for both 1-minute and 5-minute averages.
Free Memory Report
This report shows the free memory statistics for Cisco devices.
Memory Pool Report
This report shows the memory pool statistics for Cisco devices.
Traffic Usage Report
This report displays the cumulative traffic usage figures for one or more interfaces. The measurements that are displayed include the node and the interface, and total traffic inbound, outbound and combined (all in Gigabyptes), plus a shortened report period column.
Traffic Summary Report
The traffic summary report provides a specialized report of categorized and grouped traffic figures for any number of nodes and interfaces.
This report requires a node_intf_type input file that provides nodes, interfaces and "type" for grouping (see How to select Nodes (and Interfaces) for reporting).
The interfaces are grouped both by their "type" attribute and their average combined utilisation (into categories Low=<45%, Minor=<80%, and Major=>80%).
The report consists of
- a summary table, which displays for each "type" category the number of interfaces in each utilisation category (and a total)
- and a details table for each combination of "type" and utilisation categories.
The details table shows the node and interface, the input and output interface speeds, the average combined traffic and the average combined utilisation, plus a shortened period column.
For output formats HTML and CSV these tables are shown one after the other. For XLSX, the tables are put on separate worksheets (within a single spreadsheet file).
Node Availability Report
New in version 3.0.8. Please note that the precise content of this report is subject to change.
This report provides an overview of nodes' reachability and down time for a given period (which may include business days and/or business hours filtering).
For each selected node the report shows the percentage of time the node was up, down, or partially reachable (i.e. up but packet loss was encountered), plus the percentage of time where NMIS couldn't collect any reachability information whatsoever, as well as the cumulative periods for up, down and periods with missing data.
From version 3.0.10 on this report offers optional embedded graphs of each node's availability. The default choice is to include graphs but you can change that using the report option embedgraphs. In the GUI this option is named "Include Embedded Graphs". The contents of the graph are not configurable, but the desired size can be set using the configuration option opreports_embedded_graph_size (default: 600 pixels wide by 150 pixels high).
Interface Capacity Report
New in version 3.0.8. Please note that the precise content of this report is subject to change.
The interface capacity report displays a comparison between configured interface speeds and observed actual bandwidth figures.
For each selected interface, it shows the configured input and output speeds, the observed maxima of input and output bandwidth for the report period, and the 95th percentile of the interface utilisation.
Before version 3.0.14, the 95th percentile for combined interface utilisation was shown (Combined utilisation in this report means the set of averages of each input and output utilisation reading). From 3.0.14 onwards, you can select from three options: the 95th of combined utilisation, two separate columns for 95th of inpunt and output utilisation, or three separate columns for 95th of input, output and combined utilisation.
From version 3.0.10 on this report offers optional embedded graphs of each interface's capacity. These graphs show the observed input and output bandwidth (input in green, output in blue), and the higher of the configured in and out speeds as a red warning line. If the configured input and output speeds are identical, the 95th percentile of the combined interface utilisation is also shown as a dotted line.
The default choice is to include graphs but you can change that using the report option embedgraphs. In the GUI this option is named "Include Embedded Graphs". The graph contents are not configurable, but the graph size can be adjusted using the configuration option opreports_embedded_graph_size (default: 600 x 150 pixels).
Traffic Snapshot Report
New in version 3.0.14.
The snapshot report type produces a table of interface utilisation versus interface capacity for one or more groups of interfaces, with configurable coloring of the utilisation column. The utilisation data is computed and presented for each group of interfaces. Besides that, for each interface a (selectable) NMIS graph is included as well.
The groups of Interfaces are selected exclusively from opCharts Business Service definitions, hence opCharts is required to be installed on the same machine for this report type.
The report type is somewhat geared towards XLSX outputs, and supports multiple pages where each page definition contains its own list of sources, coloring rules, measurement and graph options; each page definition results in a separate XLSX worksheet. For the CSV output type, only the utilisation tables are present. In HTML output, all the logical pages are included on one HTML page, but visually separate in their own sections.
The snapshot report produces tables of interface utilisation versus interface capacity for one or more groups of nodes and interfaces, with configurable coloring rules for each group (based on utilisation ratio). For each interface a (selectable) NMIS graph is embedded as well.