PROMETHEUS-FRR-EXPORTER(1)

📦
version 1.11.0 · 9 versions
, in ubuntu stonking

🌸 NAME 🌸

Okay bestie, so this whole page is about <pink>prometheus-frr-exporter</pink> — a Prometheus exporter for Free Range Routing (FRR). Yes, it's the prometheus-frr-exporter(1) manual page from the Prometheus crew, and it is exactly as glamorous as it sounds. 💅

✨ SYNOPSIS ✨

prometheus-frr-exporter [<flags>]

That's it. That's the whole vibe. Just the binary and some flags, and honestly? Iconic. 🫶

💫 DESCRIPTION 💫

Not me having literally nothing to translate here. The original page keeps this section but leaves it empty, and we are respecting the silence. No invented lore, no made-up tea. The real substance lives down in OPTIONS, so scroll down, babe. ⬇️

👑 OPTIONS 👑

Every flag, every default, every single little detail. Not one of them gets left on read. 💖

  • -h, --help — shows the context-sensitive help. And if you need more, there's also --help-long and --help-man waiting for you. 🎀
  • --collector.bgp.peer-types — turns on the frr_bgp_peer_types_up metric (default: disabled).
  • --collector.bgp.peer-types.keys=type — picks which keys from the JSON formatted BGP peer description get their values used with the frr_bgp_peer_types_up metric. You can pass multiple values (default: type). ✨
  • --collector.bgp.peer-descriptions — adds the value of the desc key from the JSON formatted BGP peer description as a label on the peer metrics (default: disabled).
  • --collector.bgp.peer-groups — adds the peer's peer group name as a label (default: disabled).
  • --collector.bgp.peer-hostnames — adds the peer's hostname as a label (default: disabled).
  • --collector.bgp.peer-descriptions.plain-text — uses the full text field of the BGP peer description instead of the value of the JSON formatted desc key (default: disabled).
  • --collector.bgp.advertised-prefixes — enables the frr_exporter_bgp_prefixes_advertised_count_total metric, which exports how many prefixes are advertised to a BGP peer. This one's for older FRR versions that don't have the PfxSent field (default: disabled).
  • --collector.bgp.accepted-filtered-prefixes — enables retrieval of accepted and filtered BGP prefix counts (default: disabled).
  • --collector.bgp.next-hop-interface — adds the peer's next-hop interface label (default: disabled).
  • --collector.bgp.monitored-prefixes — path to a file listing the prefixes you want to monitor for per-peer presence (one per line, # comments allowed). 👀
  • --frr.socket.dir-path — path of the localstatedir that contains each daemon's Unix socket.
  • --frr.socket.timeout=20s — the timeout when connecting to the FRR daemon Unix sockets.
  • --frr.vtysh — use vtysh to query FRR instead of each daemon's Unix socket (default: disabled, recommended: disabled). Trust, the recommendation is the recommendation. 🙈
  • --frr.vtysh.path — path of vtysh.
  • --frr.vtysh.timeout=20s — the timeout when running vtysh commands (default: 20s).
  • --frr.vtysh.sudo — enables sudo when executing vtysh commands.
  • --frr.vtysh.options — extra options passed through to vtysh.
  • --collector.ospf.instances — comma-separated list of instance IDs, for when you're running multiple OSPF instances.
  • --collector.route.detailed-routes — enables detailed route counts for each route type (default: disabled).
  • --collector.bfd — enables the bfd collector (default: enabled — to turn it off, use --no-collector.bfd).
  • --collector.bgp — enables the bgp collector (default: enabled — to turn it off, use --no-collector.bgp).
  • --collector.bgp6 — enables the bgp6 collector (default: disabled).
  • --collector.bgpl2vpn — enables the bgpl2vpn collector (default: disabled).
  • --collector.ospf — enables the ospf collector (default: enabled — to turn it off, use --no-collector.ospf).
  • --collector.pim — enables the pim collector (default: disabled).
  • --collector.route — enables the route collector (default: enabled — to turn it off, use --no-collector.route).
  • --collector.rpki — enables the rpki collector (default: disabled).
  • --collector.status — enables the status collector (default: enabled — to turn it off, use --no-collector.status).
  • --collector.vrrp — enables the vrrp collector (default: disabled).
  • --web.telemetry-path — the path under which metrics get exposed. 🦋
  • --web.systemd-socket — use systemd socket activation listeners instead of port listeners (Linux only, bestie, Linux only).
  • --web.listen-address=:9342 — the addresses on which to expose metrics and the web interface. Repeatable for multiple addresses. Examples: :9100 or [::1]:9100 for http, vsock://:9100 for vsock. So many flavors. ✨
  • --web.config.file — path to a configuration file that can enable TLS or authentication. See: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
  • --log.level=info — only logs messages with the given severity or above. One of: [debug, info, warn, error].
  • --log.format=logfmt — output format of log messages. One of: [logfmt, json].
  • --version — shows the application version. Slay. 🌈
Heads up bestie: those collector flags marked default: enabled are already running unless you explicitly hit them with a --no- prefix. Don't come for me when the metrics show up, that's literally the default behavior. 💅

And that's the whole page, fr fr. This is prometheus-frr-exporter version 1.11.0, dated April 2026, living in the Prometheus manual set as prometheus-frr-exporter(1). Go forth and export those metrics, main character. 👑💖

📦 where this page comes from