feat(bgp): neighbour metrics (#106)

Co-authored-by: Christian Svensson <[email protected]>

Author: Hugo Blom

Diff for: README.md

@@ -57,6 +57,8 @@ Per-VDOM:
  * `fortigate_ipsec_tunnel_receive_bytes_total`
  * `fortigate_ipsec_tunnel_transmit_bytes_total`
  * `fortigate_ipsec_tunnel_up`
+ * `fortigate_bgp_neighbor_ipv4_info`
+ * `fortigate_bgp_neighbor_ipv6_info`
 
  Per-HA-Member and VDOM:
  * `fortigate_ha_member_info`
@@ -171,6 +173,8 @@ config system accprofile
             # If you do not wish to grant this permission, the relevant
             # labels/metrics will be absent.
             set cfg read
+            # If you wish to collect ipv6 bgp neighbours, add this:
+            set route-cfg read
         end
         config fwgrp-permission
             set policy read

Diff for: pkg/probe/bgp_neighbors.go

@@ -0,0 +1,90 @@
+package probe
+
+import (
+	"log"
+	"strconv"
+
+	"github.com/bluecmd/fortigate_exporter/internal/version"
+	"github.com/bluecmd/fortigate_exporter/pkg/http"
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+type BGPNeighbor struct {
+	NeighborIP  string `json:"neighbor_ip"`
+	LocalIP     string `json:"local_ip"`
+	RemoteAS    int    `json:"remote_as"`
+	AdminStatus bool   `json:"admin_status"`
+	State       string `json:"state"`
+}
+
+type BGPNeighborResponse struct {
+	Results []BGPNeighbor `json:"results"`
+	VDOM    string        `json:"vdom"`
+	Version string        `json:"version"`
+}
+
+func probeBGPNeighborsIPv4(c http.FortiHTTP) ([]prometheus.Metric, bool) {
+
+	var (
+		mBGPNeighbor = prometheus.NewDesc(
+			"fortigate_bgp_neighbor_ipv4_info",
+			"Confiured bgp neighbor over ipv4",
+			[]string{"vdom", "remote_as", "state", "admin_status", "local_ip", "neighbor_ip"}, nil,
+		)
+	)
+
+	var rs []BGPNeighborResponse
+
+	if err := c.Get("api/v2/monitor/router/bgp/neighbors", "vdom=*", &rs); err != nil {
+		log.Printf("Error: %v", err)
+		return nil, false
+	}
+
+	m := []prometheus.Metric{}
+
+	for _, r := range rs {
+		major, _, ok := version.ParseVersion(r.Version)
+		if !ok || major < 7 {
+			// not supported version. Before 7.0.0 the requested endpoint doesn't exist
+			return nil, false
+		}
+		for _, peer := range r.Results {
+			m = append(m, prometheus.MustNewConstMetric(mBGPNeighbor, prometheus.GaugeValue, 1, r.VDOM, strconv.Itoa(peer.RemoteAS), peer.State, strconv.FormatBool(peer.AdminStatus), peer.LocalIP, peer.NeighborIP))
+		}
+	}
+
+	return m, true
+}
+
+func probeBGPNeighborsIPv6(c http.FortiHTTP) ([]prometheus.Metric, bool) {
+
+	var (
+		mBGPNeighbor = prometheus.NewDesc(
+			"fortigate_bgp_neighbor_ipv6_info",
+			"Confiured bgp neighbor over ipv6",
+			[]string{"vdom", "remote_as", "state", "admin_status", "local_ip", "neighbor_ip"}, nil,
+		)
+	)
+
+	var rs []BGPNeighborResponse
+
+	if err := c.Get("api/v2/monitor/router/bgp/neighbors6", "vdom=*", &rs); err != nil {
+		log.Printf("Error: %v", err)
+		return nil, false
+	}
+
+	m := []prometheus.Metric{}
+
+	for _, r := range rs {
+		major, _, ok := version.ParseVersion(r.Version)
+		if !ok || major < 7 {
+			// not supported version. Before 7.0.0 the requested endpoint doesn't exist
+			return nil, false
+		}
+		for _, peer := range r.Results {
+			m = append(m, prometheus.MustNewConstMetric(mBGPNeighbor, prometheus.GaugeValue, 1, r.VDOM, strconv.Itoa(peer.RemoteAS), peer.State, strconv.FormatBool(peer.AdminStatus), peer.LocalIP, peer.NeighborIP))
+		}
+	}
+
+	return m, true
+}

Diff for: pkg/probe/bgp_neighbors_test.go

@@ -0,0 +1,47 @@
+package probe
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/testutil"
+)
+
+func TestBGPNeighborsIPv4(t *testing.T) {
+	c := newFakeClient()
+	c.prepare("api/v2/monitor/router/bgp/neighbors", "testdata/bpg-neighbors-v4.jsonnet")
+	r := prometheus.NewPedanticRegistry()
+	if !testProbe(probeBGPNeighborsIPv4, c, r) {
+		t.Errorf("probeBGPNeighborsIPv4() returned non-success")
+	}
+
+	em := `
+    # HELP fortigate_bgp_neighbor_ipv4_info Confiured bgp neighbor over ipv4
+    # TYPE fortigate_bgp_neighbor_ipv4_info gauge
+    fortigate_bgp_neighbor_ipv4_info{admin_status="true",local_ip="10.0.0.0",neighbor_ip="10.0.0.1",remote_as="1337",state="Established",vdom="root"} 1
+	`
+
+	if err := testutil.GatherAndCompare(r, strings.NewReader(em)); err != nil {
+		t.Fatalf("metric compare: err %v", err)
+	}
+}
+
+func TestBGPNeighborsIPv6(t *testing.T) {
+	c := newFakeClient()
+	c.prepare("api/v2/monitor/router/bgp/neighbors6", "testdata/bpg-neighbors-v6.jsonnet")
+	r := prometheus.NewPedanticRegistry()
+	if !testProbe(probeBGPNeighborsIPv6, c, r) {
+		t.Errorf("probeBGPNeighborsIPv6() returned non-success")
+	}
+
+	em := `
+    # HELP fortigate_bgp_neighbor_ipv6_info Confiured bgp neighbor over ipv6
+    # TYPE fortigate_bgp_neighbor_ipv6_info gauge
+    fortigate_bgp_neighbor_ipv6_info{admin_status="true",local_ip="fd00::1",neighbor_ip="fd00::2",remote_as="1337",state="Established",vdom="root"} 1
+	`
+
+	if err := testutil.GatherAndCompare(r, strings.NewReader(em)); err != nil {
+		t.Fatalf("metric compare: err %v", err)
+	}
+}

Diff for: pkg/probe/probe.go

@@ -70,6 +70,8 @@ func (p *ProbeCollector) Probe(ctx context.Context, target string, hc *http.Clie
 		probeVirtualWANHealthCheck,
 		probeSystemAvailableCertificates,
 		probeFirewallLoadBalance,
+		probeBGPNeighborsIPv4,
+		probeBGPNeighborsIPv6,
 	} {
 		m, ok := f(c)
 		if !ok {

Diff for: pkg/probe/testdata/bpg-neighbors-v4.jsonnet

@@ -0,0 +1,24 @@
+# api/v2/monitor/router/bgp/neighbors?vdom=*
+[
+  {
+    "http_method":"GET",
+     "results":[
+      {
+        "neighbor_ip":"10.0.0.1",
+        "local_ip":"10.0.0.0",
+        "remote_as":1337,
+        "admin_status":true,
+        "state":"Established",
+        "type":"ipv4"
+      }
+    ],
+    "vdom":"root",
+    "path":"router",
+    "name":"bgp",
+    "action":"neighbors",
+    "status":"success",
+    "serial":"FGT61FT000000000",
+    "version":"v7.0.0",
+    "build":66
+  }
+]

Diff for: pkg/probe/testdata/bpg-neighbors-v6.jsonnet

@@ -0,0 +1,24 @@
+# api/v2/monitor/router/bgp/neighbors6?vdom=*
+[
+  {
+    "http_method":"GET",
+    "results":[
+      {
+        "neighbor_ip":"fd00::2",
+        "local_ip":"fd00::1",
+        "remote_as":1337,
+        "admin_status":true,
+        "state":"Established",
+        "type":"ipv6"
+      }
+    ],
+    "vdom":"root",
+    "path":"router",
+    "name":"bgp",
+    "action":"neighbors6",
+    "status":"success",
+    "serial":"FGT61FT000000000",
+    "version":"v7.0.0",
+    "build":66
+  }
+]