.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "BIRD_EXPORTER" "1" "2018-06-20" "bird_exporter" "bird_exporter\[cq]s Manual"
.hy
.SH NAME
.PP
bird_exporter - A protocol state exporter for the BIRD routing daemon to
use with Prometheus
.SH SYNOPSIS
.PP
\f[B]bird_exporter\f[R] [\f[B]OPTIONS\f[R]]
.SH DESCRIPTION
.PP
\f[B]bird_exporter\f[R] is a metric exporter for the BIRD routing daemon
to use with Prometheus.
Since \f[B]bird_exporter\f[R] uses the BIRD Unix socket(s), BIRD needs
to be installed on the same machine as bird_exporter.
The user executing bird_exporter must have read/write permission to
access the BIRD Unix sockets.
.SH OPTIONS
.PP
\f[B]-bird.ipv4\f[R] Get protocols from bird (not compatible with
\f[B]-bird.v2\f[R])
.PP
\f[B]-bird.ipv6\f[R] Get protocols from bird6 (not compatible with
\f[B]-bird.v2\f[R])
.PP
\f[B]-bird.socket\f[R] \f[I]/path/to/socket\f[R] Socket to communicate
with bird routing daemon
.PP
\f[B]-bird.socket6\f[R] \f[I]/path/to/socket\f[R] Socket to communicate
with bird6 routing daemon (not compatible with \f[B]-bird.v2\f[R])
.PP
\f[B]-bird.v2\f[R] BIRD major version >= 2.0 (multi channel protocols)
.PP
\f[B]-format.new\f[R] New metric format (more convenient / generic)
.PP
\f[B]-proto.bgp\f[R] Enables metrics for protocol BGP
.PP
\f[B]-proto.direct\f[R] Enables metrics for protocol Direct
.PP
\f[B]-proto.kernel\f[R] Enables metrics for protocol Kernel
.PP
\f[B]-proto.ospf\f[R] Enables metrics for protocol OSPF
.PP
\f[B]-proto.static\f[R] Enables metrics for protocol Static
.PP
\f[B]-proto.babel\f[R] Enables metrics for protocol Babel
.PP
\f[B]-version\f[R] Print version information
.PP
\f[B]-web.listen-address\f[R] \f[I][address]:port\f[R] Address on which
to expose metrics and web interface
.PP
\f[B]-web.telemetry-path\f[R] \f[I]path\f[R] Path under which to expose
metrics (default \[lq]/metrics\[rq])
.PP
Version 2.0 of BIRD supports both IPv4 and IPv6 in a single daemon.
Since version 1.1 of \f[B]bird_exporter\f[R], it can be used with BIRD
2.0+ using the \f[B]-bird.v2\f[R] option.
When using this option, \f[B]bird_exporter\f[R] queries the same socket
for both IPv4 and IPv6.
In this mode the IP protocol is determined by the channel information,
and options \f[B]-bird.ipv4\f[R], \f[B]-bird.ipv6\f[R] and
\f[B]-bird.socket6\f[R] are ignored.
.SH BIRD CONFIGURATION
.PP
To get meaningful uptime information, BIRD needs to be configured to use
ISO-format timestamps:
.IP
.nf
\f[C]
timeformat protocol iso long;
\f[R]
.fi
.SH METRIC FORMATS
.PP
In version 1.0, a new metric format was introduced.
To avoid backwards incompatibility, the new format is optional and can
be enabled by using the \f[B]-format.new\f[R] option.
The new format handles protocols more generically and allows for a
better query structure.
It also adheres more to the Prometheus metric naming best practices.
In both formats protocol specific metrics are prefixed with the protocol
name (e.g.\ OSPF running metric).
.SS OLD METRIC FORMAT EXAMPLE
.IP
.nf
\f[C]
bgp4_session_prefix_count_import{name=\[dq]bgp1\[dq]} 600000
bgp6_session_prefix_count_import{name=\[dq]bgp1\[dq]} 50000
ospfv3_running{name=\[dq]ospf1\[dq]} 1
\f[R]
.fi
.SS NEW METRIC FORMAT EXAMPLE
.IP
.nf
\f[C]
bird_protocol_prefix_import_count{name=\[dq]bgp1\[dq],proto=\[dq]BGP\[dq],ip_version=\[dq]4\[dq]} 600000
bird_protocol_prefix_import_count{name=\[dq]bgp1\[dq],proto=\[dq]BGP\[dq],ip_version=\[dq]6\[dq]} 50000
bird_ospfv3_running{name=\[dq]ospf1\[dq]} 1
\f[R]
.fi
.SH AUTHOR
.PP
Daniel Czerwonk <daniel@dan-nrw.de>