.TH prometheus-frr-exporter 1 frr_exporter, version 1.1.4 (branch: debian/sid, revision: 1.1.4-2+b5)
.SH "NAME"
prometheus-frr-exporter - Prometheus exporter for Free Range Routing (FRR)
.SH "SYNOPSIS"
.TP
\fBprometheus-frr-exporter [<flags>]\fR

.SH "DESCRIPTION"

.SH "OPTIONS"
.TP
\fB-h, --help\fR
Show context-sensitive help (also try --help-long and --help-man).
.TP
\fB--collector.bgp.peer-types\fR
Enable the frr_bgp_peer_types_up metric (default: disabled).
.TP
\fB--collector.bgp.peer-types.keys=type\fR
Select the keys from the JSON formatted BGP peer description of which the values will be used with the frr_bgp_peer_types_up metric. Supports multiple values (default: type).
.TP
\fB--collector.bgp.peer-descriptions\fR
Add the value of the desc key from the JSON formatted BGP peer description as a label to peer metrics. (default: disabled).
.TP
\fB--collector.bgp.peer-descriptions.plain-text\fR
Use the full text field of the BGP peer description instead of the value of the JSON formatted desc key (default: disabled).
.TP
\fB--collector.bgp.advertised-prefixes\fR
Enables the frr_exporter_bgp_prefixes_advertised_count_total metric which exports the number of advertised prefixes to a BGP peer. This is an option for older versions of FRR that don't have PfxSent field (default: disabled).
.TP
\fB--frr.socket.dir-path\fR
Path of of the localstatedir containing each daemon's Unix socket.
.TP
\fB--frr.socket.timeout=20s\fR
Timeout when connecting to the FRR daemon Unix sockets
.TP
\fB--frr.vtysh\fR
Use vtysh to query FRR instead of each daemon's Unix socket (default: disabled, recommended: disabled).
.TP
\fB--frr.vtysh.path\fR
Path of vtysh.
.TP
\fB--frr.vtysh.timeout=20s\fR
The timeout when running vtysh commands (default: 20s).
.TP
\fB--frr.vtysh.sudo\fR
Enable sudo when executing vtysh commands.
.TP
\fB--frr.vtysh.options\fR
Additional options passed to vtysh.
.TP
\fB--collector.ospf.instances\fR
Comma-separated list of instance IDs if using multiple OSPF instances
.TP
\fB--collector.bfd\fR
Enable the bfd collector (default: enabled, to disable use --no-collector.bfd).
.TP
\fB--collector.bgp\fR
Enable the bgp collector (default: enabled, to disable use --no-collector.bgp).
.TP
\fB--collector.bgp6\fR
Enable the bgp6 collector (default: disabled).
.TP
\fB--collector.bgpl2vpn\fR
Enable the bgpl2vpn collector (default: disabled).
.TP
\fB--collector.ospf\fR
Enable the ospf collector (default: enabled, to disable use --no-collector.ospf).
.TP
\fB--collector.pim\fR
Enable the pim collector (default: disabled).
.TP
\fB--collector.vrrp\fR
Enable the vrrp collector (default: disabled).
.TP
\fB--web.telemetry-path\fR
Path under which to expose metrics.
.TP
\fB--web.systemd-socket\fR
Use systemd socket activation listeners instead of port listeners (Linux only).
.TP
\fB--web.listen-address=:9342\fR
Addresses on which to expose metrics and web interface. Repeatable for multiple addresses.
.TP
\fB--web.config.file\fR
[EXPERIMENTAL] Path to configuration file that can enable TLS or authentication.
.TP
\fB--log.level=info\fR
Only log messages with the given severity or above. One of: [debug, info, warn, error]
.TP
\fB--log.format=logfmt\fR
Output format of log messages. One of: [logfmt, json]
.TP
\fB--version\fR
Show application version.