feat: track explicit debugger and profiler configuration#6202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nargokul wants to merge 1 commit into
base:master-v2
Choose a base branch
from
+63 −4
Open

feat: track explicit debugger and profiler configuration #6202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion src/sagemaker/estimator.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -775,6 +775,8 @@ def __init__(
self.checkpoint_local_path = checkpoint_local_path

self.rules = rules
self._debugger_hook_config_explicitly_provided = debugger_hook_config is not None
self._profiler_config_explicitly_provided = profiler_config is not None

# Today, we ONLY support debugger_hook_config to be provided as a boolean value
# from sagemaker_config. We resolve value for this parameter as per the order
Expand DownExpand Up@@ -1366,7 +1368,14 @@ def latest_job_profiler_artifacts_path(self):
)
return None

@_telemetry_emitter(feature=Feature.ESTIMATOR_V2, func_name="estimator.fit")
@_telemetry_emitter(
feature=Feature.ESTIMATOR_V2,
func_name="estimator.fit",
telemetry_params={
"debuggerHookConfigExplicitlyProvided": ("_debugger_hook_config_explicitly_provided"),
"profilerConfigExplicitlyProvided": "_profiler_config_explicitly_provided",
},
)
@runnable_by_pipeline
def fit(
self,
Expand Down
17 changes: 15 additions & 2 deletions src/sagemaker/telemetry/telemetry_logging.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@
import platform
import sys
from time import perf_counter
from typing import List
from typing import Dict, List
import functools
import requests

Expand DownExpand Up@@ -67,14 +67,19 @@
}


def _telemetry_emitter(feature: str, func_name: str):
def _telemetry_emitter(feature: str, func_name: str, telemetry_params: Dict[str, str] = None):
"""Telemetry Emitter

Decorator to emit telemetry logs for SageMaker Python SDK functions. This class needs
sagemaker_session object as a member. Default session object is a pysdk v2 Session object
in this repo. When collecting telemetry for classes using sagemaker-core Session object,
we should be aware of its differences, such as sagemaker_session.sagemaker_config does not
exist in new Session class.

Args:
feature: Feature enum value for the telemetry event.
func_name: Name of the instrumented function.
telemetry_params: Mapping of telemetry field names to instance attribute names.
"""

def decorator(func):
Expand DownExpand Up@@ -136,6 +141,14 @@ def wrapper(*args, **kwargs):
if hasattr(sagemaker_session, "endpoint_arn") and sagemaker_session.endpoint_arn:
extra += f"&x-endpointArn={sagemaker_session.endpoint_arn}"

if telemetry_params and args:
for field_name, attribute_name in telemetry_params.items():
value = getattr(args[0], attribute_name, None)
if isinstance(value, bool):
value = str(value).lower()
if value is not None:
extra += f"&x-{field_name}={value}"

start_timer = perf_counter()
try:
# Call the original function
Expand Down
26 changes: 26 additions & 0 deletions tests/unit/sagemaker/telemetry/test_telemetry_logging.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,12 +42,25 @@
class LocalSagemakerClientMock:
def __init__(self):
self.sagemaker_session = MOCK_SESSION
self._debugger_explicitly_provided = True
self._profiler_explicitly_provided = False

@_telemetry_emitter(MOCK_FEATURE, MOCK_FUNC_NAME)
def mock_create_model(self, mock_exception_func=None):
if mock_exception_func:
mock_exception_func()

@_telemetry_emitter(
MOCK_FEATURE,
MOCK_FUNC_NAME,
telemetry_params={
"debuggerExplicitlyProvided": "_debugger_explicitly_provided",
"profilerExplicitlyProvided": "_profiler_explicitly_provided",
},
)
def mock_train(self):
return None


class TestTelemetryLogging(unittest.TestCase):
@patch("sagemaker.telemetry.telemetry_logging._requests_helper")
Expand DownExpand Up@@ -147,6 +160,19 @@ def test_telemetry_emitter_decorator_success(
1, [1, 2], MOCK_SESSION, None, None, expected_extra_str
)

@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
def test_telemetry_emitter_adds_instance_params(
self, mock_resolve_config, mock_send_telemetry_request
):
mock_resolve_config.return_value = False

LocalSagemakerClientMock().mock_train()

extra = mock_send_telemetry_request.call_args.args[5]
assert "&x-debuggerExplicitlyProvided=true" in extra
assert "&x-profilerExplicitlyProvided=false" in extra

@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
def test_telemetry_emitter_decorator_handle_exception_success(
Expand Down
13 changes: 12 additions & 1 deletion tests/unit/test_estimator.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -672,6 +672,8 @@ def test_estimator_initialization_with_sagemaker_config_injection(sagemaker_sess
assert estimator.environment == expected_environment
assert estimator.disable_profiler == expected_disable_profiler_attribute
assert estimator.debugger_hook_config == expected_debugger_hook_config
assert estimator._debugger_hook_config_explicitly_provided is False
assert estimator._profiler_config_explicitly_provided is False


def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
Expand All@@ -694,6 +696,7 @@ def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
debugger_hook_config=True,
)
assert estimator.debugger_hook_config == {}
assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
Expand All@@ -715,6 +718,7 @@ def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
debugger_hook_config=HOOK_CONFIG,
)
assert estimator.debugger_hook_config == HOOK_CONFIG
assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_initialization_with_sagemaker_config_injection_no_kms_supported(
Expand DownExpand Up@@ -1351,8 +1355,11 @@ def test_framework_with_only_profiler_rule_specified(sagemaker_session):
]


@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("time.time", return_value=TIME)
def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_session):
def test_framework_with_profiler_config_without_s3_output_path(
time, send_telemetry_request, sagemaker_session
):
f = DummyFramework(
entry_point=SCRIPT_PATH,
role=ROLE,
Expand All@@ -1361,6 +1368,7 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
instance_type=INSTANCE_TYPE,
profiler_config=ProfilerConfig(system_monitor_interval_millis=1000),
)
assert f._profiler_config_explicitly_provided is True
f.fit("s3://mydata")
sagemaker_session.train.assert_called_once()
_, args = sagemaker_session.train.call_args
Expand All@@ -1369,6 +1377,9 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
"S3OutputPath": "s3://{}/".format(BUCKET_NAME),
"ProfilingIntervalInMilliseconds": 1000,
}
telemetry_extra = send_telemetry_request.call_args.args[5]
assert "&x-debuggerHookConfigExplicitlyProvided=false" in telemetry_extra
assert "&x-profilerConfigExplicitlyProvided=true" in telemetry_extra


@pytest.mark.parametrize("region", PROFILER_UNSUPPORTED_REGIONS)
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: track explicit debugger and profiler configuration#6202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

nargokul
wants to merge
1
commit into

base:master-v2
Choose a base branch

from


+63

−4

 Open


feat: track explicit debugger and profiler configuration
#6202
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
src/sagemaker/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -775,6 +775,8 @@ def __init__(
 self.checkpoint_local_path = checkpoint_local_path

 self.rules = rules
 self._debugger_hook_config_explicitly_provided = debugger_hook_config is not None
 self._profiler_config_explicitly_provided = profiler_config is not None

 # Today, we ONLY support debugger_hook_config to be provided as a boolean value
 # from sagemaker_config. We resolve value for this parameter as per the order
Expand DownExpand Up@@ -1366,7 +1368,14 @@ def latest_job_profiler_artifacts_path(self):
 )
 return None

 @_telemetry_emitter(feature=Feature.ESTIMATOR_V2, func_name="estimator.fit")
 @_telemetry_emitter(
 feature=Feature.ESTIMATOR_V2,
 func_name="estimator.fit",
 telemetry_params={
 "debuggerHookConfigExplicitlyProvided": ("_debugger_hook_config_explicitly_provided"),
 "profilerConfigExplicitlyProvided": "_profiler_config_explicitly_provided",
 },
 )
 @runnable_by_pipeline
 def fit(
 self,
Expand Down

17 changes: 15 additions & 2 deletions
src/sagemaker/telemetry/telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@
import platform
import sys
from time import perf_counter
from typing import List
from typing import Dict, List
import functools
import requests

Expand DownExpand Up@@ -67,14 +67,19 @@
}


def _telemetry_emitter(feature: str, func_name: str):
def _telemetry_emitter(feature: str, func_name: str, telemetry_params: Dict[str, str] = None):
 """Telemetry Emitter

 Decorator to emit telemetry logs for SageMaker Python SDK functions. This class needs
 sagemaker_session object as a member. Default session object is a pysdk v2 Session object
 in this repo. When collecting telemetry for classes using sagemaker-core Session object,
 we should be aware of its differences, such as sagemaker_session.sagemaker_config does not
 exist in new Session class.

 Args:
 feature: Feature enum value for the telemetry event.
 func_name: Name of the instrumented function.
 telemetry_params: Mapping of telemetry field names to instance attribute names.
 """

 def decorator(func):
Expand DownExpand Up@@ -136,6 +141,14 @@ def wrapper(*args, **kwargs):
 if hasattr(sagemaker_session, "endpoint_arn") and sagemaker_session.endpoint_arn:
 extra += f"&x-endpointArn={sagemaker_session.endpoint_arn}"

 if telemetry_params and args:
 for field_name, attribute_name in telemetry_params.items():
 value = getattr(args[0], attribute_name, None)
 if isinstance(value, bool):
 value = str(value).lower()
 if value is not None:
 extra += f"&x-{field_name}={value}"

 start_timer = perf_counter()
 try:
 # Call the original function
Expand Down

26 changes: 26 additions & 0 deletions
tests/unit/sagemaker/telemetry/test_telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,12 +42,25 @@
class LocalSagemakerClientMock:
 def __init__(self):
 self.sagemaker_session = MOCK_SESSION
 self._debugger_explicitly_provided = True
 self._profiler_explicitly_provided = False

 @_telemetry_emitter(MOCK_FEATURE, MOCK_FUNC_NAME)
 def mock_create_model(self, mock_exception_func=None):
 if mock_exception_func:
 mock_exception_func()

 @_telemetry_emitter(
 MOCK_FEATURE,
 MOCK_FUNC_NAME,
 telemetry_params={
 "debuggerExplicitlyProvided": "_debugger_explicitly_provided",
 "profilerExplicitlyProvided": "_profiler_explicitly_provided",
 },
 )
 def mock_train(self):
 return None


class TestTelemetryLogging(unittest.TestCase):
 @patch("sagemaker.telemetry.telemetry_logging._requests_helper")
Expand DownExpand Up@@ -147,6 +160,19 @@ def test_telemetry_emitter_decorator_success(
 1, [1, 2], MOCK_SESSION, None, None, expected_extra_str
 )

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_adds_instance_params(
 self, mock_resolve_config, mock_send_telemetry_request
 ):
 mock_resolve_config.return_value = False

 LocalSagemakerClientMock().mock_train()

 extra = mock_send_telemetry_request.call_args.args[5]
 assert "&x-debuggerExplicitlyProvided=true" in extra
 assert "&x-profilerExplicitlyProvided=false" in extra

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_decorator_handle_exception_success(
Expand Down

13 changes: 12 additions & 1 deletion
tests/unit/test_estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -672,6 +672,8 @@ def test_estimator_initialization_with_sagemaker_config_injection(sagemaker_sess
 assert estimator.environment == expected_environment
 assert estimator.disable_profiler == expected_disable_profiler_attribute
 assert estimator.debugger_hook_config == expected_debugger_hook_config
 assert estimator._debugger_hook_config_explicitly_provided is False
 assert estimator._profiler_config_explicitly_provided is False


def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
Expand All@@ -694,6 +696,7 @@ def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
 debugger_hook_config=True,
 )
 assert estimator.debugger_hook_config == {}
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
Expand All@@ -715,6 +718,7 @@ def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
 debugger_hook_config=HOOK_CONFIG,
 )
 assert estimator.debugger_hook_config == HOOK_CONFIG
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_initialization_with_sagemaker_config_injection_no_kms_supported(
Expand DownExpand Up@@ -1351,8 +1355,11 @@ def test_framework_with_only_profiler_rule_specified(sagemaker_session):
 ]


@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("time.time", return_value=TIME)
def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_session):
def test_framework_with_profiler_config_without_s3_output_path(
 time, send_telemetry_request, sagemaker_session
):
 f = DummyFramework(
 entry_point=SCRIPT_PATH,
 role=ROLE,
Expand All@@ -1361,6 +1368,7 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 instance_type=INSTANCE_TYPE,
 profiler_config=ProfilerConfig(system_monitor_interval_millis=1000),
 )
 assert f._profiler_config_explicitly_provided is True
 f.fit("s3://mydata")
 sagemaker_session.train.assert_called_once()
 _, args = sagemaker_session.train.call_args
Expand All@@ -1369,6 +1377,9 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 "S3OutputPath": "s3://{}/".format(BUCKET_NAME),
 "ProfilingIntervalInMilliseconds": 1000,
 }
 telemetry_extra = send_telemetry_request.call_args.args[5]
 assert "&x-debuggerHookConfigExplicitlyProvided=false" in telemetry_extra
 assert "&x-profilerConfigExplicitlyProvided=true" in telemetry_extra


@pytest.mark.parametrize("region", PROFILER_UNSUPPORTED_REGIONS)
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: track explicit debugger and profiler configuration#6202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

nargokul
wants to merge
1
commit into

base:master-v2
Choose a base branch

from


+63

−4

 Open


feat: track explicit debugger and profiler configuration
#6202
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
src/sagemaker/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -775,6 +775,8 @@ def __init__(
 self.checkpoint_local_path = checkpoint_local_path

 self.rules = rules
 self._debugger_hook_config_explicitly_provided = debugger_hook_config is not None
 self._profiler_config_explicitly_provided = profiler_config is not None

 # Today, we ONLY support debugger_hook_config to be provided as a boolean value
 # from sagemaker_config. We resolve value for this parameter as per the order
Expand DownExpand Up@@ -1366,7 +1368,14 @@ def latest_job_profiler_artifacts_path(self):
 )
 return None

 @_telemetry_emitter(feature=Feature.ESTIMATOR_V2, func_name="estimator.fit")
 @_telemetry_emitter(
 feature=Feature.ESTIMATOR_V2,
 func_name="estimator.fit",
 telemetry_params={
 "debuggerHookConfigExplicitlyProvided": ("_debugger_hook_config_explicitly_provided"),
 "profilerConfigExplicitlyProvided": "_profiler_config_explicitly_provided",
 },
 )
 @runnable_by_pipeline
 def fit(
 self,
Expand Down

17 changes: 15 additions & 2 deletions
src/sagemaker/telemetry/telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@
import platform
import sys
from time import perf_counter
from typing import List
from typing import Dict, List
import functools
import requests

Expand DownExpand Up@@ -67,14 +67,19 @@
}


def _telemetry_emitter(feature: str, func_name: str):
def _telemetry_emitter(feature: str, func_name: str, telemetry_params: Dict[str, str] = None):
 """Telemetry Emitter

 Decorator to emit telemetry logs for SageMaker Python SDK functions. This class needs
 sagemaker_session object as a member. Default session object is a pysdk v2 Session object
 in this repo. When collecting telemetry for classes using sagemaker-core Session object,
 we should be aware of its differences, such as sagemaker_session.sagemaker_config does not
 exist in new Session class.

 Args:
 feature: Feature enum value for the telemetry event.
 func_name: Name of the instrumented function.
 telemetry_params: Mapping of telemetry field names to instance attribute names.
 """

 def decorator(func):
Expand DownExpand Up@@ -136,6 +141,14 @@ def wrapper(*args, **kwargs):
 if hasattr(sagemaker_session, "endpoint_arn") and sagemaker_session.endpoint_arn:
 extra += f"&x-endpointArn={sagemaker_session.endpoint_arn}"

 if telemetry_params and args:
 for field_name, attribute_name in telemetry_params.items():
 value = getattr(args[0], attribute_name, None)
 if isinstance(value, bool):
 value = str(value).lower()
 if value is not None:
 extra += f"&x-{field_name}={value}"

 start_timer = perf_counter()
 try:
 # Call the original function
Expand Down

26 changes: 26 additions & 0 deletions
tests/unit/sagemaker/telemetry/test_telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,12 +42,25 @@
class LocalSagemakerClientMock:
 def __init__(self):
 self.sagemaker_session = MOCK_SESSION
 self._debugger_explicitly_provided = True
 self._profiler_explicitly_provided = False

 @_telemetry_emitter(MOCK_FEATURE, MOCK_FUNC_NAME)
 def mock_create_model(self, mock_exception_func=None):
 if mock_exception_func:
 mock_exception_func()

 @_telemetry_emitter(
 MOCK_FEATURE,
 MOCK_FUNC_NAME,
 telemetry_params={
 "debuggerExplicitlyProvided": "_debugger_explicitly_provided",
 "profilerExplicitlyProvided": "_profiler_explicitly_provided",
 },
 )
 def mock_train(self):
 return None


class TestTelemetryLogging(unittest.TestCase):
 @patch("sagemaker.telemetry.telemetry_logging._requests_helper")
Expand DownExpand Up@@ -147,6 +160,19 @@ def test_telemetry_emitter_decorator_success(
 1, [1, 2], MOCK_SESSION, None, None, expected_extra_str
 )

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_adds_instance_params(
 self, mock_resolve_config, mock_send_telemetry_request
 ):
 mock_resolve_config.return_value = False

 LocalSagemakerClientMock().mock_train()

 extra = mock_send_telemetry_request.call_args.args[5]
 assert "&x-debuggerExplicitlyProvided=true" in extra
 assert "&x-profilerExplicitlyProvided=false" in extra

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_decorator_handle_exception_success(
Expand Down

13 changes: 12 additions & 1 deletion
tests/unit/test_estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -672,6 +672,8 @@ def test_estimator_initialization_with_sagemaker_config_injection(sagemaker_sess
 assert estimator.environment == expected_environment
 assert estimator.disable_profiler == expected_disable_profiler_attribute
 assert estimator.debugger_hook_config == expected_debugger_hook_config
 assert estimator._debugger_hook_config_explicitly_provided is False
 assert estimator._profiler_config_explicitly_provided is False


def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
Expand All@@ -694,6 +696,7 @@ def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
 debugger_hook_config=True,
 )
 assert estimator.debugger_hook_config == {}
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
Expand All@@ -715,6 +718,7 @@ def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
 debugger_hook_config=HOOK_CONFIG,
 )
 assert estimator.debugger_hook_config == HOOK_CONFIG
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_initialization_with_sagemaker_config_injection_no_kms_supported(
Expand DownExpand Up@@ -1351,8 +1355,11 @@ def test_framework_with_only_profiler_rule_specified(sagemaker_session):
 ]


@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("time.time", return_value=TIME)
def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_session):
def test_framework_with_profiler_config_without_s3_output_path(
 time, send_telemetry_request, sagemaker_session
):
 f = DummyFramework(
 entry_point=SCRIPT_PATH,
 role=ROLE,
Expand All@@ -1361,6 +1368,7 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 instance_type=INSTANCE_TYPE,
 profiler_config=ProfilerConfig(system_monitor_interval_millis=1000),
 )
 assert f._profiler_config_explicitly_provided is True
 f.fit("s3://mydata")
 sagemaker_session.train.assert_called_once()
 _, args = sagemaker_session.train.call_args
Expand All@@ -1369,6 +1377,9 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 "S3OutputPath": "s3://{}/".format(BUCKET_NAME),
 "ProfilingIntervalInMilliseconds": 1000,
 }
 telemetry_extra = send_telemetry_request.call_args.args[5]
 assert "&x-debuggerHookConfigExplicitlyProvided=false" in telemetry_extra
 assert "&x-profilerConfigExplicitlyProvided=true" in telemetry_extra


@pytest.mark.parametrize("region", PROFILER_UNSUPPORTED_REGIONS)
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: track explicit debugger and profiler configuration#6202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

nargokul
wants to merge
1
commit into

base:master-v2
Choose a base branch

from


+63

−4

 Open


feat: track explicit debugger and profiler configuration
#6202
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
src/sagemaker/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -775,6 +775,8 @@ def __init__(
 self.checkpoint_local_path = checkpoint_local_path

 self.rules = rules
 self._debugger_hook_config_explicitly_provided = debugger_hook_config is not None
 self._profiler_config_explicitly_provided = profiler_config is not None

 # Today, we ONLY support debugger_hook_config to be provided as a boolean value
 # from sagemaker_config. We resolve value for this parameter as per the order
Expand DownExpand Up@@ -1366,7 +1368,14 @@ def latest_job_profiler_artifacts_path(self):
 )
 return None

 @_telemetry_emitter(feature=Feature.ESTIMATOR_V2, func_name="estimator.fit")
 @_telemetry_emitter(
 feature=Feature.ESTIMATOR_V2,
 func_name="estimator.fit",
 telemetry_params={
 "debuggerHookConfigExplicitlyProvided": ("_debugger_hook_config_explicitly_provided"),
 "profilerConfigExplicitlyProvided": "_profiler_config_explicitly_provided",
 },
 )
 @runnable_by_pipeline
 def fit(
 self,
Expand Down

17 changes: 15 additions & 2 deletions
src/sagemaker/telemetry/telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@
import platform
import sys
from time import perf_counter
from typing import List
from typing import Dict, List
import functools
import requests

Expand DownExpand Up@@ -67,14 +67,19 @@
}


def _telemetry_emitter(feature: str, func_name: str):
def _telemetry_emitter(feature: str, func_name: str, telemetry_params: Dict[str, str] = None):
 """Telemetry Emitter

 Decorator to emit telemetry logs for SageMaker Python SDK functions. This class needs
 sagemaker_session object as a member. Default session object is a pysdk v2 Session object
 in this repo. When collecting telemetry for classes using sagemaker-core Session object,
 we should be aware of its differences, such as sagemaker_session.sagemaker_config does not
 exist in new Session class.

 Args:
 feature: Feature enum value for the telemetry event.
 func_name: Name of the instrumented function.
 telemetry_params: Mapping of telemetry field names to instance attribute names.
 """

 def decorator(func):
Expand DownExpand Up@@ -136,6 +141,14 @@ def wrapper(*args, **kwargs):
 if hasattr(sagemaker_session, "endpoint_arn") and sagemaker_session.endpoint_arn:
 extra += f"&x-endpointArn={sagemaker_session.endpoint_arn}"

 if telemetry_params and args:
 for field_name, attribute_name in telemetry_params.items():
 value = getattr(args[0], attribute_name, None)
 if isinstance(value, bool):
 value = str(value).lower()
 if value is not None:
 extra += f"&x-{field_name}={value}"

 start_timer = perf_counter()
 try:
 # Call the original function
Expand Down

26 changes: 26 additions & 0 deletions
tests/unit/sagemaker/telemetry/test_telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,12 +42,25 @@
class LocalSagemakerClientMock:
 def __init__(self):
 self.sagemaker_session = MOCK_SESSION
 self._debugger_explicitly_provided = True
 self._profiler_explicitly_provided = False

 @_telemetry_emitter(MOCK_FEATURE, MOCK_FUNC_NAME)
 def mock_create_model(self, mock_exception_func=None):
 if mock_exception_func:
 mock_exception_func()

 @_telemetry_emitter(
 MOCK_FEATURE,
 MOCK_FUNC_NAME,
 telemetry_params={
 "debuggerExplicitlyProvided": "_debugger_explicitly_provided",
 "profilerExplicitlyProvided": "_profiler_explicitly_provided",
 },
 )
 def mock_train(self):
 return None


class TestTelemetryLogging(unittest.TestCase):
 @patch("sagemaker.telemetry.telemetry_logging._requests_helper")
Expand DownExpand Up@@ -147,6 +160,19 @@ def test_telemetry_emitter_decorator_success(
 1, [1, 2], MOCK_SESSION, None, None, expected_extra_str
 )

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_adds_instance_params(
 self, mock_resolve_config, mock_send_telemetry_request
 ):
 mock_resolve_config.return_value = False

 LocalSagemakerClientMock().mock_train()

 extra = mock_send_telemetry_request.call_args.args[5]
 assert "&x-debuggerExplicitlyProvided=true" in extra
 assert "&x-profilerExplicitlyProvided=false" in extra

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_decorator_handle_exception_success(
Expand Down

13 changes: 12 additions & 1 deletion
tests/unit/test_estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -672,6 +672,8 @@ def test_estimator_initialization_with_sagemaker_config_injection(sagemaker_sess
 assert estimator.environment == expected_environment
 assert estimator.disable_profiler == expected_disable_profiler_attribute
 assert estimator.debugger_hook_config == expected_debugger_hook_config
 assert estimator._debugger_hook_config_explicitly_provided is False
 assert estimator._profiler_config_explicitly_provided is False


def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
Expand All@@ -694,6 +696,7 @@ def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
 debugger_hook_config=True,
 )
 assert estimator.debugger_hook_config == {}
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
Expand All@@ -715,6 +718,7 @@ def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
 debugger_hook_config=HOOK_CONFIG,
 )
 assert estimator.debugger_hook_config == HOOK_CONFIG
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_initialization_with_sagemaker_config_injection_no_kms_supported(
Expand DownExpand Up@@ -1351,8 +1355,11 @@ def test_framework_with_only_profiler_rule_specified(sagemaker_session):
 ]


@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("time.time", return_value=TIME)
def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_session):
def test_framework_with_profiler_config_without_s3_output_path(
 time, send_telemetry_request, sagemaker_session
):
 f = DummyFramework(
 entry_point=SCRIPT_PATH,
 role=ROLE,
Expand All@@ -1361,6 +1368,7 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 instance_type=INSTANCE_TYPE,
 profiler_config=ProfilerConfig(system_monitor_interval_millis=1000),
 )
 assert f._profiler_config_explicitly_provided is True
 f.fit("s3://mydata")
 sagemaker_session.train.assert_called_once()
 _, args = sagemaker_session.train.call_args
Expand All@@ -1369,6 +1377,9 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 "S3OutputPath": "s3://{}/".format(BUCKET_NAME),
 "ProfilingIntervalInMilliseconds": 1000,
 }
 telemetry_extra = send_telemetry_request.call_args.args[5]
 assert "&x-debuggerHookConfigExplicitlyProvided=false" in telemetry_extra
 assert "&x-profilerConfigExplicitlyProvided=true" in telemetry_extra


@pytest.mark.parametrize("region", PROFILER_UNSUPPORTED_REGIONS)
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: track explicit debugger and profiler configuration#6202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

nargokul
wants to merge
1
commit into

base:master-v2
Choose a base branch

from


+63

−4

 Open


feat: track explicit debugger and profiler configuration
#6202
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
src/sagemaker/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -775,6 +775,8 @@ def __init__(
 self.checkpoint_local_path = checkpoint_local_path

 self.rules = rules
 self._debugger_hook_config_explicitly_provided = debugger_hook_config is not None
 self._profiler_config_explicitly_provided = profiler_config is not None

 # Today, we ONLY support debugger_hook_config to be provided as a boolean value
 # from sagemaker_config. We resolve value for this parameter as per the order
Expand DownExpand Up@@ -1366,7 +1368,14 @@ def latest_job_profiler_artifacts_path(self):
 )
 return None

 @_telemetry_emitter(feature=Feature.ESTIMATOR_V2, func_name="estimator.fit")
 @_telemetry_emitter(
 feature=Feature.ESTIMATOR_V2,
 func_name="estimator.fit",
 telemetry_params={
 "debuggerHookConfigExplicitlyProvided": ("_debugger_hook_config_explicitly_provided"),
 "profilerConfigExplicitlyProvided": "_profiler_config_explicitly_provided",
 },
 )
 @runnable_by_pipeline
 def fit(
 self,
Expand Down

17 changes: 15 additions & 2 deletions
src/sagemaker/telemetry/telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@
import platform
import sys
from time import perf_counter
from typing import List
from typing import Dict, List
import functools
import requests

Expand DownExpand Up@@ -67,14 +67,19 @@
}


def _telemetry_emitter(feature: str, func_name: str):
def _telemetry_emitter(feature: str, func_name: str, telemetry_params: Dict[str, str] = None):
 """Telemetry Emitter

 Decorator to emit telemetry logs for SageMaker Python SDK functions. This class needs
 sagemaker_session object as a member. Default session object is a pysdk v2 Session object
 in this repo. When collecting telemetry for classes using sagemaker-core Session object,
 we should be aware of its differences, such as sagemaker_session.sagemaker_config does not
 exist in new Session class.

 Args:
 feature: Feature enum value for the telemetry event.
 func_name: Name of the instrumented function.
 telemetry_params: Mapping of telemetry field names to instance attribute names.
 """

 def decorator(func):
Expand DownExpand Up@@ -136,6 +141,14 @@ def wrapper(*args, **kwargs):
 if hasattr(sagemaker_session, "endpoint_arn") and sagemaker_session.endpoint_arn:
 extra += f"&x-endpointArn={sagemaker_session.endpoint_arn}"

 if telemetry_params and args:
 for field_name, attribute_name in telemetry_params.items():
 value = getattr(args[0], attribute_name, None)
 if isinstance(value, bool):
 value = str(value).lower()
 if value is not None:
 extra += f"&x-{field_name}={value}"

 start_timer = perf_counter()
 try:
 # Call the original function
Expand Down

26 changes: 26 additions & 0 deletions
tests/unit/sagemaker/telemetry/test_telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,12 +42,25 @@
class LocalSagemakerClientMock:
 def __init__(self):
 self.sagemaker_session = MOCK_SESSION
 self._debugger_explicitly_provided = True
 self._profiler_explicitly_provided = False

 @_telemetry_emitter(MOCK_FEATURE, MOCK_FUNC_NAME)
 def mock_create_model(self, mock_exception_func=None):
 if mock_exception_func:
 mock_exception_func()

 @_telemetry_emitter(
 MOCK_FEATURE,
 MOCK_FUNC_NAME,
 telemetry_params={
 "debuggerExplicitlyProvided": "_debugger_explicitly_provided",
 "profilerExplicitlyProvided": "_profiler_explicitly_provided",
 },
 )
 def mock_train(self):
 return None


class TestTelemetryLogging(unittest.TestCase):
 @patch("sagemaker.telemetry.telemetry_logging._requests_helper")
Expand DownExpand Up@@ -147,6 +160,19 @@ def test_telemetry_emitter_decorator_success(
 1, [1, 2], MOCK_SESSION, None, None, expected_extra_str
 )

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_adds_instance_params(
 self, mock_resolve_config, mock_send_telemetry_request
 ):
 mock_resolve_config.return_value = False

 LocalSagemakerClientMock().mock_train()

 extra = mock_send_telemetry_request.call_args.args[5]
 assert "&x-debuggerExplicitlyProvided=true" in extra
 assert "&x-profilerExplicitlyProvided=false" in extra

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_decorator_handle_exception_success(
Expand Down

13 changes: 12 additions & 1 deletion
tests/unit/test_estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -672,6 +672,8 @@ def test_estimator_initialization_with_sagemaker_config_injection(sagemaker_sess
 assert estimator.environment == expected_environment
 assert estimator.disable_profiler == expected_disable_profiler_attribute
 assert estimator.debugger_hook_config == expected_debugger_hook_config
 assert estimator._debugger_hook_config_explicitly_provided is False
 assert estimator._profiler_config_explicitly_provided is False


def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
Expand All@@ -694,6 +696,7 @@ def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
 debugger_hook_config=True,
 )
 assert estimator.debugger_hook_config == {}
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
Expand All@@ -715,6 +718,7 @@ def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
 debugger_hook_config=HOOK_CONFIG,
 )
 assert estimator.debugger_hook_config == HOOK_CONFIG
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_initialization_with_sagemaker_config_injection_no_kms_supported(
Expand DownExpand Up@@ -1351,8 +1355,11 @@ def test_framework_with_only_profiler_rule_specified(sagemaker_session):
 ]


@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("time.time", return_value=TIME)
def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_session):
def test_framework_with_profiler_config_without_s3_output_path(
 time, send_telemetry_request, sagemaker_session
):
 f = DummyFramework(
 entry_point=SCRIPT_PATH,
 role=ROLE,
Expand All@@ -1361,6 +1368,7 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 instance_type=INSTANCE_TYPE,
 profiler_config=ProfilerConfig(system_monitor_interval_millis=1000),
 )
 assert f._profiler_config_explicitly_provided is True
 f.fit("s3://mydata")
 sagemaker_session.train.assert_called_once()
 _, args = sagemaker_session.train.call_args
Expand All@@ -1369,6 +1377,9 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 "S3OutputPath": "s3://{}/".format(BUCKET_NAME),
 "ProfilingIntervalInMilliseconds": 1000,
 }
 telemetry_extra = send_telemetry_request.call_args.args[5]
 assert "&x-debuggerHookConfigExplicitlyProvided=false" in telemetry_extra
 assert "&x-profilerConfigExplicitlyProvided=true" in telemetry_extra


@pytest.mark.parametrize("region", PROFILER_UNSUPPORTED_REGIONS)
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: track explicit debugger and profiler configuration#6202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

nargokul
wants to merge
1
commit into

base:master-v2
Choose a base branch

from


+63

−4

 Open


feat: track explicit debugger and profiler configuration
#6202
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
src/sagemaker/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -775,6 +775,8 @@ def __init__(
 self.checkpoint_local_path = checkpoint_local_path

 self.rules = rules
 self._debugger_hook_config_explicitly_provided = debugger_hook_config is not None
 self._profiler_config_explicitly_provided = profiler_config is not None

 # Today, we ONLY support debugger_hook_config to be provided as a boolean value
 # from sagemaker_config. We resolve value for this parameter as per the order
Expand DownExpand Up@@ -1366,7 +1368,14 @@ def latest_job_profiler_artifacts_path(self):
 )
 return None

 @_telemetry_emitter(feature=Feature.ESTIMATOR_V2, func_name="estimator.fit")
 @_telemetry_emitter(
 feature=Feature.ESTIMATOR_V2,
 func_name="estimator.fit",
 telemetry_params={
 "debuggerHookConfigExplicitlyProvided": ("_debugger_hook_config_explicitly_provided"),
 "profilerConfigExplicitlyProvided": "_profiler_config_explicitly_provided",
 },
 )
 @runnable_by_pipeline
 def fit(
 self,
Expand Down

17 changes: 15 additions & 2 deletions
src/sagemaker/telemetry/telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@
import platform
import sys
from time import perf_counter
from typing import List
from typing import Dict, List
import functools
import requests

Expand DownExpand Up@@ -67,14 +67,19 @@
}


def _telemetry_emitter(feature: str, func_name: str):
def _telemetry_emitter(feature: str, func_name: str, telemetry_params: Dict[str, str] = None):
 """Telemetry Emitter

 Decorator to emit telemetry logs for SageMaker Python SDK functions. This class needs
 sagemaker_session object as a member. Default session object is a pysdk v2 Session object
 in this repo. When collecting telemetry for classes using sagemaker-core Session object,
 we should be aware of its differences, such as sagemaker_session.sagemaker_config does not
 exist in new Session class.

 Args:
 feature: Feature enum value for the telemetry event.
 func_name: Name of the instrumented function.
 telemetry_params: Mapping of telemetry field names to instance attribute names.
 """

 def decorator(func):
Expand DownExpand Up@@ -136,6 +141,14 @@ def wrapper(*args, **kwargs):
 if hasattr(sagemaker_session, "endpoint_arn") and sagemaker_session.endpoint_arn:
 extra += f"&x-endpointArn={sagemaker_session.endpoint_arn}"

 if telemetry_params and args:
 for field_name, attribute_name in telemetry_params.items():
 value = getattr(args[0], attribute_name, None)
 if isinstance(value, bool):
 value = str(value).lower()
 if value is not None:
 extra += f"&x-{field_name}={value}"

 start_timer = perf_counter()
 try:
 # Call the original function
Expand Down

26 changes: 26 additions & 0 deletions
tests/unit/sagemaker/telemetry/test_telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,12 +42,25 @@
class LocalSagemakerClientMock:
 def __init__(self):
 self.sagemaker_session = MOCK_SESSION
 self._debugger_explicitly_provided = True
 self._profiler_explicitly_provided = False

 @_telemetry_emitter(MOCK_FEATURE, MOCK_FUNC_NAME)
 def mock_create_model(self, mock_exception_func=None):
 if mock_exception_func:
 mock_exception_func()

 @_telemetry_emitter(
 MOCK_FEATURE,
 MOCK_FUNC_NAME,
 telemetry_params={
 "debuggerExplicitlyProvided": "_debugger_explicitly_provided",
 "profilerExplicitlyProvided": "_profiler_explicitly_provided",
 },
 )
 def mock_train(self):
 return None


class TestTelemetryLogging(unittest.TestCase):
 @patch("sagemaker.telemetry.telemetry_logging._requests_helper")
Expand DownExpand Up@@ -147,6 +160,19 @@ def test_telemetry_emitter_decorator_success(
 1, [1, 2], MOCK_SESSION, None, None, expected_extra_str
 )

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_adds_instance_params(
 self, mock_resolve_config, mock_send_telemetry_request
 ):
 mock_resolve_config.return_value = False

 LocalSagemakerClientMock().mock_train()

 extra = mock_send_telemetry_request.call_args.args[5]
 assert "&x-debuggerExplicitlyProvided=true" in extra
 assert "&x-profilerExplicitlyProvided=false" in extra

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_decorator_handle_exception_success(
Expand Down

13 changes: 12 additions & 1 deletion
tests/unit/test_estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -672,6 +672,8 @@ def test_estimator_initialization_with_sagemaker_config_injection(sagemaker_sess
 assert estimator.environment == expected_environment
 assert estimator.disable_profiler == expected_disable_profiler_attribute
 assert estimator.debugger_hook_config == expected_debugger_hook_config
 assert estimator._debugger_hook_config_explicitly_provided is False
 assert estimator._profiler_config_explicitly_provided is False


def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
Expand All@@ -694,6 +696,7 @@ def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
 debugger_hook_config=True,
 )
 assert estimator.debugger_hook_config == {}
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
Expand All@@ -715,6 +718,7 @@ def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
 debugger_hook_config=HOOK_CONFIG,
 )
 assert estimator.debugger_hook_config == HOOK_CONFIG
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_initialization_with_sagemaker_config_injection_no_kms_supported(
Expand DownExpand Up@@ -1351,8 +1355,11 @@ def test_framework_with_only_profiler_rule_specified(sagemaker_session):
 ]


@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("time.time", return_value=TIME)
def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_session):
def test_framework_with_profiler_config_without_s3_output_path(
 time, send_telemetry_request, sagemaker_session
):
 f = DummyFramework(
 entry_point=SCRIPT_PATH,
 role=ROLE,
Expand All@@ -1361,6 +1368,7 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 instance_type=INSTANCE_TYPE,
 profiler_config=ProfilerConfig(system_monitor_interval_millis=1000),
 )
 assert f._profiler_config_explicitly_provided is True
 f.fit("s3://mydata")
 sagemaker_session.train.assert_called_once()
 _, args = sagemaker_session.train.call_args
Expand All@@ -1369,6 +1377,9 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 "S3OutputPath": "s3://{}/".format(BUCKET_NAME),
 "ProfilingIntervalInMilliseconds": 1000,
 }
 telemetry_extra = send_telemetry_request.call_args.args[5]
 assert "&x-debuggerHookConfigExplicitlyProvided=false" in telemetry_extra
 assert "&x-profilerConfigExplicitlyProvided=true" in telemetry_extra


@pytest.mark.parametrize("region", PROFILER_UNSUPPORTED_REGIONS)
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: track explicit debugger and profiler configuration#6202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

nargokul
wants to merge
1
commit into

base:master-v2
Choose a base branch

from


+63

−4

 Open


feat: track explicit debugger and profiler configuration
#6202
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
src/sagemaker/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -775,6 +775,8 @@ def __init__(
 self.checkpoint_local_path = checkpoint_local_path

 self.rules = rules
 self._debugger_hook_config_explicitly_provided = debugger_hook_config is not None
 self._profiler_config_explicitly_provided = profiler_config is not None

 # Today, we ONLY support debugger_hook_config to be provided as a boolean value
 # from sagemaker_config. We resolve value for this parameter as per the order
Expand DownExpand Up@@ -1366,7 +1368,14 @@ def latest_job_profiler_artifacts_path(self):
 )
 return None

 @_telemetry_emitter(feature=Feature.ESTIMATOR_V2, func_name="estimator.fit")
 @_telemetry_emitter(
 feature=Feature.ESTIMATOR_V2,
 func_name="estimator.fit",
 telemetry_params={
 "debuggerHookConfigExplicitlyProvided": ("_debugger_hook_config_explicitly_provided"),
 "profilerConfigExplicitlyProvided": "_profiler_config_explicitly_provided",
 },
 )
 @runnable_by_pipeline
 def fit(
 self,
Expand Down

17 changes: 15 additions & 2 deletions
src/sagemaker/telemetry/telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@
import platform
import sys
from time import perf_counter
from typing import List
from typing import Dict, List
import functools
import requests

Expand DownExpand Up@@ -67,14 +67,19 @@
}


def _telemetry_emitter(feature: str, func_name: str):
def _telemetry_emitter(feature: str, func_name: str, telemetry_params: Dict[str, str] = None):
 """Telemetry Emitter

 Decorator to emit telemetry logs for SageMaker Python SDK functions. This class needs
 sagemaker_session object as a member. Default session object is a pysdk v2 Session object
 in this repo. When collecting telemetry for classes using sagemaker-core Session object,
 we should be aware of its differences, such as sagemaker_session.sagemaker_config does not
 exist in new Session class.

 Args:
 feature: Feature enum value for the telemetry event.
 func_name: Name of the instrumented function.
 telemetry_params: Mapping of telemetry field names to instance attribute names.
 """

 def decorator(func):
Expand DownExpand Up@@ -136,6 +141,14 @@ def wrapper(*args, **kwargs):
 if hasattr(sagemaker_session, "endpoint_arn") and sagemaker_session.endpoint_arn:
 extra += f"&x-endpointArn={sagemaker_session.endpoint_arn}"

 if telemetry_params and args:
 for field_name, attribute_name in telemetry_params.items():
 value = getattr(args[0], attribute_name, None)
 if isinstance(value, bool):
 value = str(value).lower()
 if value is not None:
 extra += f"&x-{field_name}={value}"

 start_timer = perf_counter()
 try:
 # Call the original function
Expand Down

26 changes: 26 additions & 0 deletions
tests/unit/sagemaker/telemetry/test_telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,12 +42,25 @@
class LocalSagemakerClientMock:
 def __init__(self):
 self.sagemaker_session = MOCK_SESSION
 self._debugger_explicitly_provided = True
 self._profiler_explicitly_provided = False

 @_telemetry_emitter(MOCK_FEATURE, MOCK_FUNC_NAME)
 def mock_create_model(self, mock_exception_func=None):
 if mock_exception_func:
 mock_exception_func()

 @_telemetry_emitter(
 MOCK_FEATURE,
 MOCK_FUNC_NAME,
 telemetry_params={
 "debuggerExplicitlyProvided": "_debugger_explicitly_provided",
 "profilerExplicitlyProvided": "_profiler_explicitly_provided",
 },
 )
 def mock_train(self):
 return None


class TestTelemetryLogging(unittest.TestCase):
 @patch("sagemaker.telemetry.telemetry_logging._requests_helper")
Expand DownExpand Up@@ -147,6 +160,19 @@ def test_telemetry_emitter_decorator_success(
 1, [1, 2], MOCK_SESSION, None, None, expected_extra_str
 )

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_adds_instance_params(
 self, mock_resolve_config, mock_send_telemetry_request
 ):
 mock_resolve_config.return_value = False

 LocalSagemakerClientMock().mock_train()

 extra = mock_send_telemetry_request.call_args.args[5]
 assert "&x-debuggerExplicitlyProvided=true" in extra
 assert "&x-profilerExplicitlyProvided=false" in extra

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_decorator_handle_exception_success(
Expand Down

13 changes: 12 additions & 1 deletion
tests/unit/test_estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -672,6 +672,8 @@ def test_estimator_initialization_with_sagemaker_config_injection(sagemaker_sess
 assert estimator.environment == expected_environment
 assert estimator.disable_profiler == expected_disable_profiler_attribute
 assert estimator.debugger_hook_config == expected_debugger_hook_config
 assert estimator._debugger_hook_config_explicitly_provided is False
 assert estimator._profiler_config_explicitly_provided is False


def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
Expand All@@ -694,6 +696,7 @@ def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
 debugger_hook_config=True,
 )
 assert estimator.debugger_hook_config == {}
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
Expand All@@ -715,6 +718,7 @@ def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
 debugger_hook_config=HOOK_CONFIG,
 )
 assert estimator.debugger_hook_config == HOOK_CONFIG
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_initialization_with_sagemaker_config_injection_no_kms_supported(
Expand DownExpand Up@@ -1351,8 +1355,11 @@ def test_framework_with_only_profiler_rule_specified(sagemaker_session):
 ]


@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("time.time", return_value=TIME)
def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_session):
def test_framework_with_profiler_config_without_s3_output_path(
 time, send_telemetry_request, sagemaker_session
):
 f = DummyFramework(
 entry_point=SCRIPT_PATH,
 role=ROLE,
Expand All@@ -1361,6 +1368,7 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 instance_type=INSTANCE_TYPE,
 profiler_config=ProfilerConfig(system_monitor_interval_millis=1000),
 )
 assert f._profiler_config_explicitly_provided is True
 f.fit("s3://mydata")
 sagemaker_session.train.assert_called_once()
 _, args = sagemaker_session.train.call_args
Expand All@@ -1369,6 +1377,9 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 "S3OutputPath": "s3://{}/".format(BUCKET_NAME),
 "ProfilingIntervalInMilliseconds": 1000,
 }
 telemetry_extra = send_telemetry_request.call_args.args[5]
 assert "&x-debuggerHookConfigExplicitlyProvided=false" in telemetry_extra
 assert "&x-profilerConfigExplicitlyProvided=true" in telemetry_extra


@pytest.mark.parametrize("region", PROFILER_UNSUPPORTED_REGIONS)
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: track explicit debugger and profiler configuration#6202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

nargokul
wants to merge
1
commit into

base:master-v2
Choose a base branch

from


+63

−4

 Open


feat: track explicit debugger and profiler configuration
#6202
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
src/sagemaker/estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -775,6 +775,8 @@ def __init__(
 self.checkpoint_local_path = checkpoint_local_path

 self.rules = rules
 self._debugger_hook_config_explicitly_provided = debugger_hook_config is not None
 self._profiler_config_explicitly_provided = profiler_config is not None

 # Today, we ONLY support debugger_hook_config to be provided as a boolean value
 # from sagemaker_config. We resolve value for this parameter as per the order
Expand DownExpand Up@@ -1366,7 +1368,14 @@ def latest_job_profiler_artifacts_path(self):
 )
 return None

 @_telemetry_emitter(feature=Feature.ESTIMATOR_V2, func_name="estimator.fit")
 @_telemetry_emitter(
 feature=Feature.ESTIMATOR_V2,
 func_name="estimator.fit",
 telemetry_params={
 "debuggerHookConfigExplicitlyProvided": ("_debugger_hook_config_explicitly_provided"),
 "profilerConfigExplicitlyProvided": "_profiler_config_explicitly_provided",
 },
 )
 @runnable_by_pipeline
 def fit(
 self,
Expand Down

17 changes: 15 additions & 2 deletions
src/sagemaker/telemetry/telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,7 +16,7 @@
import platform
import sys
from time import perf_counter
from typing import List
from typing import Dict, List
import functools
import requests

Expand DownExpand Up@@ -67,14 +67,19 @@
}


def _telemetry_emitter(feature: str, func_name: str):
def _telemetry_emitter(feature: str, func_name: str, telemetry_params: Dict[str, str] = None):
 """Telemetry Emitter

 Decorator to emit telemetry logs for SageMaker Python SDK functions. This class needs
 sagemaker_session object as a member. Default session object is a pysdk v2 Session object
 in this repo. When collecting telemetry for classes using sagemaker-core Session object,
 we should be aware of its differences, such as sagemaker_session.sagemaker_config does not
 exist in new Session class.

 Args:
 feature: Feature enum value for the telemetry event.
 func_name: Name of the instrumented function.
 telemetry_params: Mapping of telemetry field names to instance attribute names.
 """

 def decorator(func):
Expand DownExpand Up@@ -136,6 +141,14 @@ def wrapper(*args, **kwargs):
 if hasattr(sagemaker_session, "endpoint_arn") and sagemaker_session.endpoint_arn:
 extra += f"&x-endpointArn={sagemaker_session.endpoint_arn}"

 if telemetry_params and args:
 for field_name, attribute_name in telemetry_params.items():
 value = getattr(args[0], attribute_name, None)
 if isinstance(value, bool):
 value = str(value).lower()
 if value is not None:
 extra += f"&x-{field_name}={value}"

 start_timer = perf_counter()
 try:
 # Call the original function
Expand Down

26 changes: 26 additions & 0 deletions
tests/unit/sagemaker/telemetry/test_telemetry_logging.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,12 +42,25 @@
class LocalSagemakerClientMock:
 def __init__(self):
 self.sagemaker_session = MOCK_SESSION
 self._debugger_explicitly_provided = True
 self._profiler_explicitly_provided = False

 @_telemetry_emitter(MOCK_FEATURE, MOCK_FUNC_NAME)
 def mock_create_model(self, mock_exception_func=None):
 if mock_exception_func:
 mock_exception_func()

 @_telemetry_emitter(
 MOCK_FEATURE,
 MOCK_FUNC_NAME,
 telemetry_params={
 "debuggerExplicitlyProvided": "_debugger_explicitly_provided",
 "profilerExplicitlyProvided": "_profiler_explicitly_provided",
 },
 )
 def mock_train(self):
 return None


class TestTelemetryLogging(unittest.TestCase):
 @patch("sagemaker.telemetry.telemetry_logging._requests_helper")
Expand DownExpand Up@@ -147,6 +160,19 @@ def test_telemetry_emitter_decorator_success(
 1, [1, 2], MOCK_SESSION, None, None, expected_extra_str
 )

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_adds_instance_params(
 self, mock_resolve_config, mock_send_telemetry_request
 ):
 mock_resolve_config.return_value = False

 LocalSagemakerClientMock().mock_train()

 extra = mock_send_telemetry_request.call_args.args[5]
 assert "&x-debuggerExplicitlyProvided=true" in extra
 assert "&x-profilerExplicitlyProvided=false" in extra

 @patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
 @patch("sagemaker.telemetry.telemetry_logging.resolve_value_from_config")
 def test_telemetry_emitter_decorator_handle_exception_success(
Expand Down

13 changes: 12 additions & 1 deletion
tests/unit/test_estimator.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -672,6 +672,8 @@ def test_estimator_initialization_with_sagemaker_config_injection(sagemaker_sess
 assert estimator.environment == expected_environment
 assert estimator.disable_profiler == expected_disable_profiler_attribute
 assert estimator.debugger_hook_config == expected_debugger_hook_config
 assert estimator._debugger_hook_config_explicitly_provided is False
 assert estimator._profiler_config_explicitly_provided is False


def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
Expand All@@ -694,6 +696,7 @@ def test_estimator_with_debugger_hook_config_provided_as_bool_from_direct_input(
 debugger_hook_config=True,
 )
 assert estimator.debugger_hook_config == {}
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
Expand All@@ -715,6 +718,7 @@ def test_estimator_with_debugger_hook_config_provided_as_dict_from_direct_input(
 debugger_hook_config=HOOK_CONFIG,
 )
 assert estimator.debugger_hook_config == HOOK_CONFIG
 assert estimator._debugger_hook_config_explicitly_provided is True


def test_estimator_initialization_with_sagemaker_config_injection_no_kms_supported(
Expand DownExpand Up@@ -1351,8 +1355,11 @@ def test_framework_with_only_profiler_rule_specified(sagemaker_session):
 ]


@patch("sagemaker.telemetry.telemetry_logging._send_telemetry_request")
@patch("time.time", return_value=TIME)
def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_session):
def test_framework_with_profiler_config_without_s3_output_path(
 time, send_telemetry_request, sagemaker_session
):
 f = DummyFramework(
 entry_point=SCRIPT_PATH,
 role=ROLE,
Expand All@@ -1361,6 +1368,7 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 instance_type=INSTANCE_TYPE,
 profiler_config=ProfilerConfig(system_monitor_interval_millis=1000),
 )
 assert f._profiler_config_explicitly_provided is True
 f.fit("s3://mydata")
 sagemaker_session.train.assert_called_once()
 _, args = sagemaker_session.train.call_args
Expand All@@ -1369,6 +1377,9 @@ def test_framework_with_profiler_config_without_s3_output_path(time, sagemaker_s
 "S3OutputPath": "s3://{}/".format(BUCKET_NAME),
 "ProfilingIntervalInMilliseconds": 1000,
 }
 telemetry_extra = send_telemetry_request.call_args.args[5]
 assert "&x-debuggerHookConfigExplicitlyProvided=false" in telemetry_extra
 assert "&x-profilerConfigExplicitlyProvided=true" in telemetry_extra


@pytest.mark.parametrize("region", PROFILER_UNSUPPORTED_REGIONS)
Expand Down
Loading