SwiftPrometheus, Prometheus client for Swift

A prometheus client for Swift supporting counters, gauges, histograms, summaries and info.

Usage

For examples, see main.swift

Counter

Counters go up, and reset when the process restarts.

let counter = Prometheus.shared.createCounter(forType: Int.self, named: "my_counter")
counter.inc() // Increment by 1
counter.inc(12) // Increment by given value

Gauge

Gauges can go up and down

let gauge = Prometheus.shared.createGauge(forType: Int.self, named: "my_gauge")
gauge.inc() // Increment by 1
gauge.dec(19) // Decrement by given value
gauge.set(12) // Set to a given value

Histogram

Histograms track the size and number of events in buckets. This allows for aggregatable calculation of quantiles.

let histogram = Prometheus.shared.createHistogram(forType: Double.self, named: "my_histogram")
histogram.observe(4.7) // Observe the given value

Summary

Summaries track the size and number of events

let summary = Prometheus.shared.createSummary(forType: Double.self, named: "my_summary")
summary.observe(4.7) // Observe the given value

Info

Info tracks key-value information, usually about a whole target.

struct MyInfoStruct: MetricLabels {
   let value: String
   
   init() {
       self.value = "abc"
   }
   
   init(_ v: String) {
       self.value = v
   }
}

let info = Prometheus.shared.createInfo(named: "my_info", helpText: "Just some info", labelType: MyInfoStruct.self)

info.info(MyInfoStruct("def"))

Labels

All metric types support adding labels, allowing for grouping of related metrics.

Example with a counter:

struct RouteLabels: MetricLabels {
   var route: String = "*"
}

let counter = Prometheus.shared.createCounter(forType: Int.self, named: "my_counter", helpText: "Just a counter", withLabelType: RouteLabels.self)

counter.inc(12, .init(route: "/"))

Exporting

To keep SwiftPrometheus as clean and leight weitght as possible, there is no way of exporting metrics to Prometheus. All you can do is get a formatted string that Prometheus can use, so you can integrate it in your own Serverside Swift application

This could look something like this:

router.get("/metrics") { request -> String in
    return Prometheus.shared.getMetrics()
}

Here, I used Vapor syntax, but this will work with any web framework, since it's just returning a plain String.

Contributing

All contributions are most welcome!

If you think of some crazy cool new feature that should be included, please create an issue. Or, if you want to implement it yourself, fork this repo and submit a PR!

If you find a bug or have issues, please create an issue explaining your problems. Please include as much information as possible, so it's easier for me to reproduce (Framework, OS, Swift version, terminal output, etc.)

heckj / SwiftPrometheus