Merge branch 'master' into add-r2-metrics

Author: haad

Dockerfile

@@ -1,4 +1,5 @@
-FROM golang:alpine as builder
+# check=skip=SecretsUsedInArgOrEnv we're just set default here, not any secret data
+FROM golang:alpine AS builder
 
 WORKDIR /app
 
@@ -17,7 +18,7 @@ RUN apk update && apk add ca-certificates
 
 COPY --from=builder /app/cloudflare_exporter cloudflare_exporter
 
-ENV CF_API_KEY ""
-ENV CF_API_EMAIL ""
+ENV CF_API_KEY=""
+ENV CF_API_EMAIL=""
 
 ENTRYPOINT [ "./cloudflare_exporter" ]

README.md

@@ -23,12 +23,12 @@ The preferred way of authenticating is with an API token, for which the scope ca
 dashboard.
 
 Required authentication scopes:
-- `Analytics:Read` is required for zone-level metrics
-- `Account.Account Analytics:Read` is required for Worker metrics
-- `Account Settings:Read` is required for Worker metrics (for listing accessible accounts, scraping all available
+- `Zone/Analytics:Read` is required for zone-level metrics
+- `Account/Account Analytics:Read` is required for Worker metrics
+- `Account/Account Settings:Read` is required for Worker metrics (for listing accessible accounts, scraping all available
   Workers included in authentication scope)
-- `Firewall Services:Read` is required to fetch zone rule name for `cloudflare_zone_firewall_events_count` metric
-- `Account. Account Rulesets:Read` is required to fetch account rule name for `cloudflare_zone_firewall_events_count` metric
+- `Zone/Firewall Services:Read` is required to fetch zone rule name for `cloudflare_zone_firewall_events_count` metric
+- `Account/Account Rulesets:Read` is required to fetch account rule name for `cloudflare_zone_firewall_events_count` metric
 
 To authenticate this way, only set `CF_API_TOKEN` (omit `CF_API_EMAIL` and `CF_API_KEY`)
 

cloudflare.go

@@ -311,7 +311,17 @@ func fetchFirewallRules(zoneID string) map[string]string {
 		if rulesetDesc.Phase == "http_request_firewall_managed" {
 			ruleset, err := cloudflareAPI.GetRuleset(ctx, cloudflare.ZoneIdentifier(zoneID), rulesetDesc.ID)
 			if err != nil {
-				log.Fatalf("Error fetching ruleset: %s", err)
+        log.Fatalf("Error fetching ruleset for firewall rules: %s", err)
+			}
+			for _, rule := range ruleset.Rules {
+				firewallRulesMap[rule.ID] = rule.Description
+			}
+		}
+
+		if rulesetDesc.Phase == "http_request_firewall_custom" {
+			ruleset, err := api.GetRuleset(ctx, cloudflare.ZoneIdentifier(zoneID), rulesetDesc.ID)
+			if err != nil {
+        log.Fatal("Error fetching custom firewall rulesets: %s" err)
 			}
 			for _, rule := range ruleset.Rules {
 				firewallRulesMap[rule.ID] = rule.Description
@@ -451,7 +461,7 @@ query ($zoneIDs: [String!], $mintime: Time!, $maxtime: Time!, $limit: Int!) {
 
 	var resp cloudflareResponse
 	if err := graphqlClient.Run(ctx, request, &resp); err != nil {
-		log.Error(err)
+		log.Error("failed to fetch zone totals: ", err)
 		return nil, err
 	}
 
@@ -506,7 +516,7 @@ func fetchColoTotals(zoneIDs []string) (*cloudflareResponseColo, error) {
 	graphqlClient := graphql.NewClient(cfGraphQLEndpoint)
 	var resp cloudflareResponseColo
 	if err := graphqlClient.Run(ctx, request, &resp); err != nil {
-		log.Error(err)
+		log.Error("failed to fetch colocation totals: ", err)
 		return nil, err
 	}
 

main.go

@@ -207,7 +207,7 @@ func runExporter() {
 func main() {
 	var cmd = &cobra.Command{
 		Use:   "cloudflare_exporter",
-		Short: "Export Cloudflare metrics to Prometheus",
+		Short: "Prometheus exporter exposing Cloudflare Analytics dashboard data on a per-zone basis, as well as Worker metrics",
 		Run: func(_ *cobra.Command, _ []string) {
 			runExporter()
 		},
@@ -217,7 +217,7 @@ func main() {
 
 	flags := cmd.Flags()
 
-	flags.String("listen", ":8080", "listen on addr:port, omit addr to listen on all interfaces")
+	flags.String("listen", ":8080", "listen on addr:port (default :8080), omit addr to listen on all interfaces")
 	viper.BindEnv("listen")
 	viper.SetDefault("listen", ":8080")
 
@@ -234,11 +234,11 @@ func main() {
 	flags.String("cf_api_token", "", "cloudflare api token (preferred)")
 	viper.BindEnv("cf_api_token")
 
-	flags.String("cf_zones", "", "cloudflare zones to export, comma delimited list")
+	flags.String("cf_zones", "", "cloudflare zones to export, comma delimited list of zone ids")
 	viper.BindEnv("cf_zones")
 	viper.SetDefault("cf_zones", "")
 
-	flags.String("cf_exclude_zones", "", "cloudflare zones to exclude, comma delimited list")
+	flags.String("cf_exclude_zones", "", "cloudflare zones to exclude, comma delimited list of zone ids")
 	viper.BindEnv("cf_exclude_zones")
 	viper.SetDefault("cf_exclude_zones", "")