Add NEUTRON_ROUTER_EXTERNAL_NETWORK_ID Filter (#7)

Signed-off-by: Freerk-Ole Zakfeld <fzakfeld@scaleuptech.com>

Author: fzakfeld

README.md

@@ -52,4 +52,8 @@ DESIGNATE_ENABLED=true
 MANILA_ENABLED=false
 NEUTRON_ENABLED=true
 OCTAVIA_ENABLED=true
+
+# Routers returned by the Neutron Exporter are filtered by a specific external network ID.
+# This is designed to only count the usage of routers which are connected to an external network.
+NEUTRON_ROUTER_EXTERNAL_NETWORK_ID=5d8722dd-186c-4e32-a170-b216a04688dc
 ```

exporters/neutron.go

@@ -8,14 +8,16 @@ import (
 )
 
 type NeutronUsageExporter struct {
-	db          *sql.DB
-	floatingIPs *prometheus.Desc
-	routers     *prometheus.Desc
+	db                *sql.DB
+	externalNetworkId string
+	floatingIPs       *prometheus.Desc
+	routers           *prometheus.Desc
 }
 
-func NewNeutronUsageExporter(db *sql.DB) (*NeutronUsageExporter, error) {
+func NewNeutronUsageExporter(db *sql.DB, externalNetworkId string) (*NeutronUsageExporter, error) {
 	return &NeutronUsageExporter{
-		db: db,
+		db:                db,
+		externalNetworkId: externalNetworkId,
 		floatingIPs: prometheus.NewDesc(
 			"openstack_project_floating_ips",
 			"Total number of floating IPs per OpenStack project",
@@ -63,7 +65,7 @@ func (e *NeutronUsageExporter) collectMetrics(ch chan<- prometheus.Metric) {
 	}
 
 	routerCounts := make(map[string]float64)
-	rows, err = e.db.Query("SELECT project_id, COUNT(id) AS total_routers FROM routers GROUP BY project_id")
+	rows, err = e.db.Query("SELECT r.project_id, COUNT(r.id) AS total_routers FROM routers r INNER JOIN ports p ON r.gw_port_id = p.id WHERE p.network_id = ? GROUP BY r.project_id", e.externalNetworkId)
 	if err != nil {
 		log.Println("Error querying router counts:", err)
 		return

exporters/neutron_test.go

@@ -23,9 +23,9 @@ func TestNeutronUsageExporter(t *testing.T) {
 	routerRows := sqlmock.NewRows([]string{"project_id", "total_routers"}).
 		AddRow("c352b0ed-30ca-4634-9c2d-1947efc29096", 1).
 		AddRow("6ee08ba2-2ca1-4c91-b139-4bf0dbaa4096", 2)
-	mock.ExpectQuery("SELECT project_id, COUNT\\(id\\) AS total_routers FROM routers GROUP BY project_id").WillReturnRows(routerRows)
+	mock.ExpectQuery("SELECT r.project_id, COUNT\\(r.id\\) AS total_routers FROM routers r").WithArgs("5d8722dd-186c-4e32-a170-b216a04688dc").WillReturnRows(routerRows)
 
-	exporter, err := NewNeutronUsageExporter(db)
+	exporter, err := NewNeutronUsageExporter(db, "5d8722dd-186c-4e32-a170-b216a04688dc")
 	if err != nil {
 		t.Fatalf("Failed to create NeutronUsageExporter: %v", err)
 	}

main.go

@@ -69,7 +69,11 @@ func main() {
 			}
 			exporter, err = exporters.NewNovaTraitUsageExporter(db, trait)
 		case "neutron":
-			exporter, err = exporters.NewNeutronUsageExporter(db)
+			externalNetworkId, exists := os.LookupEnv("NEUTRON_ROUTER_EXTERNAL_NETWORK_ID")
+			if !exists {
+				log.Fatalf("NEUTRON_ROUTER_EXTERNAL_NETWORK_ID not set")
+			}
+			exporter, err = exporters.NewNeutronUsageExporter(db, externalNetworkId)
 		case "designate":
 			exporter, err = exporters.NewDesignateUsageExporter(db)
 		case "octavia":