OPNsense-Exporter

OPNsense-Exporter

Application Docker from Florian Dambrine's Repository

Vue d'ensemble

OPNsense Exporter - Prometheus exporter for OPNsense firewalls. Collects and exposes metrics from OPNsense via its REST API, including ARP tables, DNS (Unbound), WireGuard, OpenVPN, IPsec, firewall statistics, and firmware information.

Arguments d'exécution

Interface utilisateur Web
http://[IP]:[PORT:8080]/metrics
Réseau
bridge
Privilégié
false

Configuration du modèle

Metrics PortPorttcp

Port on which the /metrics endpoint is exposed for Prometheus scraping.

Cible
8080
Défaut
8080
Valeur
8080
OPNsense ProtocolVariable

Protocol used to reach the OPNsense API. Use 'https' (recommended) or 'http'.

Cible
OPNSENSE_EXPORTER_OPS_PROTOCOL
Défaut
https
Valeur
https
OPNsense AddressVariable

Hostname or IP address of the OPNsense firewall (e.g. 192.168.1.1 or opnsense.lan). Do NOT include the protocol prefix.

Cible
OPNSENSE_EXPORTER_OPS_API
OPNsense API KeyVariable

API key generated for the read-only OPNsense user (System > Access > Users).

Cible
OPNSENSE_EXPORTER_OPS_API_KEY
OPNsense API SecretVariable

API secret generated for the read-only OPNsense user (System > Access > Users).

Cible
OPNSENSE_EXPORTER_OPS_API_SECRET
Skip TLS VerificationVariable

Set to 'true' to disable TLS certificate verification (useful for self-signed certs). Not recommended in production.

Cible
OPNSENSE_EXPORTER_OPS_INSECURE
Défaut
false
Valeur
false
Instance LabelVariable

Label added to all metrics to identify this OPNsense instance. Useful when scraping multiple firewalls.

Cible
OPNSENSE_EXPORTER_INSTANCE_LABEL
Défaut
opnsense
Valeur
opnsense
Log LevelVariable

Log verbosity. Options: debug, info, warn, error.

Cible
OPNSENSE_EXPORTER_LOG_LEVEL
Défaut
info
Valeur
info
Disable ARP TableVariable

Set to 'true' to disable ARP table metric collection.

Cible
OPNSENSE_EXPORTER_DISABLE_ARP_TABLE
Défaut
false
Valeur
false
Disable Unbound DNSVariable

Set to 'true' to disable Unbound DNS metric collection.

Cible
OPNSENSE_EXPORTER_DISABLE_UNBOUND
Défaut
false
Valeur
false
Disable WireGuardVariable

Set to 'true' to disable WireGuard VPN metric collection.

Cible
OPNSENSE_EXPORTER_DISABLE_WIREGUARD
Défaut
false
Valeur
false
Disable OpenVPNVariable

Set to 'true' to disable OpenVPN metric collection.

Cible
OPNSENSE_EXPORTER_DISABLE_OPENVPN
Défaut
false
Valeur
false
Disable IPsecVariable

Set to 'true' to disable IPsec VPN metric collection.

Cible
OPNSENSE_EXPORTER_DISABLE_IPSEC
Défaut
false
Valeur
false
Disable FirewallVariable

Set to 'true' to disable firewall statistics metric collection.

Cible
OPNSENSE_EXPORTER_DISABLE_FIREWALL
Défaut
false
Valeur
false
Disable FirmwareVariable

Set to 'true' to disable firmware information metric collection.

Cible
OPNSENSE_EXPORTER_DISABLE_FIRMWARE
Défaut
false
Valeur
false
Disable Cron TableVariable

Set to 'true' to disable cron task metric collection.

Cible
OPNSENSE_EXPORTER_DISABLE_CRON_TABLE
Défaut
false
Valeur
false
Disable Exporter MetricsVariable

Set to 'true' to exclude internal Go/process metrics from the /metrics output.

Cible
OPNSENSE_EXPORTER_DISABLE_EXPORTER_METRICS
Défaut
false
Valeur
false

Détails

Référentiel
ghcr.io/athennamind/opnsense-exporter
Dernière mise à jour2026-06-01
Première vue2026-04-07

Exécutez OPNsense-Exporter sur Unraid.

OPNsense-Exporter est listé dans Community Apps pour Unraid OS. Explorez Unraid pour créer un serveur domestique flexible, un NAS ou un laboratoire domestique.