Remove docs & update getMetrics()

Author: MrLotU

README.md

@@ -117,7 +117,7 @@ To keep SwiftPrometheus as clean and lightweight as possible, there is no way of
 This could look something like this:
 ```swift
 router.get("/metrics") { request -> String in
-    return myProm.getMetrics()
+    return myProm.collect()
 }
 ```
 Here, I used [Vapor](https://github.com/vapor/vapor) syntax, but this will work with any web framework, since it's just returning a plain String.

Sources/Prometheus/MetricTypes/Counter.swift

@@ -47,7 +47,7 @@ public class PromCounter<NumType: Numeric, Labels: MetricLabels>: PromMetric, Pr
     ///
     /// - Returns:
     ///     Newline seperated Prometheus formatted metric string
-    public func getMetric() -> String {
+    public func collect() -> String {
         return self.lock.withLock {
             var output = [String]()
 

Sources/Prometheus/MetricTypes/Gauge.swift

@@ -48,7 +48,7 @@ public class PromGauge<NumType: Numeric, Labels: MetricLabels>: PromMetric, Prom
     ///
     /// - Returns:
     ///     Newline seperated Prometheus formatted metric string
-    public func getMetric() -> String {
+    public func collect() -> String {
         return self.lock.withLock {
             var output = [String]()
 

Sources/Prometheus/MetricTypes/Histogram.swift

@@ -78,7 +78,7 @@ public class PromHistogram<NumType: DoubleRepresentable, Labels: HistogramLabels
     ///
     /// - Returns:
     ///     Newline seperated Prometheus formatted metric string
-    public func getMetric() -> String {
+    public func collect() -> String {
         return self.lock.withLock {
             var output = [String]()
 

Sources/Prometheus/MetricTypes/PromMetric.swift

@@ -31,7 +31,7 @@ public protocol PromMetric {
     var _type: PromMetricType { get }
 
     /// Retrieves the Prometheus-formatted metric data
-    func getMetric() -> String
+    func collect() -> String
 }
 
 /// Adding a prometheus instance to all metrics

Sources/Prometheus/MetricTypes/Summary.swift

@@ -79,7 +79,7 @@ public class PromSummary<NumType: DoubleRepresentable, Labels: SummaryLabels>: P
     ///
     /// - Returns:
     ///     Newline seperated Prometheus formatted metric string
-    public func getMetric() -> String {
+    public func collect() -> String {
         return self.lock.withLock {
             var output = [String]()
 

Sources/Prometheus/Prometheus.swift

@@ -25,9 +25,9 @@ public class PrometheusClient {
     /// Creates prometheus formatted metrics
     ///
     /// - Returns: Newline seperated string with metrics for all Metric Trackers of this Prometheus instance
-    public func getMetrics() -> String {
+    public func collect() -> String {
         return self.lock.withLock {
-            return self.metrics.map { $0.getMetric() }.joined(separator: "\n")
+            return self.metrics.map { $0.collect() }.joined(separator: "\n")
         }
     }
 

Sources/PrometheusExample/main.swift

@@ -113,5 +113,5 @@ for _ in 0...Int.random(in: 100...1000) {
    summary.observe(Double.random(in: 0...10000), SummaryThing("/test"))
 }
 
-let metrics = try! MetricsSystem.prometheus().getMetrics()
+let metrics = try! MetricsSystem.prometheus().collect()
 print(metrics)

Tests/SwiftPrometheusTests/PrometheusMetricsTests.swift

@@ -22,7 +22,7 @@ final class PrometheusMetricsTests: XCTestCase {
         let counterTwo = Counter(label: "my_counter", dimensions: [("myValue", "labels")])
         counterTwo.increment(by: 10)
 
-        XCTAssertEqual(prom.getMetrics(), """
+        XCTAssertEqual(prom.collect(), """
         # TYPE my_counter counter
         my_counter 10
         my_counter{myValue=\"labels\"} 10
@@ -39,7 +39,7 @@ final class PrometheusMetricsTests: XCTestCase {
         let gaugeTwo = Gauge(label: "my_gauge", dimensions: [("myValue", "labels")])
         gaugeTwo.record(10)
 
-        XCTAssertEqual(prom.getMetrics(), """
+        XCTAssertEqual(prom.collect(), """
         # TYPE my_gauge gauge
         my_gauge 42.0
         my_gauge{myValue=\"labels\"} 10.0
@@ -55,7 +55,7 @@ final class PrometheusMetricsTests: XCTestCase {
         let recorderTwo = Recorder(label: "my_histogram", dimensions: [("myValue", "labels")])
         recorderTwo.record(3)
 
-        XCTAssertEqual(prom.getMetrics(), """
+        XCTAssertEqual(prom.collect(), """
         # TYPE my_histogram histogram
         my_histogram_bucket{le="0.005"} 0.0
         my_histogram_bucket{le="0.01"} 0.0
@@ -105,7 +105,7 @@ final class PrometheusMetricsTests: XCTestCase {
         let summaryTwo = Timer(label: "my_summary", dimensions: [("myValue", "labels")])
         summaryTwo.recordNanoseconds(123)
 
-        XCTAssertEqual(prom.getMetrics(), """
+        XCTAssertEqual(prom.collect(), """
         # TYPE my_summary summary
         my_summary{quantile="0.01"} 1.0
         my_summary{quantile="0.05"} 1.0
@@ -132,7 +132,7 @@ final class PrometheusMetricsTests: XCTestCase {
         let counter = Counter(label: "my_counter")
         counter.increment()
         counter.destroy()
-        XCTAssertEqual(prom.getMetrics(), "")
+        XCTAssertEqual(prom.collect(), "")
     }
 }
 

Tests/SwiftPrometheusTests/SwiftPrometheusTests.swift

@@ -60,7 +60,7 @@ final class SwiftPrometheusTests: XCTestCase {
         XCTAssertEqual(counter.get(), 20)
         XCTAssertEqual(counter.get(BaseLabels(myValue: "labels")), 20)
 
-        XCTAssertEqual(counter.getMetric(), "# HELP my_counter Counter for testing\n# TYPE my_counter counter\nmy_counter 20\nmy_counter{myValue=\"labels\"} 20")
+        XCTAssertEqual(counter.collect(), "# HELP my_counter Counter for testing\n# TYPE my_counter counter\nmy_counter 20\nmy_counter{myValue=\"labels\"} 20")
     }
 
     func testGauge() {
@@ -75,7 +75,7 @@ final class SwiftPrometheusTests: XCTestCase {
         XCTAssertEqual(gauge.get(), 20)
         XCTAssertEqual(gauge.get(BaseLabels(myValue: "labels")), 20)
 
-        XCTAssertEqual(gauge.getMetric(), "# HELP my_gauge Gauge for testing\n# TYPE my_gauge gauge\nmy_gauge 20\nmy_gauge{myValue=\"labels\"} 20")
+        XCTAssertEqual(gauge.collect(), "# HELP my_gauge Gauge for testing\n# TYPE my_gauge gauge\nmy_gauge 20\nmy_gauge{myValue=\"labels\"} 20")
     }
 
     func testHistogram() {
@@ -86,7 +86,7 @@ final class SwiftPrometheusTests: XCTestCase {
 
         histogram.observe(3, .init(myValue: "labels"))
 
-        XCTAssertEqual(histogram.getMetric(), "# HELP my_histogram Histogram for testing\n# TYPE my_histogram histogram\nmy_histogram_bucket{myValue=\"*\", le=\"0.5\"} 0.0\nmy_histogram_bucket{myValue=\"*\", le=\"1.0\"} 1.0\nmy_histogram_bucket{myValue=\"*\", le=\"2.0\"} 2.0\nmy_histogram_bucket{myValue=\"*\", le=\"3.0\"} 4.0\nmy_histogram_bucket{myValue=\"*\", le=\"5.0\"} 4.0\nmy_histogram_bucket{myValue=\"*\", le=\"+Inf\"} 4.0\nmy_histogram_count{myValue=\"*\"} 4.0\nmy_histogram_sum{myValue=\"*\"} 9.0\nmy_histogram_bucket{myValue=\"labels\", le=\"0.5\"} 0.0\nmy_histogram_bucket{myValue=\"labels\", le=\"1.0\"} 0.0\nmy_histogram_bucket{myValue=\"labels\", le=\"2.0\"} 0.0\nmy_histogram_bucket{myValue=\"labels\", le=\"3.0\"} 1.0\nmy_histogram_bucket{myValue=\"labels\", le=\"5.0\"} 1.0\nmy_histogram_bucket{myValue=\"labels\", le=\"+Inf\"} 1.0\nmy_histogram_count{myValue=\"labels\"} 1.0\nmy_histogram_sum{myValue=\"labels\"} 3.0")
+        XCTAssertEqual(histogram.collect(), "# HELP my_histogram Histogram for testing\n# TYPE my_histogram histogram\nmy_histogram_bucket{myValue=\"*\", le=\"0.5\"} 0.0\nmy_histogram_bucket{myValue=\"*\", le=\"1.0\"} 1.0\nmy_histogram_bucket{myValue=\"*\", le=\"2.0\"} 2.0\nmy_histogram_bucket{myValue=\"*\", le=\"3.0\"} 4.0\nmy_histogram_bucket{myValue=\"*\", le=\"5.0\"} 4.0\nmy_histogram_bucket{myValue=\"*\", le=\"+Inf\"} 4.0\nmy_histogram_count{myValue=\"*\"} 4.0\nmy_histogram_sum{myValue=\"*\"} 9.0\nmy_histogram_bucket{myValue=\"labels\", le=\"0.5\"} 0.0\nmy_histogram_bucket{myValue=\"labels\", le=\"1.0\"} 0.0\nmy_histogram_bucket{myValue=\"labels\", le=\"2.0\"} 0.0\nmy_histogram_bucket{myValue=\"labels\", le=\"3.0\"} 1.0\nmy_histogram_bucket{myValue=\"labels\", le=\"5.0\"} 1.0\nmy_histogram_bucket{myValue=\"labels\", le=\"+Inf\"} 1.0\nmy_histogram_count{myValue=\"labels\"} 1.0\nmy_histogram_sum{myValue=\"labels\"} 3.0")
     }
 
     func testSummary() {
@@ -99,6 +99,6 @@ final class SwiftPrometheusTests: XCTestCase {
 
         summary.observe(123, .init(myValue: "labels"))
 
-        XCTAssertEqual(summary.getMetric(), "# HELP my_summary Summary for testing\n# TYPE my_summary summary\nmy_summary{quantile=\"0.5\", myValue=\"*\"} 4.0\nmy_summary{quantile=\"0.9\", myValue=\"*\"} 10000.0\nmy_summary{quantile=\"0.99\", myValue=\"*\"} 10000.0\nmy_summary_count{myValue=\"*\"} 5.0\nmy_summary_sum{myValue=\"*\"} 10130.0\nmy_summary{quantile=\"0.5\", myValue=\"labels\"} 123.0\nmy_summary{quantile=\"0.9\", myValue=\"labels\"} 123.0\nmy_summary{quantile=\"0.99\", myValue=\"labels\"} 123.0\nmy_summary_count{myValue=\"labels\"} 1.0\nmy_summary_sum{myValue=\"labels\"} 123.0")
+        XCTAssertEqual(summary.collect(), "# HELP my_summary Summary for testing\n# TYPE my_summary summary\nmy_summary{quantile=\"0.5\", myValue=\"*\"} 4.0\nmy_summary{quantile=\"0.9\", myValue=\"*\"} 10000.0\nmy_summary{quantile=\"0.99\", myValue=\"*\"} 10000.0\nmy_summary_count{myValue=\"*\"} 5.0\nmy_summary_sum{myValue=\"*\"} 10130.0\nmy_summary{quantile=\"0.5\", myValue=\"labels\"} 123.0\nmy_summary{quantile=\"0.9\", myValue=\"labels\"} 123.0\nmy_summary{quantile=\"0.99\", myValue=\"labels\"} 123.0\nmy_summary_count{myValue=\"labels\"} 1.0\nmy_summary_sum{myValue=\"labels\"} 123.0")
     }
 }