Skip to content
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.

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

change: Allow telemetry only in supported regions #5009

Merged
merged 7 commits into from
Jan 31, 2025

Conversation

rsareddy0329
Copy link
Contributor

Issue #, if available:
There is a security vulnerability with the current telemetry setup where the AWS control through unclaimed S3-buckets

Description of changes:

  • Added list of regions supported for telemetry logging : [src/sagemaker/telemetry/constants.py]
  • Added validation for the region if it exists in the current supported ones : [src/sagemaker/telemetry/telemetry_logging.py]
  • Added unit tests to verify the validation code: [tests/unit/sagemaker/telemetry/test_telemetry_logging.py]

Testing done:
yes, added unit tests for the code change and tested it.

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the CONTRIBUTING doc
  • I certify that the changes I am introducing will be backward compatible, and I have discussed concerns about this, if any, with the Python SDK team
  • I used the commit message format described in CONTRIBUTING
  • I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
  • I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added unit and/or integration tests as appropriate to ensure backward compatibility of the changes
  • I have checked that my tests are not configured for a specific region or account (if appropriate)
  • I have used unique_name_from_base to create resource names in integ tests (if appropriate)
  • If adding any dependency in requirements.txt files, I have spell checked and ensured they exist in PyPi

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Comment on lines 200 to 201
logger.debug(
"Region not found in supported regions. Telemetry request will not be emitted."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets change to logger.warning

Comment on lines 204 to 205
else: # telemetry will be sent to us-west-2 if no session available
region = DEFAULT_AWS_REGION
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isnt this redundant? This condition is already covered in _get_region_or_default

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so, _get_region_or_default covers the condition where session is available but the region value is not allocated.
The else part takes care of the condition when session details are not available.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like we are assigning the same thing in 2 different places which is something we can simplify.

By removing the if session condition here in line195 and handling everything within _get_region_or_default

If session is None , it will automatically raise an Exception and will get assigned the default value in L#278.

@nargokul nargokul marked this pull request as ready for review January 29, 2025 22:35
@nargokul nargokul requested a review from a team as a code owner January 29, 2025 22:35
@nargokul nargokul self-requested a review January 29, 2025 22:35
@rsareddy0329 rsareddy0329 requested a review from benieric January 30, 2025 21:32
@benieric benieric merged commit 90e9c9f into aws:master Jan 31, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants