Bandwidth Check Reference

All parameters, thresholds, and configuration options for the bandwidth check in octoja.

Written By Erdinc Akay

Last updated About 2 months ago

Bandwidth Check Reference

The Bandwidth Check measures network throughput on specific interfaces and alerts when utilization exceeds the configured thresholds.

Configuration fields

FieldTypeRequiredDefaultDescription
Sampling duration (seconds)SecondsNo5Delay between the two interface counter reads. Clamped to 1–30 seconds; values outside the range are coerced before sampling.
Monitor all interfacesBooleanNoYesMonitor all network interfaces
InterfacesList of stringsNoSpecific interface names to monitor. Only shown in the editor when Monitor all interfaces is unchecked. If the list is left empty, all interfaces are monitored as if Monitor all interfaces were checked.
Use percentage of link speedBooleanNoNoUse percentage of link speed instead of absolute Mbps value
Warning (%)PercentNo80Utilization percentage that triggers a warning. Only shown when Use percentage of link speed is checked.
Critical (%)PercentNo95Utilization percentage that triggers a critical result. Only shown when Use percentage of link speed is checked.
Warning (Mbps)MbpsNo800Throughput that triggers a warning. Only shown when Use percentage of link speed is unchecked.
Critical (Mbps)MbpsNo950Throughput that triggers a critical result. Only shown when Use percentage of link speed is unchecked.

Collected metrics

  • Receive throughput (Mbps) per interface
  • Transmit throughput (Mbps) per interface
  • Total throughput (Mbps) per interface
  • Interface link speed (Mbps)
  • Per-interface result status (OK, Warning, Critical)

Platform support

PlatformSupported
WindowsYes
LinuxYes
macOSYes

Runtime behavior

  • Threshold auto-swap. If the warning threshold is greater than the critical threshold, the runtime swaps the two values before evaluation. This applies to both the Mbps and the percentage threshold pairs.
  • Percentage thresholds are clamped to 0–100. Values outside the range are coerced before the swap check.
  • No monitored interfaces. If filtering leaves zero interfaces (for example, every name in Interfaces is misspelled, or the host has no non-loopback interfaces in the Up state), the check returns a Warning result with an empty interface list rather than failing.
  • Counter-reset protection. If a per-interface byte counter goes backwards between the two samples (some drivers reset on link flap), the throughput for that direction is reported as 0 Mbps for that run instead of a negative value.

Notes

  • The check takes a network traffic sample over the configured duration. A longer sample duration provides more representative results but briefly increases the check execution time.
  • When monitoring all interfaces, the check automatically excludes loopback interfaces and any interface that is not in the Up operational state. Other virtual interfaces (VPN adapters, virtual switches) are included; exclude them by selecting specific interfaces if they cause false positives.
  • If an interface does not report a link speed, percentage thresholds cannot be applied and the check falls back to the Mbps thresholds for that interface. Link speed reporting is most reliable on Windows.

See also: Configure a Bandwidth Check