Traffic Snapshot Reports

Requirements

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

  opReports 4 requires that configuration item omkd → omkd_base_url in /path/to/omk/conf/opCommon.json be set to the IP address or FQDN of the server for Snapshot Report to function correctly.
  
  

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

Introduction

 The Traffic Snapshot report  requires a deep structure to describe each of its multiple pages.

Each page covers the (interface) members of one or more opCharts Business Services; utilisation data is computed and shown for all members of a business service combined, but graphs are presented  for each interface separately.

Sample report and how to configure

Report-Specific Settings

Multiple Pages for Traffic Snapshot Report

In a schedule file this structure is known as pages, and it is passed to opreports-cli serialised in dot-notation form.

The pages structure must contain a list of page definitions, each with the following  properties:

The options structure supports the following settings:

Level Color Schemes

The coloring rules must be set separately for each page. 
To simplify reuse the schedule editing GUI will let you pick only from existing schemes that are defined in opCommon.nmis: the color level schemes must be attached to the configuration item report_snapshot_levels, and each scheme must have its own key. opReports ships with two example schemes to illustrate this setup.

In both cases (for editing a schedule by hand, or for preparing reusable color schemes in the config), the levels structure must be a deep hash structure, key being the level 'name', each value being a structure with the following properties:

How levels and peak/capacity types interact

The utilisation summary table contains three columns:

• the name of the  Business Service for this group

• the "Peak Utilisation" for the whole group, in bits/second (formatted with suitable unit suffix),

• and the "Capacity" for the whole group, in bits/second.

The "Peak Utilisation" can be the combined sum of utilisation figures across the group, or the utilisation of one "busiest" interface.
The "Capacity" can be the combined sum of capacities across the group, or the capacity of the one "slowest" interface.

Please note that depending on your configuration choices, the displayed Peak can be higher than Capacity (by some orders of magnitude).
For coloring, the utilisation ratio is computed as peak divided by capacity; this can be above 1.0 (or 100%) as per the caveat above.

The peak and capacity options other than combined are mainly meant for business services that represent identical pairs of interfaces each, one active, one standby; in all other case the caveat above applies.

The Peak Utilisation column is colored according to the levels option: the first level whose threshold is strictly lower than the utilisation ratio is the one setting the color.
E.g. with a ratio 0.0 or 0% (an idle interface group) and level thresholds -1, 25 and 75, the level with threshold -1 will be controlling the color. If the ratio was 0.74 or 74%, the middle level would win, and only if the ratio was above 0.75 or 75% would the last level be involved in coloring.

Here is an  complete example Snapshot Report Schedule in JSON form:

{
    "active": false,
    "description": "an example weekly snapshot report",
    "type": "snapshot",
    "outputdir": "/usr/local/omk/var/reports",
    "start": "mon 00:00",
    "end": "sun: 24:00",
    "frequency": "weekly",
    "formats": {
        "csv": true,
        "xlsx": true,
        "html": true
    },
    "options": {
        "peak_type": "combined",
        "capacity_type": "combined"
    },
    "pages": [{
        "business_services": ["first service", "second service"],
        "options": {
            "title": "this is page one",
            "graph_order": "same_row",
            "graph": "abits",
            "summary_title": "this is summary one",
            "column_heading": "Links on page one",
            "levels": {
                "low": {
                    "color": "green",
                    "description": "low util",
                    "threshold": -1
                },
                "high": {
                    "color": "red",
                    "description": "high util",
                    "threshold": 50
                }
            }
        }
    }, {
        "options": {
            "graph": "autil",
            "summary_title": "this is summary two",
            "column_heading": "Other Intfs",
            "title": "page two",
            "graph_order": "same_column",
            "levels": {
                "boring": {
                    "color": "#00ff00",
                    "description": "30-60%",
                    "threshold": 30
                },
                "third": {
                    "description": "1-30%",
                    "color": "#008000",
                    "threshold": 1
                },
                "attic": {
                    "color": "#ffa31a",
                    "description": "above 80%",
                    "threshold": 80
                },
                "ground": {
                    "color": "#004d00",
                    "description": "under 1%",
                    "threshold": -1
                },
                "balcony": {
                    "threshold": 60,
                    "color": "#c6ff1a",
                    "description": "60-80%"
                }
            }
        },
        "business_services": ["another business service", "and one more with more intfs", "and maybe a last one, too"]
    }]
}