|
25 | 25 | from sagemaker.core.telemetry.telemetry_logging import ( |
26 | 26 | _send_telemetry_request, |
27 | 27 | _send_telemetry_request_sync, |
| 28 | + _emit_failure_telemetry, |
28 | 29 | _telemetry_emitter, |
29 | 30 | _construct_url, |
30 | 31 | _get_accountId, |
31 | 32 | _requests_helper, |
32 | 33 | _get_region_or_default, |
33 | 34 | _get_default_sagemaker_session, |
| 35 | + STATUS_TO_CODE, |
34 | 36 | OS_NAME_VERSION, |
35 | 37 | PYTHON_VERSION, |
36 | 38 | TELEMETRY_REQUEST_TIMEOUT, |
37 | 39 | ) |
| 40 | +from sagemaker.core.telemetry.constants import Status |
38 | 41 | from sagemaker.core.user_agent import SDK_VERSION, process_studio_metadata_file |
39 | 42 |
|
40 | 43 | # Try to import sagemaker-serve exceptions, skip tests if not available |
@@ -885,3 +888,69 @@ def test_falls_back_to_default_region_when_none_resolved(self, mock_boto_session |
885 | 888 | mock_boto_session.call_args_list[-1], |
886 | 889 | unittest.mock.call(region_name=DEFAULT_AWS_REGION), |
887 | 890 | ) |
| 891 | + |
| 892 | + |
| 893 | +class TestEmitFailureTelemetry(unittest.TestCase): |
| 894 | + """Tests for the failure-only _emit_failure_telemetry helper.""" |
| 895 | + |
| 896 | + @patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=False) |
| 897 | + @patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session") |
| 898 | + @patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request") |
| 899 | + def test_emits_failure_event(self, mock_send, mock_default_session, mock_optout): |
| 900 | + mock_default_session.return_value = Mock() |
| 901 | + exc = ValueError("bad value") |
| 902 | + |
| 903 | + _emit_failure_telemetry(Feature.MODEL_CUSTOMIZATION, "MyClass.method", exc) |
| 904 | + |
| 905 | + mock_send.assert_called_once() |
| 906 | + args = mock_send.call_args.args |
| 907 | + assert args[0] == STATUS_TO_CODE[str(Status.FAILURE)] # status code |
| 908 | + assert args[3] == "bad value" # failure_reason |
| 909 | + assert args[4] == "ValueError" # failure_type |
| 910 | + assert "MyClass.method" in args[5] # extra_info carries func_name |
| 911 | + |
| 912 | + @patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=True) |
| 913 | + @patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session") |
| 914 | + @patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request") |
| 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): |
| 927 | + mock_default_session.return_value = None |
| 928 | + |
| 929 | + _emit_failure_telemetry(Feature.MODEL_CUSTOMIZATION, "MyClass.method", ValueError("x")) |
| 930 | + |
| 931 | + mock_send.assert_not_called() |
| 932 | + |
| 933 | + @patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=False) |
| 934 | + @patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session") |
| 935 | + @patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request") |
| 936 | + def test_uses_provided_session_without_default_lookup( |
| 937 | + self, mock_send, mock_default_session, mock_optout |
| 938 | + ): |
| 939 | + _emit_failure_telemetry( |
| 940 | + Feature.MODEL_CUSTOMIZATION, "MyClass.method", ValueError("x"), |
| 941 | + sagemaker_session=Mock(), |
| 942 | + ) |
| 943 | + |
| 944 | + mock_default_session.assert_not_called() |
| 945 | + mock_send.assert_called_once() |
| 946 | + |
| 947 | + @patch("sagemaker.core.telemetry.telemetry_logging.resolve_value_from_config", return_value=False) |
| 948 | + @patch("sagemaker.core.telemetry.telemetry_logging._get_default_sagemaker_session") |
| 949 | + @patch("sagemaker.core.telemetry.telemetry_logging._send_telemetry_request") |
| 950 | + def test_backend_error_is_swallowed(self, mock_send, mock_default_session, mock_optout): |
| 951 | + # Telemetry is best-effort: an error while emitting must never propagate. |
| 952 | + mock_default_session.return_value = Mock() |
| 953 | + mock_send.side_effect = RuntimeError("telemetry backend down") |
| 954 | + |
| 955 | + # Should not raise. |
| 956 | + _emit_failure_telemetry(Feature.MODEL_CUSTOMIZATION, "MyClass.method", ValueError("x")) |
0 commit comments