Merge pull request #127 from grafana/126-improve-prometheus-text-metrics

Improve Prometheus text metrics

README.md

@@ -280,7 +280,7 @@ Registry generated from the source above.
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],
@@ -618,15 +618,12 @@ docs/example-api
     ├── community-catalog.json
     ├── community.json
     ├── community-metrics.json
-    ├── community-metrics.txt
     ├── official-catalog.json
     ├── official.json
     ├── official-metrics.json
-    ├── official-metrics.txt
     ├── partner-catalog.json
     ├── partner.json
     ├── partner-metrics.json
-    ├── partner-metrics.txt
     └── at-least
         ├── community-catalog.json
         ├── community.json

cmd/api.go

@@ -66,50 +66,41 @@ func writeAPIGroupGlobal(registry k6registry.Registry, target string) error {
 		return err
 	}
 
-	if err := writeMetrics(registry, target, "", func(_ k6registry.Extension) bool { return true }); err != nil {
-		return err
-	}
-
-	for _, tier := range k6registry.Tiers {
-		err := writeMetrics(registry, filepath.Join(target, "tier"), string(tier)+"-",
-			func(ext k6registry.Extension) bool {
-				return ext.Tier == tier
-			})
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
+	return writeMetrics(registry, target)
 }
 
-func writeMetrics(
-	registry k6registry.Registry,
-	target string,
-	prefix string,
-	cond func(k6registry.Extension) bool,
-) error {
-	metrics := k6registry.CalculateMetricsCond(registry, cond)
+const promPrefix = "registry_"
 
-	basename := "metrics"
+func writeMetrics(registry k6registry.Registry, target string) error {
+	metrics := k6registry.CalculateMetrics(registry)
 
-	if len(prefix) > 0 {
-		basename = prefix + basename
+	if err := writeJSON(filepath.Join(target, "metrics.json"), metrics); err != nil {
+		return err
 	}
 
-	basename = filepath.Join(target, basename)
+	var buff bytes.Buffer
 
-	err := writeJSON(basename+".json", metrics)
-	if err != nil {
+	if err := metrics.WritePrometheus(&buff, promPrefix, ""); err != nil {
 		return err
 	}
 
-	data, err := metrics.MarshalPrometheus()
-	if err != nil {
-		return err
+	for _, tier := range k6registry.Tiers {
+		stier := string(tier)
+
+		metrics := k6registry.CalculateMetricsCond(registry, func(ext k6registry.Extension) bool {
+			return ext.Tier == tier
+		})
+
+		if err := writeJSON(filepath.Join(target, "tier", stier+"-metrics.json"), metrics); err != nil {
+			return err
+		}
+
+		if err := metrics.WritePrometheus(&buff, promPrefix+"tier_"+stier+"_", "Tier "+stier+": "); err != nil {
+			return err
+		}
 	}
 
-	return os.WriteFile(basename+".txt", data, permFile) //nolint:forbidigo
+	return writeData(filepath.Join(target, "metrics.txt"), buff.Bytes())
 }
 
 const gradesvg = `<svg xmlns="http://www.w3.org/2000/svg" width="17" height="20"><clipPath id="B"><rect width="17" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#B)"><path fill="%s" d="M0 0h17v20H0z"/><path fill="url(#A)" d="M0 0h17v20H0z"/></g><g text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text x="85" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="70">%s</text><text x="85" y="140" transform="scale(.1)" fill="#fff" textLength="70">%s</text></g></svg>` //nolint:lll

docs/example-api.txt

@@ -66,15 +66,12 @@ docs/example-api
     ├── community-catalog.json
     ├── community.json
     ├── community-metrics.json
-    ├── community-metrics.txt
     ├── official-catalog.json
     ├── official.json
     ├── official-metrics.json
-    ├── official-metrics.txt
     ├── partner-catalog.json
     ├── partner.json
     ├── partner-metrics.json
-    ├── partner-metrics.txt
     └── at-least
         ├── community-catalog.json
         ├── community.json

docs/example-api/catalog.json

@@ -333,7 +333,7 @@
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],

docs/example-api/category/data.json

@@ -77,7 +77,7 @@
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],

docs/example-api/grade/B.json

@@ -77,7 +77,7 @@
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],

docs/example-api/grade/at-least/B.json

@@ -149,7 +149,7 @@
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],

docs/example-api/grade/at-least/C.json

@@ -215,7 +215,7 @@
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],

docs/example-api/grade/at-least/D.json

@@ -215,7 +215,7 @@
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],

docs/example-api/grade/at-least/E.json

@@ -215,7 +215,7 @@
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],

docs/example-api/grade/at-least/F.json

@@ -215,7 +215,7 @@
       "owner": "grafana",
       "public": true,
       "stars": 63,
-      "timestamp": 1733730893,
+      "timestamp": 1733979175,
       "topics": [
         "xk6"
       ],

docs/example-api/metrics.json

@@ -1,20 +1,20 @@
 {
-  "registry_category_data_count": 2,
-  "registry_category_kubernetes_count": 1,
-  "registry_category_misc_count": 1,
-  "registry_category_observability_count": 1,
-  "registry_category_reporting_count": 1,
-  "registry_extension_count": 5,
-  "registry_grade_a_count": 1,
-  "registry_grade_b_count": 2,
-  "registry_grade_c_count": 2,
-  "registry_issue_examples_count": 1,
-  "registry_issue_smoke_count": 4,
-  "registry_issue_types_count": 2,
-  "registry_product_cloud_count": 1,
-  "registry_product_oss_count": 5,
-  "registry_tier_community_count": 1,
-  "registry_tier_official_count": 4,
-  "registry_type_javascript_count": 4,
-  "registry_type_output_count": 1
+  "category_data_count": 2,
+  "category_kubernetes_count": 1,
+  "category_misc_count": 1,
+  "category_observability_count": 1,
+  "category_reporting_count": 1,
+  "extension_count": 5,
+  "grade_a_count": 1,
+  "grade_b_count": 2,
+  "grade_c_count": 2,
+  "issue_examples_count": 1,
+  "issue_smoke_count": 4,
+  "issue_types_count": 2,
+  "product_cloud_count": 1,
+  "product_oss_count": 5,
+  "tier_community_count": 1,
+  "tier_official_count": 4,
+  "type_javascript_count": 4,
+  "type_output_count": 1
 }