Repository files navigation

Metric exporter for bird routing daemon to use with Prometheus.

Since bird_exporter uses the bird unix sockets, bird has to be installed on the same machine as bird_exporter. Also the user executing bird_exporter must have permission to access the bird socket files.

To get meaningful uptime information bird has to be configured this way:

timeformat protocol     iso long;

Version 2.0 of bird routing daemon does support IPv4 and IPv6 in one single daemon now.For further information seehere.Since version 1.1 bird_exporter can be used with bird 2.0+ using the-bird.v2 parameter.When using this parameter bird_exporter queries the same bird socket for IPv4 and IPv6.In this mode the IP protocol is determined by the channel information and parameters-bird.ipv4,-bird.ipv6 and-bird.socket6 are ignored.

In version 1.0 a new metric format was introduced.To prevent a breaking change the new format is optional and can be enabled by using the-format.new flag.The new format handles protocols more generic and allows a better query structure.Also it adheres more to the metric naming best practices.In both formats protocol specific metrics are prefixed with the protocol name (e.g. OSPF running metric).

Since verson 1.3 the new metric format is the default.

This is a short example of the different formats:

bgp4_session_prefix_count_import{name="bgp1"} 600000bgp6_session_prefix_count_import{name="bgp1"} 50000ospfv3_running{name="ospf1"} 1

bird_protocol_prefix_import_count{name="bgp1",proto="BGP",ip_version="4"} 600000bird_protocol_prefix_import_count{name="bgp1",proto="BGP",ip_version="6"} 50000bird_ospfv3_running{name="ospf1"} 1

In version 0.7.1 the default port changed to 9324 since port 9200 is the default port of Elasticsearch. The new port is now registered in the default port allocation list (https://github.com/prometheus/prometheus/wiki/Default-port-allocations)

In version 0.8 communication to bird changed to sockets. The default socket path is/var/run/bird.ctl (for bird) and/var/run/bird6.ctl (for bird6). In case you are using different paths in your installation, the socket path can be specified by usind the-bird.socket (for bird) and-bird.socket6 (for bird6) flag.

go get -u github.com/czerwonk/bird_exporter

bird_exporter -format.new=true

this sample dashboard was created byopenbsod. Thanks for contributing!

https://grafana.com/grafana/dashboards/5259-bird-rs/

• BGP session state
• OSPF neighbor/interface count
• imported / exported / filtered prefix counts / route state changes (BGP, OSPF, Kernel, Static, Device, Direct, Babel)
• protocol uptimes (BGP, OSPF, BFD)
• BFD session status

This software uses components of the following projects

• Prometheus Go client library (https://github.com/prometheus/client_golang)

(c) Daniel Czerwonk, 2016. Licensed underMIT license.

seehttps://prometheus.io/

seehttp://bird.network.cz/