| Table of Contents |
|---|
Introduction
...
| Option | Description |
|---|---|
| show_threshold | Default: true. If this is false, then no over threshold counts and exceptions are shown. Instead the interface bandwidths, traffic, utilisation and short report period are shown. |
| show_only_util | Default: false. Ignored if show_threshold isn't false. If this is set to true, then opReports omits the bandwidth and traffic columns and shows only the utilisation (and short period). |
| util_threshold | Default: 80 (%). Defines the level of utilisation above which it counts as exception. |
| util_threshold_mincount | Default: 1. How often the interface utilisation has to be above the threshold value for the interface to be flagged as in exceptional state. |
The Traffic Snapshot report recognizes the following two options:
| Option | Description |
|---|---|
peak_type | One of combined, busiest_bits or busiest_util. Default is combined.Combined: The peak utilisation for the interface group is defined as the sum of all involved interfaces' traffic. Busiest by Bits: The peak utilisation is sourced from the one interface with the highest traffic figure. Busiest by Utilisation: The peak utilisation is sourced from the one interface with the highest ratio of traffic to configured interface capacity. |
capacity_type | One of |
Report-Specific Settings
Multiple Pages for Traffic Snapshot Report
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.
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:
| Property | Description |
|---|---|
business_services | A list of business service names that should be shown on this page. Required. Ordering is relevant. |
options | A hash sub-structure with report options that are specific to this one page. |
The options structure supports the following settings:
| Per-Page Options Property | Description |
|---|---|
title | The title for this report page. Optional; if not present "Page <N>" is used. |
summary_title | The summary title is shown above the utilisation summary table. Optional; if not present "Utilisation Summary" is used. |
column_heading | The value of this property is used as table column heading for the business service column in the summary table. Optional; if not present, "Interfaces" is used. |
graph | The name of the NMIS graph to produce for each selected interface. Required. Note that the "short name" of the graph is to be used, e.g. "autil", not "Interface Utilisation including Availability". |
graph_order | The graphs for all members of one business service group will be arranged in the selected order. |
levels | A hash sub-structure that describes the desired coloring rules for this page, based on utilisation ratio. Optional; if not present, then the levels from the global configuration option report_summary_levels are used. |
The levels option must be a deep hash structure, key being the level 'name', each value being a structure with the following properties:
| Level Property | Description |
|---|---|
description | The displayed label for this level. |
threshold | A number. The lowest level with a utilisation figure (strictly) higher than the threshold 'wins'. The lowest defined level should have a negative threshold. |
color | A color name or a "#RRGGBB" HTML-style color specification. This color is used for the cell background of the 'Peak' column. The color name must be one of the ones that XLSX supports; RGB is more robust. |
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 displaed 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:
| Code Block |
|---|
{
"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"
]
}
]
} |