feat: add ASN metrics

Add cloudflare_zone_requests_asn and cloudflare_zone_bandwidth_asn
to track traffic by ISP/network operator

Author: Gamze Nur Kabakci

cloudflare.go

@@ -85,6 +85,33 @@ type cloudflareResponseLogpushZone struct {
 	} `json:"viewer"`
 }
 
+type cloudflareResponseASN struct {
+	Viewer struct {
+		Zones []zoneRespASN `json:"zones"`
+	} `json:"viewer"`
+}
+
+type zoneRespASN struct {
+	ZoneTag string `json:"zoneTag"`
+
+	HttpRequestsASNGroups []struct {
+		Count      uint64 `json:"count"`
+		Dimensions struct {
+			Datetime             string `json:"datetime"`
+			ClientASN            string `json:"clientAsn"`
+			ClientASNDescription string `json:"clientASNDescription"`
+		} `json:"dimensions"`
+		Sum struct {
+			EdgeResponseBytes uint64 `json:"edgeResponseBytes"`
+			Visits            uint64 `json:"visits"`
+		} `json:"sum"`
+		Avg struct {
+			SampleInterval float64 `json:"sampleInterval"`
+		} `json:"avg"`
+	} `json:"httpRequestsAdaptiveGroups"`
+}
+
+
 type logpushResponse struct {
 	LogpushHealthAdaptiveGroups []struct {
 		Count uint64 `json:"count"`
@@ -1010,3 +1037,54 @@ func filterNonFreePlanZones(zones []cfzones.Zone) (filteredZones []cfzones.Zone)
 	}
 	return
 }
+
+func fetchASNTotals(zoneIDs []string) (*cloudflareResponseASN, error) {
+	request := graphql.NewRequest(`
+	query ($zoneIDs: [String!], $mintime: Time!, $maxtime: Time!, $limit: Int!) {
+		viewer {
+			zones(filter: { zoneTag_in: $zoneIDs }) {
+				zoneTag
+				httpRequestsAdaptiveGroups(
+					limit: $limit
+					filter: { datetime_geq: $mintime, datetime_lt: $maxtime }
+					orderBy: [count_DESC]
+				) {
+					count
+					avg {
+						sampleInterval
+					}
+					dimensions {
+						datetime
+						clientAsn
+						clientASNDescription
+					}
+					sum {
+						edgeResponseBytes
+						visits
+					}
+				}
+			}
+		}
+	}
+`)
+
+	now, now1mAgo := GetTimeRange()
+	request.Var("limit", gqlQueryLimit)
+	request.Var("maxtime", now)
+	request.Var("mintime", now1mAgo)
+	request.Var("zoneIDs", zoneIDs)
+
+	gql.Mu.RLock()
+	defer gql.Mu.RUnlock()
+
+	ctx, cancel := context.WithTimeout(context.Background(), cftimeout)
+	defer cancel()
+
+	var resp cloudflareResponseASN
+	if err := gql.Client.Run(ctx, request, &resp); err != nil {
+		log.Errorf("failed to fetch ASN totals, err:%v", err)
+		return nil, err
+	}
+
+	return &resp, nil
+}

main.go

@@ -146,6 +146,9 @@ func fetchMetrics() {
 
 		wg.Add(1)
 		go fetchLogpushAnalyticsForZone(filteredZones, &wg)
+
+		wg.Add(1)
+		go fetchZoneASNAnalytics(filteredZones, &wg)
 	} else if zoneCount > cfgraphqlreqlimit {
 		for s := 0; s < zoneCount; s += cfgraphqlreqlimit {
 			e := s + cfgraphqlreqlimit
@@ -163,6 +166,9 @@ func fetchMetrics() {
 
 			wg.Add(1)
 			go fetchLogpushAnalyticsForZone(filteredZones[s:e], &wg)
+
+			wg.Add(1)
+			go fetchZoneASNAnalytics(filteredZones[s:e], &wg)
 		}
 	}
 

prometheus.go

@@ -63,6 +63,8 @@ const (
 	tunnelHealthStatusMetricName                    MetricName = "cloudflare_tunnel_health_status"
 	tunnelConnectorInfoMetricName                   MetricName = "cloudflare_tunnel_connector_info"
 	tunnelConnectorActiveConnectionsMetricName      MetricName = "cloudflare_tunnel_connector_active_connections"
+	zoneRequestASNMetricName                     MetricName = "cloudflare_zone_requests_asn"
+	zoneBandwidthASNMetricName                   MetricName = "cloudflare_zone_bandwidth_asn"
 )
 
 type MetricsSet map[MetricName]struct{}
@@ -334,6 +336,16 @@ var (
 		Name: tunnelConnectorActiveConnectionsMetricName.String(),
 		Help: "Reports number of active connections for a Cloudflare Tunnel connector",
 	}, []string{"account", "tunnel_id", "client_id"})
+
+	zoneRequestASN = prometheus.NewCounterVec(prometheus.CounterOpts{
+		Name: zoneRequestASNMetricName.String(),
+		Help: "Number of requests per ASN (Autonomous System Number)",
+	}, []string{"zone", "account", "asn", "asn_description"})
+
+	zoneBandwidthASN = prometheus.NewCounterVec(prometheus.CounterOpts{
+		Name: zoneBandwidthASNMetricName.String(),
+		Help: "Bandwidth per ASN (Autonomous System Number) in bytes",
+	}, []string{"zone", "account", "asn", "asn_description"})
 )
 
 func buildAllMetricsSet() MetricsSet {
@@ -377,6 +389,8 @@ func buildAllMetricsSet() MetricsSet {
 	allMetricsSet.Add(tunnelHealthStatusMetricName)
 	allMetricsSet.Add(tunnelConnectorInfoMetricName)
 	allMetricsSet.Add(tunnelConnectorActiveConnectionsMetricName)
+	allMetricsSet.Add(zoneRequestASNMetricName)
+	allMetricsSet.Add(zoneBandwidthASNMetricName)
 	return allMetricsSet
 }
 
@@ -523,6 +537,12 @@ func mustRegisterMetrics(deniedMetrics MetricsSet) {
 	if !deniedMetrics.Has(tunnelConnectorActiveConnectionsMetricName) {
 		prometheus.MustRegister(tunnelConnectorActiveConnections)
 	}
+	if !deniedMetrics.Has(zoneRequestASNMetricName) {
+		prometheus.MustRegister(zoneRequestASN)
+	}
+	if !deniedMetrics.Has(zoneBandwidthASNMetricName) {
+		prometheus.MustRegister(zoneBandwidthASN)
+	}
 }
 
 func fetchLoadblancerPoolsHealth(account cfaccounts.Account, wg *sync.WaitGroup) {
@@ -1038,3 +1058,48 @@ func getCloudflareTunnelStatusValue(status string) uint8 {
 		return 255
 	}
 }
+
+func fetchZoneASNAnalytics(zones []cfzones.Zone, wg *sync.WaitGroup) {
+	defer wg.Done()
+
+	// ASN metrics are not available in free tier
+	if viper.GetBool("free_tier") {
+		return
+	}
+
+	zoneIDs := extractZoneIDs(zones)
+	if len(zoneIDs) == 0 {
+		return
+	}
+
+	r, err := fetchASNTotals(zoneIDs)
+	if err != nil {
+		return
+	}
+
+	for _, z := range r.Viewer.Zones {
+		name, account := findZoneAccountName(zones, z.ZoneTag)
+		addASNGroups(&z, name, account)
+	}
+}
+
+func addASNGroups(z *zoneRespASN, name string, account string) {
+	if len(z.HttpRequestsASNGroups) == 0 {
+		return
+	}
+
+	for _, g := range z.HttpRequestsASNGroups {
+		asn := g.Dimensions.ClientASN
+		asnDesc := g.Dimensions.ClientASNDescription
+		if asnDesc == "" {
+			asnDesc = "unknown"
+		}
+
+		zoneRequestASN.With(prometheus.Labels{
+			"zone": name, "account": account, "asn": asn, "asn_description": asnDesc,
+		}).Add(float64(g.Count))
+		zoneBandwidthASN.With(prometheus.Labels{
+			"zone": name, "account": account, "asn": asn, "asn_description": asnDesc,
+		}).Add(float64(g.Sum.EdgeResponseBytes))
+	}
+}