Cleanup and start on final integration

Author: MrLotU

Sources/Prometheus/Prometheus.swift

@@ -1,3 +1,101 @@
-open class Prometheus {
+public class Prometheus {
+    /// Singleton instance
+    ///
+    /// Use this to create Metric trackers and retrieve your data,
+    /// so you don't have to keep track of an instance.
+    public static let shared = Prometheus()
 
+    /// Metrics tracked by this Prometheus instance
+    internal var metrics: [Metric] = []
+    
+    // MARK: - Counter
+    
+    /// Creates a counter with the given values
+    ///
+    /// - Parameters:
+    ///     - type: Type the counter will count
+    ///     - name: Name of the counter
+    ///     - helpText: Help text for the counter. Usually a short description
+    ///     - initialValue: An initial value to set the counter to, defaults to 0
+    ///     - labelType: Type of labels this counter can use. Can be left out to default to no labels
+    ///
+    /// - Returns: Counter instance
+    public func createCounter<T: Numeric, U: MetricLabels>(
+        forType type: T.Type,
+        named name: String,
+        helpText: String? = nil,
+        initialValue: T = 0,
+        withLabelType labelType: U.Type) -> Counter<T, U>
+    {
+        let counter = Counter<T, U>(name, helpText, initialValue)
+        self.metrics.append(counter)
+        return counter
+    }
+    
+    /// Creates a counter with the given values
+    ///
+    /// - Parameters:
+    ///     - type: Type the counter will count
+    ///     - name: Name of the counter
+    ///     - helpText: Help text for the counter. Usually a short description
+    ///     - initialValue: An initial value to set the counter to, defaults to 0
+    ///
+    /// - Returns: Counter instance
+    public func createCounter<T: Numeric>(
+        forType: T.Type,
+        named name: String,
+        helpText: String? = nil,
+        initialValue: T = 0) -> Counter<T, EmptyCodable>
+    {
+        return self.createCounter(forType: T.self, named: name, helpText: helpText, initialValue: initialValue, withLabelType: EmptyCodable.self)
+    }
+    
+    // MARK: - Gauge
+    
+    /// Creates a gauge with the given values
+    ///
+    /// - Parameters:
+    ///     - type: Type the gauge will hold
+    ///     - name: Name of the gauge
+    ///     - helpText: Help text for the gauge. Usually a short description
+    ///     - initialValue: An initial value to set the gauge to, defaults to 0
+    ///     - labelType: Type of labels this gauge can use. Can be left out to default to no labels
+    ///
+    /// - Returns: Gauge instance
+    public func createGauge<T: Numeric, U: MetricLabels>(
+        forType type: T.Type,
+        named name: String,
+        helpText: String? = nil,
+        initialValue: T = 0,
+        withLabelType labelType: U.Type) -> Gauge<T, U>
+    {
+        let gauge = Gauge<T, U>(name, helpText, initialValue)
+        self.metrics.append(gauge)
+        return gauge
+    }
+    
+    /// Creates a gauge with the given values
+    ///
+    /// - Parameters:
+    ///     - type: Type the gauge will count
+    ///     - name: Name of the gauge
+    ///     - helpText: Help text for the gauge. Usually a short description
+    ///     - initialValue: An initial value to set the gauge to, defaults to 0
+    ///
+    /// - Returns: Gauge instance
+    public func createGauge<T: Numeric>(
+        forType: T.Type,
+        named name: String,
+        helpText: String? = nil,
+        initialValue: T = 0) -> Gauge<T, EmptyCodable>
+    {
+        return self.createGauge(forType: T.self, named: name, helpText: helpText, initialValue: initialValue, withLabelType: EmptyCodable.self)
+    }
+    
+    /// Creates prometheus formatted metrics
+    ///
+    /// - Returns: Newline seperated string with metrics for all Metric Trackers of this Prometheus instance
+    public func getMetrics() -> String {
+        return metrics.map { $0.getMetric() }.joined(separator: "\n\n")
+    }
 }

Sources/PrometheusExample/main.swift

@@ -1,65 +1,18 @@
 import Prometheus
 
 struct MyCodable: MetricLabels {
-    var thing: String
-    
-    init() {
-        self.thing = "*"
-    }
-    
-    init(_ thing: String) {
-        self.thing = thing
-    }
+    var thing: String = "*"
 }
 
-let codable1 = MyCodable("Thing1")
-let codable2 = MyCodable("Thing2")
+let codable1 = MyCodable(thing: "Thing1")
+let codable2 = MyCodable(thing: "Thing2")
 
-//let counter = Counter<Int, MyCodable>("some_test_value", "This value holds just a random imcrementer :)", 0)
-//
-//counter.inc(5, codable1)
-//
-//counter.inc(5, codable2)
-//
-//counter.inc(5)
-//
-//counter.inc(5, codable1)
-//
-//print(counter.getMetric())
-//
-//let gauge = Gauge<Int, MyCodable>("some_test_value", "This value holds a random Gauge :)")
-//
-//gauge.inc(codable2)
-//
-//gauge.dec()
-//
-//gauge.inc(1, codable1)
-//
-//let arr = [1, 2, 3, 4]
-//
-//gauge.set(arr.count)
-//
-//print(gauge.getMetric())
-//
-//struct HistogramCodable: HistogramLabels {
-//    var le: String = ""
-//}
-//
-//let histogram = Histogram<Int, HistogramCodable>("my_histogram", "Just a histogram")
-//
-//histogram.observe(6)
-//histogram.observe(6)
-//histogram.observe(1)
-//histogram.observe(4)
-//
-//print(histogram.getMetric())
+let counter = Prometheus.shared.createCounter(forType: Int.self, named: "my_counter", helpText: "Just a counter", initialValue: 12)
 
-//struct SummaryCodable: SummaryLabels {
-//    var quantile: String = ""
-//}
-//
-//let summary = Summary<Int, SummaryCodable>("my_summary", "Just a summary")
-//
-//summary.observe(Int.random(in: 1...10000))
-//
-//print(summary.getMetric())
+counter.inc(5)
+
+let gauge = Prometheus.shared.createGauge(forType: Int.self, named: "my_gauge", helpText: "Just a gauge", initialValue: 0)
+
+gauge.set(123)
+
+print(Prometheus.shared.getMetrics())