Skip to content

OPNsense Exporter

Comprehensive Prometheus metrics for OPNsense firewalls

A production-ready Prometheus exporter that polls OPNsense REST APIs and exposes 320+ metrics across 26 concurrent collectors -- covering firewall statistics, network interfaces, gateways, VPN tunnels, DHCP leases, DNS resolver stats, system resources, hardware temperatures, certificate expiry, and much more.

Getting Started GitHub Docker Hub

Quick navigation

  • Getting Started

    Create an API key, deploy the exporter, and verify metrics in under five minutes.

    Quick start

  • Configuration

    Complete reference for all CLI flags, environment variables, and collector switches.

    Configuration

  • Metrics Reference

    Browse all 320+ Prometheus metrics with types, labels, and PromQL examples.

    Metrics

  • Collectors

    26 sub-collectors running concurrently, each targeting a specific OPNsense subsystem.

    Collectors

  • Deployment

    Deploy with Docker, Docker Compose, Kubernetes, or systemd on any host with API access.

    Deployment

  • Dashboards

    Pre-built Grafana dashboard, Prometheus scrape configs, and example PromQL queries.

    Integration

About

OPNsense Exporter focuses specifically on OPNsense, providing deep insight into the firewall, its plugin ecosystem, and the services running on it. It is designed to complement node_exporter -- while node_exporter must be installed on the firewall itself, this exporter can run on any machine with network access to the OPNsense API.

Key highlights:

  • 26 collectors covering every major OPNsense subsystem
  • Concurrent collection via goroutines for fast scrapes
  • High-availability support with CARP/VIP monitoring
  • Opt-in high-cardinality metrics for per-lease DHCP and per-rule firewall detail
  • File-based secrets for secure credential management in containers
  • Profiling endpoints via pprof and godeltaprof for operational visibility

Fork notice

This is a fork of AthennaMind/opnsense-exporter. Full credit to the original authors for building the foundation. This fork includes significant additions -- 14 new collectors, enhanced existing collectors, modernized build infrastructure, and many bug fixes -- that go beyond the scope of the upstream project.