Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents


Requirements


  • Warning

    Exercise caution while editing /path/to/omk/conf/opCommon.json; if a syntax error is induced all OMK applications will cease to function.

    Check out How to make configuration changes to opCommon.nmis and other files for some more details on best practices for modifying the configuration file.

    opReports 4 requires that configuration item omkd → omkd_url_base in /path/to/omk/conf/opCommon.json be set to the IP address or FQDN of the server,
    and be prepended by the  HyperText Transfer Protocol ( http:// or https:// ),
    for the Monitored Services Report to function correctly.

  • opReports requires that a licensed opCharts be installed and that the opCharts EULA be accepted for the Monitored Services Report to function correctly.


Introduction

New in version 3.1.10, the Monitored Services Report can only be configured via View >> Report Schedules >> Create New Report and cannot be run on-demand.

This report provides an overview of monitored services availability and downtime both for a given period (which may include business days and/or business hours filtering) and as a percentage of the given period. 
For each selected monitored service the report shows the percentage of time the monitored service was up, down, or partially reachable (i.e. up but packet loss was encountered) as well as the cumulative response time as measured by NMIS while monitoring the service.


opreports_ms_availability_strict (default: false)

There is a configuration setting 'opreports_ms_availability_strict' in /path/to/omk/conf/opCommon.nmis which controls the behavior used in calculating availability in the report where NMIS does not contain a particular record for a monitored service.
The default setting is 'opreports_ms_availability_strict' => 'false' which can be interpreted as 'monitored service is not down unless NMIS provides an explicit record indicating service was down'.
The setting 'opreports_ms_availability_strict' => 'true' can be interpreted as 'monitored service is down where NMIS does not provide  a record for the monitored service OR where NMIS provides an explicit record indicating service was down'.

Strict Availability Mode: 0|1 is written to the headings of the generated report to signify which  'opreports_ms_availability_strict' setting was used to generate the report.


Embedded Graphs

This report offers optional embedded graphs of each monitored services availability and response time by default, and custom graphs as configured in the NMIS model file for the monitored service. The default choice is to include both the default graphs and custom graphs, but you can change that using the report options Include Embedded Graphs and Include Custom Graphs. The contents of the graph are not configurable, but the desired default size can be set using the configuration option opreports_embedded_graph_size_small (default: 300 pixels wide by 75 pixels high). The width of each graph is reduced dynamically starting from the default size when Custom Graphs are included in the report, but is never less than 50% of the default size. This behavior was implemented as reducing the width of the graphs dynamically by up to 50% was found to improve the viewability of all graphs with less chance of horizontal scrolling, and has minimal effect on interpreting the contents of each graph.


Setup:

First Choose Monitored Services Report under View >> Report Schedules >> Create New Report >> General >> Type:


Read How to select Nodes (and Interfaces) for reporting for information on how to select nodes for Monitored Services Report using the Node Selection dropdown.

Monitored Services can then be selected at Sources >> Monitored Services Selection,which defaults to 'All Monitored Services'.
'Select from Monitored Services'  allows one to select one or more services from a presented listbox to include in the report.
'from Monitored Services List File'  allows one to select a file which contains a list of Monitored Services, one per line, to include in the report:



Example Screenshot - note this report was generated with 'Strict Availability Mode: 0' as signified in the headings: