Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chitoku-k/edgerouter-exporter

A Prometheus exporter for EdgeRouter
https://github.com/chitoku-k/edgerouter-exporter

edgerouter prometheus-exporter

Last synced: about 2 months ago
JSON representation

A Prometheus exporter for EdgeRouter

Awesome Lists containing this project

README 

        
edgerouter-exporter

===================



[![][workflow-badge]][workflow-link]



A Prometheus exporter for EdgeRouter BGP, DDNS, Load Balancers, and PPPoE sessions



## Requirements



For development, the following dependencies are required:



- [rustup](https://rustup.rs/) (nightly toolchain is required for [build-std](https://doc.rust-lang.org/cargo/reference/unstable.html#build-std))

- [cross](https://github.com/cross-rs/cross)

- openssl (e.g. libssl-dev, openssl, or openssl-devel)



In order to build the artifact, use `cross build`. To find on which architecture

your model is running, refer to [EdgeRouter - Hardware Offloading].



### MediaTek-based devices



```sh

$ cross build --release --target=mipsel-unknown-linux-gnu

```



### Cavium-based devices



```sh

$ cross build --release --target=mips-unknown-linux-gnu

```



## Installation



Download the latest version of edgerouter-exporter and move it to the directory

where it persists after the EdgeOS upgrades. Note that the root permission is

required because it internally calls `ubnt_vtysh`.



To find on which architecture your model is running, refer to [EdgeRouter - Hardware Offloading].



### MediaTek-based devices



```console

$ curl -fLO https://github.com/chitoku-k/edgerouter-exporter/releases/latest/download/prometheus-edgerouter-exporter_mipsel.deb

$ sudo mkdir -p /config/data/firstboot/install-packages

$ sudo mv prometheus-edgerouter-exporter_mipsel.deb /config/data/firstboot/install-packages

$ sudo dpkg -i /config/data/firstboot/install-packages/prometheus-edgerouter-exporter_mipsel.deb

```



### Cavium-based devices



```console

$ curl -fLO https://github.com/chitoku-k/edgerouter-exporter/releases/latest/download/prometheus-edgerouter-exporter_mips.deb

$ sudo mkdir -p /config/data/firstboot/install-packages

$ sudo mv prometheus-edgerouter-exporter_mips.deb /config/data/firstboot/install-packages

$ sudo dpkg -i /config/data/firstboot/install-packages/prometheus-edgerouter-exporter_mips.deb

```



### Configuration



#### Environment variables



Configure by creating `/config/user-data/edgerouter-exporter.env`.



```sh

# Log level (optional; one of trace, debug, info, warn, and error)

#LOG_LEVEL=info



# Port number (required)

PORT=8080



# TLS certificate and private key (optional; if not specified, exporter is served over HTTP)

#TLS_CERT=/path/to/tls/cert

#TLS_KEY=/path/to/tls/key



# Path to Unix socket for VICI (optional)

#VICI_PATH=/run/charon.vici



# Op command (optional)

#IP_COMMAND=/bin/ip

#OP_COMMAND=/opt/vyatta/bin/vyatta-op-cmd-wrapper

#OP_DDNS_COMMAND=/opt/vyatta/bin/sudo-users/vyatta-op-dynamic-dns.pl

#VTYSH_COMMAND=/opt/vyatta/sbin/ubnt_vtysh

```



#### Command-line options



The command-line options that are equivalent to the environment variables above

can be specified by lowercasing option and replacing underscores (`_`) with

hyphens (`-`). For instance, `LOG_LEVEL` is equivalent to `--log-level`.



## Usage



```sh

$ sudo systemctl enable --now prometheus-edgerouter-exporter.service

```



## Prometheus Metrics



### Version



```

# HELP edgerouter_info Version info

# TYPE edgerouter_info gauge

edgerouter_info{version="v2.0.6",build_id="5208541",model="EdgeRouter X 5-Port"} 1

```



### BGP



```

# HELP edgerouter_bgp_message_in_queue Number of BGP messages in incoming queue

# TYPE edgerouter_bgp_message_in_queue gauge

edgerouter_bgp_message_in_queue{as="64497",neighbor="192.0.2.2",table_version="128"} 0

edgerouter_bgp_message_in_queue{as="64497",neighbor="192.0.2.3",table_version="128"} 0

edgerouter_bgp_message_in_queue{as="64497",neighbor="2001:db8::2",table_version="128"} 0

edgerouter_bgp_message_in_queue{as="64497",neighbor="2001:db8::3",table_version="128"} 0

# HELP edgerouter_bgp_message_out_queue Number of BGP messages in outgoing queue

# TYPE edgerouter_bgp_message_out_queue gauge

edgerouter_bgp_message_out_queue{as="64497",neighbor="192.0.2.2",table_version="128"} 0

edgerouter_bgp_message_out_queue{as="64497",neighbor="192.0.2.3",table_version="128"} 0

edgerouter_bgp_message_out_queue{as="64497",neighbor="2001:db8::2",table_version="128"} 0

edgerouter_bgp_message_out_queue{as="64497",neighbor="2001:db8::3",table_version="128"} 0

# HELP edgerouter_bgp_message_received_total Total number of BGP messages received

# TYPE edgerouter_bgp_message_received_total gauge

edgerouter_bgp_message_received_total{as="64497",neighbor="192.0.2.2",table_version="128"} 1000

edgerouter_bgp_message_received_total{as="64497",neighbor="192.0.2.3",table_version="128"} 2000

edgerouter_bgp_message_received_total{as="64497",neighbor="2001:db8::2",table_version="128"} 3000

edgerouter_bgp_message_received_total{as="64497",neighbor="2001:db8::3",table_version="128"} 4000

# HELP edgerouter_bgp_message_sent_total Total number of BGP messages sent

# TYPE edgerouter_bgp_message_sent_total gauge

edgerouter_bgp_message_sent_total{as="64497",neighbor="192.0.2.2",table_version="128"} 5000

edgerouter_bgp_message_sent_total{as="64497",neighbor="192.0.2.3",table_version="128"} 6000

edgerouter_bgp_message_sent_total{as="64497",neighbor="2001:db8::2",table_version="128"} 7000

edgerouter_bgp_message_sent_total{as="64497",neighbor="2001:db8::3",table_version="128"} 8000

# HELP edgerouter_bgp_prefix_received_total Total number of BGP prefixes received

# TYPE edgerouter_bgp_prefix_received_total gauge

edgerouter_bgp_prefix_received_total{as="64497",neighbor="192.0.2.2",table_version="128"} 9

edgerouter_bgp_prefix_received_total{as="64497",neighbor="192.0.2.3",table_version="128"} 10

edgerouter_bgp_prefix_received_total{as="64497",neighbor="2001:db8::2",table_version="128"} 11

edgerouter_bgp_prefix_received_total{as="64497",neighbor="2001:db8::3",table_version="128"} 12

# HELP edgerouter_bgp_session_seconds_total Total seconds for established BGP session

# TYPE edgerouter_bgp_session_seconds_total gauge

edgerouter_bgp_session_seconds_total{as="64497",neighbor="192.0.2.2",table_version="128"} 100

edgerouter_bgp_session_seconds_total{as="64497",neighbor="192.0.2.3",table_version="128"} 200

edgerouter_bgp_session_seconds_total{as="64497",neighbor="2001:db8::2",table_version="128"} 300

edgerouter_bgp_session_seconds_total{as="64497",neighbor="2001:db8::3",table_version="128"} 400

```



### Dynamic DNS



```

# HELP edgerouter_dynamic_dns_status Result of DDNS update

# TYPE edgerouter_dynamic_dns_status gauge

edgerouter_dynamic_dns_status{hostname="1.example.com",interface_name="eth0",ip_address="192.0.2.1"} 1

edgerouter_dynamic_dns_status{hostname="2.example.com",interface_name="eth1",ip_address="192.0.2.2"} 0

```



### IPsec VPN



Metrics and labels are designed to be compliant with [IPsec Exporter][] but note

that the results might not fundamentally equal as both implementations vary.



```

# HELP ipsec_up Result of IPsec metrics scrape.

# TYPE ipsec_up gauge

ipsec_up{tunnel="peer-1.example.com-tunnel-1"} 1

ipsec_up{tunnel="peer-2.example.com-tunnel-1"} 1

# HELP ipsec_status Status of IPsec tunnel.

# TYPE ipsec_status gauge

ipsec_status{tunnel="peer-1.example.com-tunnel-1"} 0

ipsec_status{tunnel="peer-2.example.com-tunnel-1"} 0

# HELP ipsec_in_bytes Total receive bytes for IPsec tunnel.

# TYPE ipsec_in_bytes gauge

ipsec_in_bytes{tunnel="peer-1.example.com-tunnel-1"} 1000

ipsec_in_bytes{tunnel="peer-2.example.com-tunnel-1"} 2000

# HELP ipsec_out_bytes Total transmit bytes for IPsec tunnel.

# TYPE ipsec_out_bytes gauge

ipsec_out_bytes{tunnel="peer-1.example.com-tunnel-1"} 3000

ipsec_out_bytes{tunnel="peer-2.example.com-tunnel-1"} 4000

# HELP ipsec_in_packets Total receive packets for IPsec tunnel.

# TYPE ipsec_in_packets gauge

ipsec_in_packets{tunnel="peer-1.example.com-tunnel-1"} 5000

ipsec_in_packets{tunnel="peer-2.example.com-tunnel-1"} 6000

# HELP ipsec_out_packets Total transmit packets for IPsec tunnel.

# TYPE ipsec_out_packets gauge

ipsec_out_packets{tunnel="peer-1.example.com-tunnel-1"} 7000

ipsec_out_packets{tunnel="peer-2.example.com-tunnel-1"} 8000

```



### Load Balancers



```

# HELP edgerouter_load_balancer_status Status (0: inactive, 1: active, 2: failover)

# TYPE edgerouter_load_balancer_status gauge

edgerouter_load_balancer_status{group_name="WAN_FAILOVER",interface_name="eth0"} 1

edgerouter_load_balancer_status{group_name="WAN_FAILOVER",interface_name="eth1"} 0

# HELP edgerouter_load_balancer_weight_ratio Weight ratio

# TYPE edgerouter_load_balancer_weight_ratio gauge

edgerouter_load_balancer_weight_ratio{group_name="WAN_FAILOVER",interface_name="eth0"} 1.0

edgerouter_load_balancer_weight_ratio{group_name="WAN_FAILOVER",interface_name="eth1"} 0.0

# HELP edgerouter_load_balancer_flows_total Total number of flows

# TYPE edgerouter_load_balancer_flows_total gauge

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth0",flow="WAN Out"} 3000

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth0",flow="WAN In"} 3100

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth0",flow="Local ICMP"} 1000

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth0",flow="Local DNS"} 0

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth0",flow="Local Data"} 0

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth1",flow="WAN Out"} 2000

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth1",flow="WAN In"} 2100

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth1",flow="Local ICMP"} 500

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth1",flow="Local DNS"} 0

edgerouter_load_balancer_flows_total{group_name="WAN_FAILOVER",interface_name="eth1",flow="Local Data"} 0

# HELP edgerouter_load_balancer_health Result of watchdog

# TYPE edgerouter_load_balancer_health gauge

edgerouter_load_balancer_health{group_name="WAN_FAILOVER",interface_name="eth0"} 1

edgerouter_load_balancer_health{group_name="WAN_FAILOVER",interface_name="eth1"} 0

# HELP edgerouter_load_balancer_ping_fail_total Total number of ping failures

# TYPE edgerouter_load_balancer_ping_fail_total gauge

edgerouter_load_balancer_ping_fail_total{group_name="WAN_FAILOVER",interface_name="eth0"} 125

edgerouter_load_balancer_ping_fail_total{group_name="WAN_FAILOVER",interface_name="eth1"} 2

# HELP edgerouter_load_balancer_ping_health Result of ping

# TYPE edgerouter_load_balancer_ping_health gauge

edgerouter_load_balancer_ping_health{gateway="8.8.8.8",group_name="WAN_FAILOVER",interface_name="eth0"} 1

edgerouter_load_balancer_ping_health{gateway="8.8.8.8",group_name="WAN_FAILOVER",interface_name="eth1"} 0

# HELP edgerouter_load_balancer_ping_total Total number of pings

# TYPE edgerouter_load_balancer_ping_total gauge

edgerouter_load_balancer_ping_total{group_name="WAN_FAILOVER",interface_name="eth0"} 1000

edgerouter_load_balancer_ping_total{group_name="WAN_FAILOVER",interface_name="eth1"} 1000

# HELP edgerouter_load_balancer_route_drop_total Total number of route drops

# TYPE edgerouter_load_balancer_route_drop_total gauge

edgerouter_load_balancer_route_drop_total{group_name="WAN_FAILOVER",interface_name="eth0"} 5

edgerouter_load_balancer_route_drop_total{group_name="WAN_FAILOVER",interface_name="eth1"} 0

# HELP edgerouter_load_balancer_run_fail_total Total number of run failures

# TYPE edgerouter_load_balancer_run_fail_total gauge

edgerouter_load_balancer_run_fail_total{group_name="WAN_FAILOVER",interface_name="eth0"} 0

edgerouter_load_balancer_run_fail_total{group_name="WAN_FAILOVER",interface_name="eth1"} 0

```



### PPPoE Client Sessions



```

# HELP edgerouter_pppoe_client_session_receive_bytes_total Total receive bytes for PPPoE client session

# TYPE edgerouter_pppoe_client_session_receive_bytes_total gauge

edgerouter_pppoe_client_session_receive_bytes_total{interface_name="pppoe0",ip_address="192.0.2.255",local_ip_address="203.0.113.1",protocol="PPPoE",user="user01"} 79360

# HELP edgerouter_pppoe_client_session_receive_packets_total Total receive packets for PPPoE client session

# TYPE edgerouter_pppoe_client_session_receive_packets_total gauge

edgerouter_pppoe_client_session_receive_packets_total{interface_name="pppoe0",ip_address="192.0.2.255",local_ip_address="203.0.113.1",protocol="PPPoE",user="user01"} 1638

# HELP edgerouter_pppoe_client_session_seconds_total Total seconds for PPPoE client session

# TYPE edgerouter_pppoe_client_session_seconds_total gauge

edgerouter_pppoe_client_session_seconds_total{interface_name="pppoe0",ip_address="192.0.2.255",local_ip_address="203.0.113.1",protocol="PPPoE",user="user01"} 18975

# HELP edgerouter_pppoe_client_session_transmit_bytes_total Total transmit bytes for PPPoE client session

# TYPE edgerouter_pppoe_client_session_transmit_bytes_total gauge

edgerouter_pppoe_client_session_transmit_bytes_total{interface_name="pppoe0",ip_address="192.0.2.255",local_ip_address="203.0.113.1",protocol="PPPoE",user="user01"} 39116

# HELP edgerouter_pppoe_client_session_transmit_packets_total Total transmit packets for PPPoE client session

# TYPE edgerouter_pppoe_client_session_transmit_packets_total gauge

edgerouter_pppoe_client_session_transmit_packets_total{interface_name="pppoe0",ip_address="192.0.2.255",local_ip_address="203.0.113.1",protocol="PPPoE",user="user01"} 412

```



### Spec



| Status | Condition                           |

|--------|-------------------------------------|

| 200    | Success.                            |

| 500    | Unexpected error calling a command. |



[workflow-link]:                    https://github.com/chitoku-k/edgerouter-exporter/actions?query=branch:master

[workflow-badge]:                   https://img.shields.io/github/actions/workflow/status/chitoku-k/edgerouter-exporter/ci.yml?branch=master&style=flat-square

[IPsec Exporter]:                   https://github.com/dennisstritzke/ipsec_exporter

[EdgeRouter - Hardware Offloading]: https://help.ui.com/hc/en-us/articles/115006567467-EdgeRouter-Hardware-Offloading