Skip to content

Commit 73f4045

Browse files
author
Roja Reddy Sareddy
committed
fix(core): honor telemetry opt-out in _emit_failure_telemetry
Gate _emit_failure_telemetry on the TelemetryOptOut config flag (via resolve_value_from_config), matching the @_telemetry_emitter decorator, so a user who has opted out of telemetry does not have validation-failure events emitted. Also include the standard env/platform dimensions (x-env, x-sys, x-platform) in the payload for parity with decorator-emitted events, so the two can be sliced consistently. Add a unit test asserting no event is sent when opt-out is set.
1 parent d2767cb commit 73f4045

2 files changed

Lines changed: 38 additions & 6 deletions

File tree

‎sagemaker-core/src/sagemaker/core/telemetry/telemetry_logging.py‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -485,8 +485,9 @@ def _emit_failure_telemetry(
485485
of client-side failure (e.g. invalid user input) without adding any happy-path
486486
telemetry or per-call overhead to the surrounding code.
487487
488-
Best-effort: it resolves a session (falling back to the default) and swallows any
489-
error while emitting, so it can never mask or replace the caller's own exception.
488+
Best-effort: it resolves a session (falling back to the default), honors the
489+
telemetry opt-out configuration, and swallows any error while emitting, so it can
490+
never mask or replace the caller's own exception.
490491
491492
Args:
492493
feature: The Feature enum value to attribute this event to.
@@ -498,9 +499,23 @@ def _emit_failure_telemetry(
498499
session = sagemaker_session or _get_default_sagemaker_session()
499500
if not session:
500501
return
502+
# Honor the same telemetry opt-out contract as @_telemetry_emitter: a user
503+
# who has opted out must not have these events emitted.
504+
if resolve_value_from_config(
505+
direct_input=None,
506+
config_path=TELEMETRY_OPT_OUT_PATH,
507+
default_value=False,
508+
sagemaker_session=session,
509+
):
510+
return
511+
# Mirror the decorator's platform/env dimensions so these events can be
512+
# sliced consistently alongside decorator-emitted ones.
501513
extra = (
502514
f"{func_name}"
503515
f"&x-sdkVersion={SDK_VERSION}"
516+
f"&x-env={PYTHON_VERSION}"
517+
f"&x-sys={OS_NAME_VERSION}"
518+
f"&x-platform={process_studio_metadata_file()}"
504519
f"&x-errorCategory={_classify_error(exc)}"
505520
)
506521
_send_telemetry_request(

‎sagemaker-core/tests/unit/telemetry/test_telemetry_logging.py‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -893,9 +893,10 @@ def test_falls_back_to_default_region_when_none_resolved(self, mock_boto_session
893893
class TestEmitFailureTelemetry(unittest.TestCase):
894894
"""Tests for the failure-only _emit_failure_telemetry helper."""
895895

896+
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=False)
896897
@patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session")
897898
@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
898-
def test_emits_failure_event(self, mock_send, mock_default_session):
899+
def test_emits_failure_event(self, mock_send, mock_default_session, mock_optout):
899900
mock_default_session.return_value = Mock()
900901
exc = ValueError("bad value")
901902

@@ -908,18 +909,33 @@ def test_emits_failure_event(self, mock_send, mock_default_session):
908909
assert args[4] == "ValueError" # failure_type
909910
assert "MyClass.method" in args[5] # extra_info carries func_name
910911

912+
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=True)
911913
@patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session")
912914
@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
913-
def test_no_session_does_not_emit(self, mock_send, mock_default_session):
915+
def test_opt_out_suppresses_emit(self, mock_send, mock_default_session, mock_optout):
916+
# A user who has opted out of telemetry must not have these events emitted.
917+
mock_default_session.return_value = Mock()
918+
919+
_emit_failure_telemetry(Feature.MODEL_CUSTOMIZATION, "MyClass.method", ValueError("x"))
920+
921+
mock_send.assert_not_called()
922+
923+
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=False)
924+
@patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session")
925+
@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
926+
def test_no_session_does_not_emit(self, mock_send, mock_default_session, mock_optout):
914927
mock_default_session.return_value = None
915928

916929
_emit_failure_telemetry(Feature.MODEL_CUSTOMIZATION, "MyClass.method", ValueError("x"))
917930

918931
mock_send.assert_not_called()
919932

933+
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=False)
920934
@patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session")
921935
@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
922-
def test_uses_provided_session_without_default_lookup(self, mock_send, mock_default_session):
936+
def test_uses_provided_session_without_default_lookup(
937+
self, mock_send, mock_default_session, mock_optout
938+
):
923939
_emit_failure_telemetry(
924940
Feature.MODEL_CUSTOMIZATION, "MyClass.method", ValueError("x"),
925941
sagemaker_session=Mock(),
@@ -928,9 +944,10 @@ def test_uses_provided_session_without_default_lookup(self, mock_send, mock_defa
928944
mock_default_session.assert_not_called()
929945
mock_send.assert_called_once()
930946

947+
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=False)
931948
@patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session")
932949
@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
933-
def test_backend_error_is_swallowed(self, mock_send, mock_default_session):
950+
def test_backend_error_is_swallowed(self, mock_send, mock_default_session, mock_optout):
934951
# Telemetry is best-effort: an error while emitting must never propagate.
935952
mock_default_session.return_value = Mock()
936953
mock_send.side_effect = RuntimeError("telemetry backend down")

0 commit comments

Comments
 (0)