OM changes untyped to unknown

brian-brazil · brian-brazil · commit 1b840fb1b7a8 · 2018-09-07T17:17:03.000+01:00
Signed-off-by: Brian Brazil &lt;brian.brazil@robustperception.io&gt;
diff --git a/prometheus_client/core.py b/prometheus_client/core.py
@@ -181,7 +181,7 @@ def get_sample_value(self, name, labels=None):
 '''The default registry.'''
 
 _METRIC_TYPES = ('counter', 'gauge', 'summary', 'histogram', 
-        'gaugehistogram', 'untyped', 'info', 'stateset')
+        'gaugehistogram', 'unknown', 'info', 'stateset')
 
 
 class Metric(object):
@@ -200,6 +200,8 @@ def __init__(self, name, documentation, typ, unit=''):
         if unit and not name.endswith("_" + unit):
             raise ValueError("Metric name not suffixed by unit: " + name)
         self.unit = unit
+        if typ == 'untyped':
+            typ = 'unknown'
         if typ not in _METRIC_TYPES:
             raise ValueError('Invalid metric type: ' + typ)
         self.type = typ
@@ -228,12 +230,12 @@ def __repr__(self):
             self.type, self.unit, self.samples)
 
 
-class UntypedMetricFamily(Metric):
-    '''A single untyped metric and its samples.
+class UnknownMetricFamily(Metric):
+    '''A single unknwon metric and its samples.
     For use by custom collectors.
     '''
     def __init__(self, name, documentation, value=None, labels=None):
-        Metric.__init__(self, name, documentation, 'untyped')
+        Metric.__init__(self, name, documentation, 'unknown')
         if labels is not None and value is not None:
             raise ValueError('Can only specify at most one of value and labels.')
         if labels is None:
@@ -250,6 +252,8 @@ def add_metric(self, labels, value, timestamp=None):
         '''
         self.samples.append(Sample(self.name, dict(zip(self._labelnames, labels)), value, timestamp))
 
+# For backward compatibility.
+UntypedMetricFamily = UnknownMetricFamily
 
 class CounterMetricFamily(Metric):
     '''A single counter and its samples.
diff --git a/prometheus_client/exposition.py b/prometheus_client/exposition.py
@@ -82,6 +82,8 @@ def generate_latest(registry=core.REGISTRY):
             # A gauge histogram is really a gauge,
             # but this captures the strucutre better.
             mtype = 'histogram'
+        elif mtype == 'unknown':
+            mtype = 'untyped'
         output.append('# HELP {0} {1}'.format(
             mname, metric.documentation.replace('\\', r'\\').replace('\n', r'\n')))
         output.append('\n# TYPE {0} {1}\n'.format(mname, mtype))
diff --git a/tests/openmetrics/test_exposition.py b/tests/openmetrics/test_exposition.py
@@ -150,12 +150,12 @@ def collect(self):
                 yield metric
 
         self.registry.register(MyCollector())
-        self.assertEqual(b'# HELP nonnumber Non number\n# TYPE nonnumber untyped\nnonnumber 123.0\n# EOF\n', generate_latest(self.registry))
+        self.assertEqual(b'# HELP nonnumber Non number\n# TYPE nonnumber unknown\nnonnumber 123.0\n# EOF\n', generate_latest(self.registry))
 
     def test_timestamp(self):
         class MyCollector(object):
             def collect(self):
-                metric = Metric("ts", "help", 'untyped')
+                metric = Metric("ts", "help", 'unknown')
                 metric.add_sample("ts", {"foo": "a"}, 0, 123.456)
                 metric.add_sample("ts", {"foo": "b"}, 0, -123.456)
                 metric.add_sample("ts", {"foo": "c"}, 0, 123)
@@ -166,7 +166,7 @@ def collect(self):
 
         self.registry.register(MyCollector())
         self.assertEqual(b'''# HELP ts help
-# TYPE ts untyped
+# TYPE ts unknown
 ts{foo="a"} 0.0 123.456
 ts{foo="b"} 0.0 -123.456
 ts{foo="c"} 0.0 123
