GoBGP Exporter

Export GoBGP data to Prometheus.

To run it:

cd $GOPATH/src
mkdir -p github.com/ovnworks
cd github.com/ovnworks
git clone https://github.com/ovnworks/gobgp_exporter.git
cd gobgp_exporter
make
make qtest

Exported Metrics

Metric	Description	Labels
`gobgp_router_up`	Is GoBGP up and responds to queries (1) or is it down (0).
`gobgp_router_id`	What is GoBGP router ID.
`gobgp_router_asn`	What is GoBGP AS number.
`gobgp_router_failed_req_count`	The number of failed requests to GoBGP router.
`gobgp_router_next_poll`	The timestamp of the next potential scrape of the router.
`gobgp_router_scrape_time`	The amount of time it took to scrape the router.
`gobgp_route_count_total`	The number of routes on per address family and resource type basis	`address_family`, `resource_type`
`gobgp_peer_count`	The number of BGP peers
`gobgp_peer_up`	Is the peer up and in established state (1) or it is not (0).	`name`
`gobgp_peer_asn`	What is the AS number of the peer	`name`
`gobgp_peer_local_asn`	What is the AS number presented to the peer by this router.	`name`
`gobgp_peer_admin_state`	Is the peer configured for being Up (0), Down (1), or PFX_CT (2)	`name`
"What is the state of BGP session to the peer
`gobgp_peer_session_state`	unknown (0), idle (1), connect (2), active (3), opensent (4), openconfirm (5), established (6)	`name`
`gobgp_peer_received_route_count`	How many routes did the BGP peer sent to this router (limited to IPv4).	`name`
`gobgp_peer_accepted_route_count`	How many routes were accepted from the routes received from this BGP peer (limited to IPv4)	`name`
`gobgp_peer_advertised_route_count`	How many routes were advertised to this BGP peer (limited to IPv4).	`name`
`gobgp_peer_out_queue_count`	PeerState.OutQ	`name`
`gobgp_peer_flop_count`	PeerState.Flops	`name`
`gobgp_peer_send_community`	PeerState.SendCommunity	`name`
`gobgp_peer_remove_private_as`	PeerState.RemovePrivateAs	`name`
`gobgp_peer_password_set`	Whether the GoBGP peer has been configured (1) for authentication or not (0)	`name`
`gobgp_peer_type`	PeerState.PeerType	`name`

For example:

# HELP gobgp_peer_accepted_route_count How many routes were accepted from the routes received from this BGP peer (limited to IPv4)
# TYPE gobgp_peer_accepted_route_count gauge
gobgp_peer_accepted_route_count{name="10.0.2.100"} 0
# HELP gobgp_peer_admin_state Is the peer configured for being Up (0), Down (1), or PFX_CT (2)
# TYPE gobgp_peer_admin_state gauge
gobgp_peer_admin_state{name="10.0.2.100"} 0
# HELP gobgp_peer_advertised_route_count How many routes were advertised to this BGP peer (limited to IPv4).
# TYPE gobgp_peer_advertised_route_count gauge
gobgp_peer_advertised_route_count{name="10.0.2.100"} 0
# HELP gobgp_peer_asn What is the AS number of the peer
# TYPE gobgp_peer_asn gauge
gobgp_peer_asn{name="10.0.2.100"} 65001
# HELP gobgp_peer_count The number of BGP peers
# TYPE gobgp_peer_count gauge
gobgp_peer_count 1
# HELP gobgp_peer_flop_count PeerState.Flops
# TYPE gobgp_peer_flop_count gauge
gobgp_peer_flop_count{name="10.0.2.100"} 0
# HELP gobgp_peer_local_asn What is the AS number presented to the peer by this router.
# TYPE gobgp_peer_local_asn gauge
gobgp_peer_local_asn{name="10.0.2.100"} 0
# HELP gobgp_peer_out_queue_count PeerState.OutQ
# TYPE gobgp_peer_out_queue_count gauge
gobgp_peer_out_queue_count{name="10.0.2.100"} 0
# HELP gobgp_peer_password_set Whether the GoBGP peer has been configured (1) for authentication or not (0)
# TYPE gobgp_peer_password_set gauge
gobgp_peer_password_set{name="10.0.2.100"} 0
# HELP gobgp_peer_received_route_count How many routes did the BGP peer sent to this router (limited to IPv4).
# TYPE gobgp_peer_received_route_count gauge
gobgp_peer_received_route_count{name="10.0.2.100"} 0
# HELP gobgp_peer_remove_private_as PeerState.RemovePrivateAs
# TYPE gobgp_peer_remove_private_as gauge
gobgp_peer_remove_private_as{name="10.0.2.100"} 0
# HELP gobgp_peer_send_community PeerState.SendCommunity
# TYPE gobgp_peer_send_community gauge
gobgp_peer_send_community{name="10.0.2.100"} 0
# HELP gobgp_peer_session_state What is the state of BGP session to the peer: unknown (0), idle (1), connect (2), active (3), opensent (4), openconfirm (5), established (6)
# TYPE gobgp_peer_session_state gauge
gobgp_peer_session_state{name="10.0.2.100"} 0
# HELP gobgp_peer_type PeerState.PeerType
# TYPE gobgp_peer_type gauge
gobgp_peer_type{name="10.0.2.100"} 0
# HELP gobgp_peer_up Is the peer up and in established state (1) or it is not (0).
# TYPE gobgp_peer_up gauge
gobgp_peer_up{name="10.0.2.100"} 0
# HELP gobgp_route_count_total The number of routes on per address family and resource type basis
# TYPE gobgp_route_count_total gauge
gobgp_route_count_total{address_family="evpn",resource_type="global"} 0
gobgp_route_count_total{address_family="evpn",resource_type="local"} 0
gobgp_route_count_total{address_family="ipv4",resource_type="global"} 1
gobgp_route_count_total{address_family="ipv4",resource_type="local"} 1
# HELP gobgp_router_asn What is GoBGP AS number.
# TYPE gobgp_router_asn gauge
gobgp_router_asn 65001
# HELP gobgp_router_failed_req_count The number of failed requests to GoBGP router.
# TYPE gobgp_router_failed_req_count counter
gobgp_router_failed_req_count 0
# HELP gobgp_router_id What is GoBGP router ID.
# TYPE gobgp_router_id gauge
gobgp_router_id 1
# HELP gobgp_router_next_poll The timestamp of the next potential scrape of the router.
# TYPE gobgp_router_next_poll counter
gobgp_router_next_poll 1.551178392e+09
# HELP gobgp_router_scrape_time The amount of time it took to scrape the router.
# TYPE gobgp_router_scrape_time gauge
gobgp_router_scrape_time 0.006621245
# HELP gobgp_router_up Is GoBGP up and responds to queries (1) or is it down (0).
# TYPE gobgp_router_up gauge
gobgp_router_up 1

Flags

$ bin/gobgp-exporter --help

gobgp-exporter - Prometheus Exporter for GoBGP

Usage: gobgp-exporter [arguments]

  -auth.token string
        The X-Token for accessing the exporter itself (default "anonymous")
  -gobgp.address string
        gRPC API address of GoBGP server. (default "127.0.0.1:50051")
  -gobgp.poll-interval int
        The minimum interval (in seconds) between collections from a GoBGP server. (default 15)
  -gobgp.timeout int
        Timeout on gRPC requests to a GoBGP server. (default 2)
  -log.level string
        logging severity level (default "info")
  -metrics
        Display available metrics
  -version
        version information
  -web.listen-address string
        Address to listen on for web interface and telemetry. (default ":9474")
  -web.telemetry-path string
        Path under which to expose metrics. (default "/metrics")

Documentation: https://github.com/ovnworks/gobgp_exporter/

gobgp.address: Address (host and port) of the GoBGP instance we should connect to. This could be a local GoBGP server (127.0.0.0:50051, for instance), or the address of a remote GoBGP server.
gobgp.timeout: Timeout on gRPC requests to GoBGP.
gobgp.poll-interval: The minimum interval (in seconds) between collections from GoBGP server. (default: 15 seconds)
gobgp.peers: The file containing the mapping between router_id and the name (e.g. hostname) of a remote peer.
auth.token: Enable X-Token authentication for accessing the exporter itself.
version: Show application version.
web.listen-address: Address to listen on for web interface and telemetry.
web.telemetry-path: Path under which to expose metrics.

Outstanding Issues

The following is a list of issues related to GoBGP package itself:

gobgp_peer_session_state reports 0, although a router maybe in established (5) state. The metric is being derived from PeerState.SessionState

Netnod / gobgp_exporter

GoBGP Exporter

Exported Metrics

Flags

Outstanding Issues

About

Languages