make CustomCollector private

Alex Boten · Alex Boten · commit 348c2cfaec34 · 2022-02-28T09:20:33.000-08:00
diff --git a/exporter/opentelemetry-exporter-prometheus/src/opentelemetry/exporter/prometheus/__init__.py b/exporter/opentelemetry-exporter-prometheus/src/opentelemetry/exporter/prometheus/__init__.py
@@ -102,7 +102,7 @@ class PrometheusMetricExporter(MetricExporter):
     """
 
     def __init__(self, prefix: str = ""):
-        self._collector = CustomCollector(prefix)
+        self._collector = _CustomCollector(prefix)
         core.REGISTRY.register(self._collector)
 
     def export(self, metrics: Sequence[Metric]) -> MetricExportResult:
@@ -113,8 +113,8 @@ def shutdown(self) -> None:
         core.REGISTRY.unregister(self._collector)
 
 
-class CustomCollector:
-    """CustomCollector represents the Prometheus Collector object
+class _CustomCollector:
+    """_CustomCollector represents the Prometheus Collector object
     https://github.com/prometheus/client_python#custom-collectors
     """
 
diff --git a/exporter/opentelemetry-exporter-prometheus/tests/test_prometheus_exporter.py b/exporter/opentelemetry-exporter-prometheus/tests/test_prometheus_exporter.py
@@ -19,7 +19,7 @@
 from prometheus_client.core import CounterMetricFamily, GaugeMetricFamily
 
 from opentelemetry.exporter.prometheus import (
-    CustomCollector,
+    _CustomCollector,
     PrometheusMetricExporter,
 )
 from opentelemetry.sdk._metrics.export import MetricExportResult
@@ -79,7 +79,7 @@ def test_histogram_to_prometheus(self):
             attributes={"histo": 1},
         )
 
-        collector = CustomCollector("testprefix")
+        collector = _CustomCollector("testprefix")
         collector.add_metrics_data([record])
         result_bytes = generate_latest(collector)
         result = result_bytes.decode("utf-8")
@@ -95,7 +95,7 @@ def test_sum_to_prometheus(self):
             description="testdesc",
             unit="testunit",
         )
-        collector = CustomCollector("testprefix")
+        collector = _CustomCollector("testprefix")
         collector.add_metrics_data([record])
 
         for prometheus_metric in collector.collect():
@@ -123,7 +123,7 @@ def test_gauge_to_prometheus(self):
             description="testdesc",
             unit="testunit",
         )
-        collector = CustomCollector("testprefix")
+        collector = _CustomCollector("testprefix")
         collector.add_metrics_data([record])
 
         for prometheus_metric in collector.collect():
@@ -148,13 +148,13 @@ def test_invalid_metric(self):
             description="testdesc",
             unit="testunit",
         )
-        collector = CustomCollector("testprefix")
+        collector = _CustomCollector("testprefix")
         collector.add_metrics_data([record])
         collector.collect()
         self.assertLogs("opentelemetry.exporter.prometheus", level="WARNING")
 
     def test_sanitize(self):
-        collector = CustomCollector("testprefix")
+        collector = _CustomCollector("testprefix")
         self.assertEqual(
             collector._sanitize("1!2@3#4$5%6^7&8*9(0)_-"),
             "1_2_3_4_5_6_7_8_9_0___",
