Update to registry output formats

Author: fiadliel

client/src/main/scala/org/lyranthe/prometheus/client/Registry.scala

@@ -0,0 +1,14 @@
+package org.lyranthe.prometheus.client
+
+import org.lyranthe.prometheus.client.registry._
+
+trait Registry {
+  def unsafeRegister(c: MetricFamily): Unit
+  def collect(): Iterator[RegistryMetrics]
+
+  def output(format: RegistryFormat): Iterator[Array[Byte]] =
+    format.output(collect)
+
+  def outputText: String =
+    TextFormat.output(collect).map(new String(_)).mkString
+}

client/src/main/scala/org/lyranthe/prometheus/client/registry/Registry.scala

@@ -1,10 +1,6 @@
 package org.lyranthe.prometheus.client.registry
 
 trait RegistryFormat {
-  type Out
-  def output(values: => Iterator[RegistryMetrics]): Iterator[Out]
-}
-
-object RegistryFormat {
-  type Aux[Out0] = RegistryFormat { type Out = Out0 }
+  def contentType: String
+  def output(values: => Iterator[RegistryMetrics]): Iterator[Array[Byte]]
 }

client/src/main/scala/org/lyranthe/prometheus/client/registry/RegistryFormat.scala

@@ -3,7 +3,7 @@ package org.lyranthe.prometheus.client.registry
 import org.lyranthe.prometheus.client._
 
 object TextFormat extends RegistryFormat {
-  type Out = String
+  override val contentType = "text/plain; version=0.0.4"
 
   def prometheusDoubleFormat(d: Double): String = {
     if (d == Double.PositiveInfinity)
@@ -16,7 +16,7 @@ object TextFormat extends RegistryFormat {
       d.toString
   }
 
-  def output(values: => Iterator[RegistryMetrics]): Iterator[String] = {
+  def output(values: => Iterator[RegistryMetrics]): Iterator[Array[Byte]] = {
     def labelsToString(labels: List[(LabelName, String)]) = {
       if (labels.isEmpty)
         ""
@@ -48,7 +48,7 @@ object TextFormat extends RegistryFormat {
             sb.append(s"${metric.name.name}_sum${labelStr} ${sampleSum}\n")
         }
       }
-      sb.toString
+      sb.toString.getBytes
     }
   }
 }

client/src/main/scala/org/lyranthe/prometheus/client/registry/TextFormat.scala

@@ -83,7 +83,7 @@ To create a simple counter:
 
 ```scala
 scala> val totalRequests = Counter(metric"total_requests", "Total requests").labels()
-totalRequests: org.lyranthe.prometheus.client.internal.counter.Counter0 = Counter(MetricName(total_requests))()
+totalRequests: org.lyranthe.prometheus.client.counter.Counter0 = Counter(MetricName(total_requests))()
 ```
 
 The resulting counter has a metric name `total_requests`, a help message with the contents,
@@ -102,7 +102,7 @@ the `.labels` method:
 
 ```scala
 scala> val totalErrors = Counter(metric"total_errors", "Total errors").labels(label"code")
-totalErrors: org.lyranthe.prometheus.client.internal.counter.Counter1 = Counter1(MetricName(total_errors),Total errors,List(LabelName(code)))
+totalErrors: org.lyranthe.prometheus.client.counter.Counter1 = Counter1(MetricName(total_errors),Total errors,List(LabelName(code)))
 ```
 
 To increment a counter with an error code of "404", one might
@@ -119,7 +119,7 @@ number of values when using this counter:
 
 ```scala
 scala> totalErrors.labelValues("404", "/path").inc()
-<console>:17: error: too many arguments for method labelValues: (labelValue1: String)org.lyranthe.prometheus.client.internal.counter.LabelledCounter
+<console>:17: error: too many arguments for method labelValues: (labelValue1: String)org.lyranthe.prometheus.client.counter.LabelledCounter
        totalErrors.labelValues("404", "/path").inc()
                               ^
 ```
@@ -134,30 +134,36 @@ You can create a registry with a default implementation with:
 
 ```scala
 scala> implicit val defaultRegistry = DefaultRegistry()
-defaultRegistry: org.lyranthe.prometheus.client.DefaultRegistry =
+defaultRegistry: org.lyranthe.prometheus.client.DefaultRegistry = org.lyranthe.prometheus.client.DefaultRegistry@252a4792
 ```
 
 ```scala
 scala> implicit val histogramBuckets = HistogramBuckets(1, 2, 5, 10, 20, 50, 100)
 histogramBuckets: org.lyranthe.prometheus.client.HistogramBuckets{val buckets: List[Double]} = HistogramBuckets(1.0,2.0,5.0,10.0,20.0,50.0,100.0,Infinity)
 
 scala> val activeRequests = Gauge(metric"active_requests", "Active requests").labels().unsafeRegister
-activeRequests: org.lyranthe.prometheus.client.internal.gauge.Gauge0 = Counter(MetricName(active_requests))()
+activeRequests: org.lyranthe.prometheus.client.gauge.Gauge0 = Counter(MetricName(active_requests))()
 
 scala> val numErrors = Counter(metric"num_errors", "Total errors").labels().unsafeRegister
-numErrors: org.lyranthe.prometheus.client.internal.counter.Counter0 = Counter(MetricName(num_errors))()
+numErrors: org.lyranthe.prometheus.client.counter.Counter0 = Counter(MetricName(num_errors))()
 
 scala> val requestLatency = Histogram(metric"request_latency", "Request latency").labels(label"path").unsafeRegister
-requestLatency: org.lyranthe.prometheus.client.internal.histogram.Histogram1 = Histogram1(MetricName(request_latency),Request latency,List(LabelName(path)),List(1.0, 2.0, 5.0, 10.0, 20.0, 50.0, 100.0, Infinity))
+requestLatency: org.lyranthe.prometheus.client.histogram.Histogram1 = Histogram1(MetricName(request_latency),Request latency,List(LabelName(path)),List(1.0, 2.0, 5.0, 10.0, 20.0, 50.0, 100.0, Infinity))
 
 scala> activeRequests.set(50)
 
 scala> numErrors.inc
 
 scala> requestLatency.labelValues("/home").observe(17)
 
-scala> implicitly[Registry]
-res10: org.lyranthe.prometheus.client.Registry =
+scala> implicitly[Registry].outputText
+res10: String =
+"# HELP active_requests Active requests
+# TYPE active_requests gauge
+active_requests 50.0
+# HELP num_errors Total errors
+# TYPE num_errors counter
+num_errors 1.0
 # HELP request_latency Request latency
 # TYPE request_latency histogram
 request_latency_bucket{le="1.0",path="/home"} 0
@@ -170,12 +176,7 @@ request_latency_bucket{le="100.0",path="/home"} 1
 request_latency_bucket{le="+Inf",path="/home"} 1
 request_latency_count{path="/home"} 1
 request_latency_sum{path="/home"} 17.0
-# HELP num_errors Total errors
-# TYPE num_errors counter
-num_errors 1.0
-# HELP active_requests Active requests
-# TYPE active_requests gauge
-active_requests 50.0
+"
 ```
 
 ## Using with FS2 Task (WIP)
@@ -198,14 +199,14 @@ import org.lyranthe.prometheus.client.fs2_syntax._
 Then the method `timeSuccess` can be used to capture the duration of the task (in seconds):
 
 ```scala
-implicit val registry = DefaultRegistry()
+implicit val defaultRegistry = DefaultRegistry()
 ```
 ```scala
 scala> implicit val histogramBuckets = HistogramBuckets(0.02, 0.05, 0.1, 0.2, 0.5, 1.0)
 histogramBuckets: org.lyranthe.prometheus.client.HistogramBuckets{val buckets: List[Double]} = HistogramBuckets(0.02,0.05,0.1,0.2,0.5,1.0,Infinity)
 
 scala> val requestLatency = Histogram(metric"request_latency", "Request latency").labels(label"path").unsafeRegister
-requestLatency: org.lyranthe.prometheus.client.internal.histogram.Histogram1 = Histogram1(MetricName(request_latency),Request latency,List(LabelName(path)),List(0.02, 0.05, 0.1, 0.2, 0.5, 1.0, Infinity))
+requestLatency: org.lyranthe.prometheus.client.histogram.Histogram1 = Histogram1(MetricName(request_latency),Request latency,List(LabelName(path)),List(0.02, 0.05, 0.1, 0.2, 0.5, 1.0, Infinity))
 
 scala> val mySleepyTask = Task.delay(Thread.sleep(scala.util.Random.nextInt(800)))
 mySleepyTask: fs2.Task[Unit] = Task
@@ -215,27 +216,28 @@ myTimedSleepyTask: fs2.Task[Unit] = Task
 
 scala> for (i <- Range(1, 10)) myTimedSleepyTask.unsafeRun
 
-scala> implicitly[Registry]
-res1: org.lyranthe.prometheus.client.Registry =
-# HELP request_latency Request latency
+scala> implicitly[Registry].outputText
+res1: String =
+"# HELP request_latency Request latency
 # TYPE request_latency histogram
 request_latency_bucket{le="0.02",path="/home"} 0
 request_latency_bucket{le="0.05",path="/home"} 0
 request_latency_bucket{le="0.1",path="/home"} 0
-request_latency_bucket{le="0.2",path="/home"} 4
-request_latency_bucket{le="0.5",path="/home"} 6
+request_latency_bucket{le="0.2",path="/home"} 1
+request_latency_bucket{le="0.5",path="/home"} 5
 request_latency_bucket{le="1.0",path="/home"} 9
 request_latency_bucket{le="+Inf",path="/home"} 9
 request_latency_count{path="/home"} 9
-request_latency_sum{path="/home"} 3.398811496
+request_latency_sum{path="/home"} 3.8517136149999995
+"
 ```
 
 ## Exposing JMX Statistics
 
 Some JVM statistics can be exposed with:
 
 ```scala
-implicit val registry = DefaultRegistry()
+implicit val defaultRegistry = DefaultRegistry()
 ```
 ```scala
 scala> import fs2._
@@ -246,34 +248,34 @@ import org.lyranthe.prometheus.client._
 
 scala> jmx.unsafeRegister
 
-scala> println(implicitly[Registry])
-# HELP jvm_threads JVM Thread Information
-# TYPE jvm_threads gauge
-jvm_threads{type="non-daemon"} 11.0
-jvm_threads{type="daemon"} 4.0
-# HELP jvm_start_time JVM Start Time
-# TYPE jvm_start_time gauge
-jvm_start_time 1.477244444947E9
+scala> println(implicitly[Registry].outputText)
+# HELP jvm_classloader JVM Classloader statistics
+# TYPE jvm_classloader gauge
+jvm_classloader{classloader="loaded"} 15479.0
+jvm_classloader{classloader="total-loaded"} 15554.0
+jvm_classloader{classloader="unloaded"} 75.0
+# HELP jvm_gc_stats JVM Garbage Collector Statistics
+# TYPE jvm_gc_stats gauge
+jvm_gc_stats{name="PS Scavenge",type="count"} 10.0
+jvm_gc_stats{name="PS Scavenge",type="time"} 0.217
+jvm_gc_stats{name="PS MarkSweep",type="count"} 5.0
+jvm_gc_stats{name="PS MarkSweep",type="time"} 0.406
 # HELP jvm_memory_usage JVM Memory Usage
 # TYPE jvm_memory_usage gauge
-jvm_memory_usage{region="heap",type="committed"} 1.038614528E9
+jvm_memory_usage{region="heap",type="committed"} 1.042808832E9
 jvm_memory_usage{region="heap",type="init"} 5.36870912E8
 jvm_memory_usage{region="heap",type="max"} 1.431830528E9
-jvm_memory_usage{region="heap",type="used"} 2.84849344E8
-jvm_memory_usage{region="non-heap",type="committed"} 1.48914176E8
+jvm_memory_usage{region="heap",type="used"} 4.70523048E8
+jvm_memory_usage{region="non-heap",type="committed"} 1.67591936E8
 jvm_memory_usage{region="non-heap",type="init"} 2555904.0
 jvm_memory_usage{region="non-heap",type="max"} -1.0
-jvm_memory_usage{region="non-heap",type="used"} 1.47149728E8
-# HELP jvm_gc_stats JVM Garbage Collector Statistics
-# TYPE jvm_gc_stats gauge
-jvm_gc_stats{name="PS Scavenge",type="count"} 9.0
-jvm_gc_stats{name="PS Scavenge",type="time"} 0.176
-jvm_gc_stats{name="PS MarkSweep",type="count"} 5.0
-jvm_gc_stats{name="PS MarkSweep",type="time"} 0.325
-# HELP jvm_classloader JVM Classloader statistics
-# TYPE jvm_classloader gauge
-jvm_classloader{classloader="loaded"} 15230.0
-jvm_classloader{classloader="total-loaded"} 15305.0
-jvm_classloader{classloader="unloaded"} 75.0
+jvm_memory_usage{region="non-heap",type="used"} 1.65366072E8
+# HELP jvm_start_time JVM Start Time
+# TYPE jvm_start_time gauge
+jvm_start_time 1.477262878978E9
+# HELP jvm_threads JVM Thread Information
+# TYPE jvm_threads gauge
+jvm_threads{type="non-daemon"} 11.0
+jvm_threads{type="daemon"} 4.0
 
 ```

doc/Guide.md

@@ -127,7 +127,7 @@ val requestLatency = Histogram(metric"request_latency", "Request latency").label
 activeRequests.set(50)
 numErrors.inc
 requestLatency.labelValues("/home").observe(17)
-defaultRegistry
+implicitly[Registry].outputText
 ```
 
 ## Using with FS2 Task (WIP)
@@ -145,7 +145,7 @@ import org.lyranthe.prometheus.client.fs2_syntax._
 Then the method `timeSuccess` can be used to capture the duration of the task (in seconds):
 
 ```tut:silent
-implicit val registry = DefaultRegistry()
+implicit val defaultRegistry = DefaultRegistry()
 ```
 ```tut
 implicit val histogramBuckets = HistogramBuckets(0.02, 0.05, 0.1, 0.2, 0.5, 1.0)
@@ -156,7 +156,7 @@ val myTimedSleepyTask = mySleepyTask.timeSuccess(requestLatency.labelValues("/ho
 
 for (i <- Range(1, 10)) myTimedSleepyTask.unsafeRun
 
-registry
+implicitly[Registry].outputText
 ```
 
 ## Exposing JMX Statistics
@@ -172,5 +172,5 @@ import org.lyranthe.prometheus.client._
 
 jmx.unsafeRegister
 
-println(defaultRegistry)
+println(implicitly[Registry].outputText)
 ```

doc/src/Guide.md

@@ -1,10 +1,12 @@
-package org.lyranthe.prometheus.client
+package org.lyranthe.prometheus.client.registry
 
 import com.google.protobuf.CodedOutputStream
 import io.prometheus.client.{Metrics => PB}
-import org.lyranthe.prometheus.client.registry._
+import org.lyranthe.prometheus.client._
 
-object Protobuf {
+object ProtoFormat extends RegistryFormat {
+  override val contentType =
+    "application/vnd.google.protobuf; proto=io.prometheus.client.MetricFamily; encoding=delimited"
 
   def labelPairs(labels: List[(LabelName, String)]): List[PB.LabelPair] = {
     labels.map(lp =>
@@ -48,10 +50,11 @@ object Protobuf {
     }
   }
 
-  def collectProtobuf(implicit registry: Registry): Iterator[Array[Byte]] = {
+  override def output(
+      values: => Iterator[RegistryMetrics]): Iterator[Array[Byte]] = {
     import scala.collection.JavaConverters._
 
-    registry.collect() map { metric =>
+    values map { metric =>
       val proto = PB.MetricFamily.newBuilder
         .setName(metric.name.name)
         .setHelp(metric.help)