Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
"For more information, refer to https://sagemaker.readthedocs.io/en/stable/overview.html"
"#configuring-and-using-defaults-with-the-sagemaker-python-sdk."
)
_telemetry_msg_shown = False

FEATURE_TO_CODE = {
str(Feature.SDK_DEFAULTS): 11,
Expand Down Expand Up @@ -284,8 +285,8 @@ def wrapper(*args, **kwargs):
)

if sagemaker_session:
global _telemetry_msg_shown
logger.debug("sagemaker_session found, preparing to emit telemetry...")
logger.info(TELEMETRY_OPT_OUT_MESSAGING)
response = None
caught_ex = None
studio_app_type = process_studio_metadata_file()
Expand All @@ -299,6 +300,10 @@ def wrapper(*args, **kwargs):
)
logger.debug("TelemetryOptOut flag is set to: %s", telemetry_opt_out_flag)

if not telemetry_opt_out_flag and not _telemetry_msg_shown:
logger.warning(TELEMETRY_OPT_OUT_MESSAGING)
_telemetry_msg_shown = True

# Construct the feature list to track feature combinations
feature_list: List[int] = [FEATURE_TO_CODE[str(feature)]]

Expand Down
54 changes: 54 additions & 0 deletions sagemaker-core/tests/unit/telemetry/test_telemetry_logging.py
Original file line number Diff line number Diff line change
Expand Up @@ -647,3 +647,57 @@ def train(self):
self.assertIn(15, feature_list) # MODEL_CUSTOMIZATION still present
self.assertNotIn(19, feature_list) # No NOVA (detection failed gracefully)
self.assertNotIn(20, feature_list) # No OSS

@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config")
def test_telemetry_opt_out_message_shown_only_once(
self, mock_resolve_config, mock_send_telemetry_request
):
"""Test that the telemetry opt-out INFO message is logged only once per process."""
import sagemaker.core.telemetry.telemetry_logging as telemetry_module

mock_resolve_config.return_value = False
# Reset the flag to simulate a fresh process
telemetry_module._telemetry_msg_shown = False

mock_local_client = LocalSagemakerClientMock()

with patch.object(telemetry_module.logger, "info") as mock_logger_info:
mock_local_client.mock_create_model()
mock_local_client.mock_create_model()
mock_local_client.mock_create_model()

info_calls = [
call for call in mock_logger_info.call_args_list
if "telemetry" in str(call).lower() and "opt out" in str(call).lower()
]
self.assertEqual(len(info_calls), 1, "Telemetry opt-out message should be logged exactly once")

# Reset the flag for other tests
telemetry_module._telemetry_msg_shown = False

@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config")
def test_telemetry_opt_out_message_not_shown_when_opted_out(
self, mock_resolve_config, mock_send_telemetry_request
):
"""Test that the telemetry opt-out INFO message is not shown when user has opted out."""
import sagemaker.core.telemetry.telemetry_logging as telemetry_module

mock_resolve_config.return_value = True # opted out
# Reset the flag to simulate a fresh process
telemetry_module._telemetry_msg_shown = False

mock_local_client = LocalSagemakerClientMock()

with patch.object(telemetry_module.logger, "info") as mock_logger_info:
mock_local_client.mock_create_model()

info_calls = [
call for call in mock_logger_info.call_args_list
if "telemetry" in str(call).lower() and "opt out" in str(call).lower()
]
self.assertEqual(len(info_calls), 0, "Telemetry opt-out message should not appear when opted out")

# Reset the flag for other tests
telemetry_module._telemetry_msg_shown = False
Loading