Make telemetry metrics module private (#21095)

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: alex.s <alex.s@prefect.io>
Co-authored-by: alex.s <ajstreed1@gmail.com>

Author: devin-ai-integration[bot]

src/prefect/engine.py

@@ -104,7 +104,7 @@ def my_flow():
             load_flow_run,
             run_flow,
         )
-        from prefect.telemetry.metrics import RunMetrics
+        from prefect.telemetry._metrics import RunMetrics
 
         flow_run: "FlowRun" = load_flow_run(flow_run_id=flow_run_id)
         run_logger: "LoggingAdapter" = flow_run_logger(flow_run=flow_run)

src/prefect/telemetry/metrics.py src/prefect/telemetry/_metrics.pysrc/prefect/telemetry/metrics.py renamed to src/prefect/telemetry/_metrics.py

@@ -11,7 +11,7 @@
     from prefect.client.schemas.objects import FlowRun
     from prefect.flows import Flow
 
-logger: logging.Logger = get_logger("prefect.telemetry.metrics")
+logger: logging.Logger = get_logger("prefect.telemetry._metrics")
 
 
 def _resolve_metrics_endpoint(

tests/telemetry/test_metrics.py

@@ -7,7 +7,7 @@
 import pytest
 
 from prefect.settings.models.telemetry import TelemetrySettings
-from prefect.telemetry.metrics import RunMetrics, _resolve_metrics_endpoint
+from prefect.telemetry._metrics import RunMetrics, _resolve_metrics_endpoint
 
 
 class TestTelemetrySettings:
@@ -147,7 +147,7 @@ def test_noop_when_no_endpoint(self, flow_run: MagicMock, flow: MagicMock):
         with (
             patch("prefect.settings.get_current_settings", return_value=mock_settings),
             patch(
-                "prefect.telemetry.metrics._resolve_metrics_endpoint",
+                "prefect.telemetry._metrics._resolve_metrics_endpoint",
                 return_value=(None, False),
             ),
         ):
@@ -167,7 +167,7 @@ def mock_import(name: str, *args: object, **kwargs: object) -> object:
         with (
             patch("prefect.settings.get_current_settings", return_value=mock_settings),
             patch(
-                "prefect.telemetry.metrics._resolve_metrics_endpoint",
+                "prefect.telemetry._metrics._resolve_metrics_endpoint",
                 return_value=("http://localhost:4318/v1/metrics", False),
             ),
             patch.object(builtins, "__import__", side_effect=mock_import),
@@ -187,7 +187,7 @@ def test_instruments_and_shuts_down(self, flow_run: MagicMock, flow: MagicMock):
         with (
             patch("prefect.settings.get_current_settings", return_value=mock_settings),
             patch(
-                "prefect.telemetry.metrics._resolve_metrics_endpoint",
+                "prefect.telemetry._metrics._resolve_metrics_endpoint",
                 return_value=("http://localhost:4318/v1/metrics", False),
             ),
             patch(
@@ -225,7 +225,7 @@ def test_noop_when_setup_raises(self, flow_run: MagicMock, flow: MagicMock):
         with (
             patch("prefect.settings.get_current_settings", return_value=mock_settings),
             patch(
-                "prefect.telemetry.metrics._resolve_metrics_endpoint",
+                "prefect.telemetry._metrics._resolve_metrics_endpoint",
                 return_value=("http://localhost:4318/v1/metrics", False),
             ),
             patch(
@@ -259,7 +259,7 @@ def test_non_cloud_endpoint_preserves_otel_env_headers(
         with (
             patch("prefect.settings.get_current_settings", return_value=mock_settings),
             patch(
-                "prefect.telemetry.metrics._resolve_metrics_endpoint",
+                "prefect.telemetry._metrics._resolve_metrics_endpoint",
                 return_value=("http://custom-collector:4318/v1/metrics", False),
             ),
             patch(
@@ -293,7 +293,7 @@ def test_cloud_endpoint_sends_auth_header(
         with (
             patch("prefect.settings.get_current_settings", return_value=mock_settings),
             patch(
-                "prefect.telemetry.metrics._resolve_metrics_endpoint",
+                "prefect.telemetry._metrics._resolve_metrics_endpoint",
                 return_value=("https://cloud.example.com/v1/metrics", True),
             ),
             patch(
@@ -323,4 +323,4 @@ def test_engine_imports_run_metrics(self):
 
         source = inspect.getsource(prefect.engine)
         assert "RunMetrics" in source
-        assert "from prefect.telemetry.metrics import RunMetrics" in source
+        assert "from prefect.telemetry._metrics import RunMetrics" in source