Skip to content

Metrics Reference

The OPNsense Exporter provides 853 Prometheus metrics across 63 collectors, covering every major subsystem of the firewall platform.

Every metric on this page is generated from the collector source, so it always matches the shipped binary. Read the collector implementations in internal/collector/ on GitHub, or open an issue if a metric you need is missing.

  • Metrics Overview

    Naming conventions, common labels, metric types, and PromQL examples.

    Overview

  • Complete Reference

    Auto-generated list of every metric with type, labels, and help text.

    Complete reference

Quick facts

  • 853 metrics across 63 collectors
  • Naming convention: opnsense_<subsystem>_<metric_name>
  • Common label: opnsense_instance on every metric
  • Metric types: Gauge (most metrics), Counter (_total suffix)
  • Top-level health: opnsense_up, opnsense_firewall_status, opnsense_system_status_code

Auto-generated reference

The Complete Reference page is auto-generated from the exporter source code by a docgen tool. It is always up to date with the latest release.