Merge pull request #19 from fiadliel/escape_chars_in_text

Escape backslash, line feed and double quotes appropriately.

Author: fiadliel

client/shared/src/main/boilerplate/CounterN.scala.template

@@ -10,6 +10,8 @@ final case class Counter1 private[client] (name: MetricName, help: String, label
 
   override final val metricType = MetricType.Counter
 
+  override final val escapedHelp = help.replace("\\", "\\\\").replace("\n", "\\n")
+
   def labelValues([#labelValue1: String#]): LabelledCounter =
     new LabelledCounter(name, labels, adders(Tuple1([#labelValue1#])))
 

client/shared/src/main/boilerplate/GaugeN.scala.template

@@ -10,6 +10,8 @@ final case class Gauge1 private[client] (name: MetricName, help: String, labels:
 
   override final val metricType = MetricType.Gauge
 
+  override final val escapedHelp = help.replace("\\", "\\\\").replace("\n", "\\n")
+
   def labelValues([#labelValue1: String#]): LabelledGauge =
     new LabelledGauge(name, labels, adders(Tuple1([#labelValue1#])), initialValue)
 

client/shared/src/main/boilerplate/HistogramN.scala.template

@@ -10,6 +10,8 @@ final case class Histogram1 private[client] (name: MetricName, help: String, lab
 
   override final val metricType = MetricType.Histogram
 
+  override final val escapedHelp = help.replace("\\", "\\\\").replace("\n", "\\n")
+
   def labelValues([#labelValue1: String#]): LabelledHistogram =
     new LabelledHistogram(name, labels, adders(Tuple1([#labelValue1#])))
 

client/shared/src/main/scala/org/lyranthe/prometheus/client/DefaultRegistry.scala

@@ -15,7 +15,7 @@ class DefaultRegistry extends Registry {
 
   override def collect(): Iterator[RegistryMetrics] = {
     collectors.toIterator.map { c =>
-      RegistryMetrics(c.name, c.help, c.metricType, c.collect())
+      RegistryMetrics(c.name, c.help, c.escapedHelp, c.metricType, c.collect())
     }
   }
 }

client/shared/src/main/scala/org/lyranthe/prometheus/client/counter/Counter0.scala

@@ -16,6 +16,8 @@ final case class Counter0 private[client] (name: MetricName, help: String)
     with MetricFamily {
   override val metricType = MetricType.Counter
 
+  override final val escapedHelp = help.replace("\\", "\\\\").replace("\n", "\\n")
+
   override def collect(): List[Metric] =
     CounterMetric(List.empty, adder.sum) :: Nil
 }

client/shared/src/main/scala/org/lyranthe/prometheus/client/gauge/Gauge0.scala

@@ -17,6 +17,8 @@ final case class Gauge0 private[client] (name: MetricName,
     with MetricFamily {
   override val metricType = MetricType.Gauge
 
+  override final val escapedHelp = help.replace("\\", "\\\\").replace("\n", "\\n")
+
   override def collect(): List[Metric] =
     synchronized {
       GaugeMetric(List.empty, adder.sum) :: Nil

client/shared/src/main/scala/org/lyranthe/prometheus/client/histogram/Histogram0.scala

@@ -20,6 +20,8 @@ final case class Histogram0 private[client] (name: MetricName,
     with MetricFamily {
   override val metricType = MetricType.Histogram
 
+  override final val escapedHelp = help.replace("\\", "\\\\").replace("\n", "\\n")
+
   override def collect(): List[HistogramMetric] = {
     List(
       HistogramMetric(List.empty,

client/shared/src/main/scala/org/lyranthe/prometheus/client/jmx.scala

@@ -18,6 +18,7 @@ object jmx {
     override def name: MetricName = metric"jvm_gc_stats"
 
     override def help: String = "JVM Garbage Collector Statistics"
+    override def escapedHelp: String = help
 
     override def metricType = MetricType.Gauge
 
@@ -38,6 +39,7 @@ object jmx {
     override def name: MetricName = metric"jvm_memory_usage"
 
     override def help: String = "JVM Memory Usage"
+    override def escapedHelp: String = help
 
     override def metricType = MetricType.Gauge
 
@@ -66,6 +68,7 @@ object jmx {
     override def name: MetricName = metric"jvm_classloader"
 
     override def help: String = "JVM Classloader statistics"
+    override def escapedHelp: String = help
 
     override def metricType = MetricType.Gauge
 
@@ -85,6 +88,7 @@ object jmx {
     override def name: MetricName = metric"jvm_start_time"
 
     override def help: String = "JVM Start Time"
+    override def escapedHelp: String = help
 
     override def metricType = MetricType.Gauge
 
@@ -97,6 +101,7 @@ object jmx {
     override def name: MetricName = metric"jvm_threads"
 
     override def help: String = "JVM Thread Information"
+    override def escapedHelp: String = help
 
     override def metricType: MetricType = MetricType.Gauge
 

client/shared/src/main/scala/org/lyranthe/prometheus/client/registry/Metric.scala

@@ -7,7 +7,10 @@ sealed trait Metric {
 }
 
 case class Bucket(cumulativeCount: Long, upperBound: Double)
-case class LabelPair(name: LabelName, value: String)
+case class LabelPair(name: LabelName, value: String) {
+  final private[registry] val escapedValue: String =
+    value.replace("\\", "\\\\").replace("\n", "\\n").replace("\"", "\\\"")
+}
 
 case class GaugeMetric(labels: List[LabelPair], value: Double)   extends Metric
 case class CounterMetric(labels: List[LabelPair], value: Double) extends Metric

client/shared/src/main/scala/org/lyranthe/prometheus/client/registry/MetricFamily.scala

@@ -11,6 +11,8 @@ trait MetricFamily {
   def help: String
   def metricType: MetricType
 
+  private[client] def escapedHelp: String
+
   def register(implicit registry: Registry): this.type = {
     registry.register(this)
     this