Skip to content

Commit 32fca55

Browse files
rsareddy0329Roja Reddy Sareddy
andauthored
Fix: Telemetry INFO logging to print only once per process (#6083)
* Fix role issue in mtrl integ tests * Fix role issue in mtrl integ tests * Fix: Telemetry INFO logging to print only once per process * Fix: Telemetry INFO logging to print only once per process * Fix: Telemetry INFO logging to print only once per process * Fix: Telemetry INFO logging to print only once per process --------- Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
1 parent 2220592 commit 32fca55

2 files changed

Lines changed: 60 additions & 1 deletion

File tree

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
"For more information, refer to https://sagemaker.readthedocs.io/en/stable/overview.html"
6565
"#configuring-and-using-defaults-with-the-sagemaker-python-sdk."
6666
)
67+
_telemetry_msg_shown = False
6768

6869
FEATURE_TO_CODE = {
6970
str(Feature.SDK_DEFAULTS): 11,
@@ -284,8 +285,8 @@ def wrapper(*args, **kwargs):
284285
)
285286

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

303+
if not telemetry_opt_out_flag and not _telemetry_msg_shown:
304+
logger.info(TELEMETRY_OPT_OUT_MESSAGING)
305+
_telemetry_msg_shown = True
306+
302307
# Construct the feature list to track feature combinations
303308
feature_list: List[int] = [FEATURE_TO_CODE[str(feature)]]
304309

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

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -647,3 +647,57 @@ def train(self):
647647
self.assertIn(15, feature_list) # MODEL_CUSTOMIZATION still present
648648
self.assertNotIn(19, feature_list) # No NOVA (detection failed gracefully)
649649
self.assertNotIn(20, feature_list) # No OSS
650+
651+
@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
652+
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config")
653+
def test_telemetry_opt_out_message_shown_only_once(
654+
self, mock_resolve_config, mock_send_telemetry_request
655+
):
656+
"""Test that the telemetry opt-out INFO message is logged only once per process."""
657+
import sagemaker.core.telemetry.telemetry_logging as telemetry_module
658+
659+
mock_resolve_config.return_value = False
660+
# Reset the flag to simulate a fresh process
661+
telemetry_module._telemetry_msg_shown = False
662+
663+
mock_local_client = LocalSagemakerClientMock()
664+
665+
with patch.object(telemetry_module.logger, "info") as mock_logger_info:
666+
mock_local_client.mock_create_model()
667+
mock_local_client.mock_create_model()
668+
mock_local_client.mock_create_model()
669+
670+
info_calls = [
671+
call for call in mock_logger_info.call_args_list
672+
if "telemetry" in str(call).lower() and "opt out" in str(call).lower()
673+
]
674+
self.assertEqual(len(info_calls), 1, "Telemetry opt-out message should be logged exactly once")
675+
676+
# Reset the flag for other tests
677+
telemetry_module._telemetry_msg_shown = False
678+
679+
@patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request")
680+
@patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config")
681+
def test_telemetry_opt_out_message_not_shown_when_opted_out(
682+
self, mock_resolve_config, mock_send_telemetry_request
683+
):
684+
"""Test that the telemetry opt-out INFO message is not shown when user has opted out."""
685+
import sagemaker.core.telemetry.telemetry_logging as telemetry_module
686+
687+
mock_resolve_config.return_value = True # opted out
688+
# Reset the flag to simulate a fresh process
689+
telemetry_module._telemetry_msg_shown = False
690+
691+
mock_local_client = LocalSagemakerClientMock()
692+
693+
with patch.object(telemetry_module.logger, "info") as mock_logger_info:
694+
mock_local_client.mock_create_model()
695+
696+
info_calls = [
697+
call for call in mock_logger_info.call_args_list
698+
if "telemetry" in str(call).lower() and "opt out" in str(call).lower()
699+
]
700+
self.assertEqual(len(info_calls), 0, "Telemetry opt-out message should not appear when opted out")
701+
702+
# Reset the flag for other tests
703+
telemetry_module._telemetry_msg_shown = False

0 commit comments

Comments
 (0)