update: reviewers suggestions re optional HELP line support

Signed-off-by: Melissa Kilby <[email protected]>
Co-authored-by: Konrad `ktoso` Malawski <[email protected]>

Author: incertum

Sources/Prometheus/PrometheusCollectorRegistry.swift

@@ -48,14 +48,14 @@ public final class PrometheusCollectorRegistry: Sendable {
     }
 
     private enum Metric {
-        case counter(Counter, String)
-        case counterWithLabels([String], [LabelsKey: Counter], String)
-        case gauge(Gauge, String)
-        case gaugeWithLabels([String], [LabelsKey: Gauge], String)
-        case durationHistogram(DurationHistogram, String)
-        case durationHistogramWithLabels([String], [LabelsKey: DurationHistogram], [Duration], String)
-        case valueHistogram(ValueHistogram, String)
-        case valueHistogramWithLabels([String], [LabelsKey: ValueHistogram], [Double], String)
+        case counter(Counter, help: String)
+        case counterWithLabels([String], [LabelsKey: Counter], help: String)
+        case gauge(Gauge, help: String)
+        case gaugeWithLabels([String], [LabelsKey: Gauge], help: String)
+        case durationHistogram(DurationHistogram, help: String)
+        case durationHistogramWithLabels([String], [LabelsKey: DurationHistogram], [Duration], help: String)
+        case valueHistogram(ValueHistogram, help: String)
+        case valueHistogramWithLabels([String], [LabelsKey: ValueHistogram], [Double], help: String)
     }
 
     private let box = NIOLockedValueBox([String: Metric]())
@@ -79,7 +79,7 @@ public final class PrometheusCollectorRegistry: Sendable {
         return self.box.withLockedValue { store -> Counter in
             guard let value = store[name] else {
                 let counter = Counter(name: name, labels: [])
-                store[name] = .counter(counter, help)
+                store[name] = .counter(counter, help: help)
                 return counter
             }
             guard case .counter(let counter, _) = value else {
@@ -131,7 +131,7 @@ public final class PrometheusCollectorRegistry: Sendable {
                 let labelNames = labels.allLabelNames
                 let counter = Counter(name: name, labels: labels)
 
-                store[name] = .counterWithLabels(labelNames, [LabelsKey(labels): counter], help)
+                store[name] = .counterWithLabels(labelNames, [LabelsKey(labels): counter], help: help)
                 return counter
             }
             guard case .counterWithLabels(let labelNames, var dimensionLookup, let help) = value else {
@@ -161,7 +161,7 @@ public final class PrometheusCollectorRegistry: Sendable {
 
             let counter = Counter(name: name, labels: labels)
             dimensionLookup[key] = counter
-            store[name] = .counterWithLabels(labelNames, dimensionLookup, help)
+            store[name] = .counterWithLabels(labelNames, dimensionLookup, help: help)
             return counter
         }
     }
@@ -194,7 +194,7 @@ public final class PrometheusCollectorRegistry: Sendable {
         return self.box.withLockedValue { store -> Gauge in
             guard let value = store[name] else {
                 let gauge = Gauge(name: name, labels: [])
-                store[name] = .gauge(gauge, help)
+                store[name] = .gauge(gauge, help: help)
                 return gauge
             }
             guard case .gauge(let gauge, _) = value else {
@@ -246,7 +246,7 @@ public final class PrometheusCollectorRegistry: Sendable {
                 let labelNames = labels.allLabelNames
                 let gauge = Gauge(name: name, labels: labels)
 
-                store[name] = .gaugeWithLabels(labelNames, [LabelsKey(labels): gauge], help)
+                store[name] = .gaugeWithLabels(labelNames, [LabelsKey(labels): gauge], help: help)
                 return gauge
             }
             guard case .gaugeWithLabels(let labelNames, var dimensionLookup, let help) = value else {
@@ -276,7 +276,7 @@ public final class PrometheusCollectorRegistry: Sendable {
 
             let gauge = Gauge(name: name, labels: labels)
             dimensionLookup[key] = gauge
-            store[name] = .gaugeWithLabels(labelNames, dimensionLookup, help)
+            store[name] = .gaugeWithLabels(labelNames, dimensionLookup, help: help)
             return gauge
         }
     }
@@ -310,7 +310,7 @@ public final class PrometheusCollectorRegistry: Sendable {
         return self.box.withLockedValue { store -> DurationHistogram in
             guard let value = store[name] else {
                 let gauge = DurationHistogram(name: name, labels: [], buckets: buckets)
-                store[name] = .durationHistogram(gauge, help)
+                store[name] = .durationHistogram(gauge, help: help)
                 return gauge
             }
             guard case .durationHistogram(let histogram, _) = value else {
@@ -369,7 +369,12 @@ public final class PrometheusCollectorRegistry: Sendable {
                 let labelNames = labels.allLabelNames
                 let histogram = DurationHistogram(name: name, labels: labels, buckets: buckets)
 
-                store[name] = .durationHistogramWithLabels(labelNames, [LabelsKey(labels): histogram], buckets, help)
+                store[name] = .durationHistogramWithLabels(
+                    labelNames,
+                    [LabelsKey(labels): histogram],
+                    buckets,
+                    help: help
+                )
                 return histogram
             }
             guard
@@ -413,7 +418,7 @@ public final class PrometheusCollectorRegistry: Sendable {
 
             let histogram = DurationHistogram(name: name, labels: labels, buckets: storedBuckets)
             dimensionLookup[key] = histogram
-            store[name] = .durationHistogramWithLabels(labelNames, dimensionLookup, storedBuckets, help)
+            store[name] = .durationHistogramWithLabels(labelNames, dimensionLookup, storedBuckets, help: help)
             return histogram
         }
     }
@@ -457,7 +462,7 @@ public final class PrometheusCollectorRegistry: Sendable {
         return self.box.withLockedValue { store -> ValueHistogram in
             guard let value = store[name] else {
                 let gauge = ValueHistogram(name: name, labels: [], buckets: buckets)
-                store[name] = .valueHistogram(gauge, help)
+                store[name] = .valueHistogram(gauge, help: help)
                 return gauge
             }
             guard case .valueHistogram(let histogram, _) = value else {
@@ -511,7 +516,7 @@ public final class PrometheusCollectorRegistry: Sendable {
                 let labelNames = labels.allLabelNames
                 let histogram = ValueHistogram(name: name, labels: labels, buckets: buckets)
 
-                store[name] = .valueHistogramWithLabels(labelNames, [LabelsKey(labels): histogram], buckets, help)
+                store[name] = .valueHistogramWithLabels(labelNames, [LabelsKey(labels): histogram], buckets, help: help)
                 return histogram
             }
             guard
@@ -531,7 +536,7 @@ public final class PrometheusCollectorRegistry: Sendable {
 
             let histogram = ValueHistogram(name: name, labels: labels, buckets: storedBuckets)
             dimensionLookup[key] = histogram
-            store[name] = .valueHistogramWithLabels(labelNames, dimensionLookup, storedBuckets, help)
+            store[name] = .valueHistogramWithLabels(labelNames, dimensionLookup, storedBuckets, help: help)
             return histogram
         }
     }
@@ -582,7 +587,7 @@ public final class PrometheusCollectorRegistry: Sendable {
                 if dimensions.isEmpty {
                     store.removeValue(forKey: counter.name)
                 } else {
-                    store[counter.name] = .counterWithLabels(labelNames, dimensions, help)
+                    store[counter.name] = .counterWithLabels(labelNames, dimensions, help: help)
                 }
             default:
                 return
@@ -608,7 +613,7 @@ public final class PrometheusCollectorRegistry: Sendable {
                 if dimensions.isEmpty {
                     store.removeValue(forKey: gauge.name)
                 } else {
-                    store[gauge.name] = .gaugeWithLabels(labelNames, dimensions, help)
+                    store[gauge.name] = .gaugeWithLabels(labelNames, dimensions, help: help)
                 }
             default:
                 return
@@ -634,7 +639,7 @@ public final class PrometheusCollectorRegistry: Sendable {
                 if dimensions.isEmpty {
                     store.removeValue(forKey: histogram.name)
                 } else {
-                    store[histogram.name] = .durationHistogramWithLabels(labelNames, dimensions, buckets, help)
+                    store[histogram.name] = .durationHistogramWithLabels(labelNames, dimensions, buckets, help: help)
                 }
             default:
                 return
@@ -660,7 +665,7 @@ public final class PrometheusCollectorRegistry: Sendable {
                 if dimensions.isEmpty {
                     store.removeValue(forKey: histogram.name)
                 } else {
-                    store[histogram.name] = .valueHistogramWithLabels(labelNames, dimensions, buckets, help)
+                    store[histogram.name] = .valueHistogramWithLabels(labelNames, dimensions, buckets, help: help)
                 }
             default:
                 return