Skip to content

⚡️ Speed up _get_google_cloud_logs_url() by 12% in sentry_sdk/integrations/gcp.py #12

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

⚡️ Speed up _get_google_cloud_logs_url() by 12% in sentry_sdk/integrations/gcp.py #12

wants to merge 1 commit into from

Conversation

@codeflash-ai
Copy link

@codeflash-ai codeflash-ai bot commented Jun 15, 2024

📄 _get_google_cloud_logs_url() in sentry_sdk/integrations/gcp.py

📈 Performance improved by 12% (0.12x faster)

⏱️ Runtime went down from 385 microseconds to 345 microseconds

Explanation and details

This can be optimized by avoiding the repeated calls to datetime.strftime(), storing environment variables in local variables to reduce repeated dictionary lookups, and simplifying the string formatting process. Here is the optimized version.

Changes Made.

  1. Local Environment Variables: Stored the environment variables in local variables to avoid multiple lookups.
  2. String Formatting: Used f-strings for more efficient and readable string concatenation.

This should reduce the number of function calls and dictionary lookups, resulting in a slight performance improvement.

Correctness verification

The new optimized code was tested for correctness. The results are listed below.

🔘 (none found) − ⚙️ Existing Unit Tests

✅ 9 Passed − 🌀 Generated Regression Tests

(click to show generated tests) 
# imports
from datetime import datetime, timedelta, timezone
from os import environ

import pytest  # used for our unit tests
from sentry_sdk.integrations.gcp import _get_google_cloud_logs_url


# unit tests
def test_basic_functionality():
    # Basic functionality test
    environ['GCP_PROJECT'] = 'my_project'
    environ['FUNCTION_NAME'] = 'my_function'
    environ['FUNCTION_REGION'] = 'us-central1'
    final_time = datetime(2023, 10, 1, 12, 0, 0)
    expected_url = (
        "https://console.cloud.google.com/logs/viewer?project=my_project&resource=cloud_function"
        "%2Ffunction_name%2Fmy_function%2Fregion%2Fus-central1&minLogLevel=0&expandAll=false"
        "&timestamp=2023-10-01T12:00:00Z&customFacets=&limitCustomFacetWidth=true"
        "&dateRangeStart=2023-10-01T11:00:00Z&dateRangeEnd=2023-10-01T12:00:00Z"
        "&interval=PT1H&scrollTimestamp=2023-10-01T12:00:00Z"
    )
    assert _get_google_cloud_logs_url(final_time) == expected_url

def test_missing_environment_variables():
    # Test with missing environment variables
    environ.pop('GCP_PROJECT', None)
    environ.pop('FUNCTION_NAME', None)
    environ.pop('FUNCTION_REGION', None)
    final_time = datetime(2023, 10, 1, 12, 0, 0)
    expected_url = (
        "https://console.cloud.google.com/logs/viewer?project=None&resource=cloud_function"
        "%2Ffunction_name%2FNone%2Fregion%2FNone&minLogLevel=0&expandAll=false"
        "&timestamp=2023-10-01T12:00:00Z&customFacets=&limitCustomFacetWidth=true"
        "&dateRangeStart=2023-10-01T11:00:00Z&dateRangeEnd=2023-10-01T12:00:00Z"
        "&interval=PT1H&scrollTimestamp=2023-10-01T12:00:00Z"
    )
    assert _get_google_cloud_logs_url(final_time) == expected_url

def test_timezone_aware_datetime():
    # Test with timezone-aware datetime object
    environ['GCP_PROJECT'] = 'my_project'
    environ['FUNCTION_NAME'] = 'my_function'
    environ['FUNCTION_REGION'] = 'us-central1'
    final_time = datetime(2023, 10, 1, 12, 0, 0, tzinfo=timezone.utc)
    expected_url = (
        "https://console.cloud.google.com/logs/viewer?project=my_project&resource=cloud_function"
        "%2Ffunction_name%2Fmy_function%2Fregion%2Fus-central1&minLogLevel=0&expandAll=false"
        "&timestamp=2023-10-01T12:00:00Z&customFacets=&limitCustomFacetWidth=true"
        "&dateRangeStart=2023-10-01T11:00:00Z&dateRangeEnd=2023-10-01T12:00:00Z"
        "&interval=PT1H&scrollTimestamp=2023-10-01T12:00:00Z"
    )
    assert _get_google_cloud_logs_url(final_time) == expected_url

def test_midnight_boundary():
    # Test with final_time set to midnight
    environ['GCP_PROJECT'] = 'my_project'
    environ['FUNCTION_NAME'] = 'my_function'
    environ['FUNCTION_REGION'] = 'us-central1'
    final_time = datetime(2023, 10, 1, 0, 0, 0)
    expected_url = (
        "https://console.cloud.google.com/logs/viewer?project=my_project&resource=cloud_function"
        "%2Ffunction_name%2Fmy_function%2Fregion%2Fus-central1&minLogLevel=0&expandAll=false"
        "&timestamp=2023-10-01T00:00:00Z&customFacets=&limitCustomFacetWidth=true"
        "&dateRangeStart=2022-09-30T23:00:00Z&dateRangeEnd=2023-10-01T00:00:00Z"
        "&interval=PT1H&scrollTimestamp=2023-10-01T00:00:00Z"
    )
    assert _get_google_cloud_logs_url(final_time) == expected_url

def test_leap_year_date():
    # Test with final_time set to February 29th of a leap year
    environ['GCP_PROJECT'] = 'my_project'
    environ['FUNCTION_NAME'] = 'my_function'
    environ['FUNCTION_REGION'] = 'us-central1'
    final_time = datetime(2024, 2, 29, 12, 0, 0)
    expected_url = (
        "https://console.cloud.google.com/logs/viewer?project=my_project&resource=cloud_function"
        "%2Ffunction_name%2Fmy_function%2Fregion%2Fus-central1&minLogLevel=0&expandAll=false"
        "&timestamp=2024-02-29T12:00:00Z&customFacets=&limitCustomFacetWidth=true"
        "&dateRangeStart=2024-02-29T11:00:00Z&dateRangeEnd=2024-02-29T12:00:00Z"
        "&interval=PT1H&scrollTimestamp=2024-02-29T12:00:00Z"
    )
    assert _get_google_cloud_logs_url(final_time) == expected_url

def test_invalid_input():
    # Test with non-datetime input
    with pytest.raises(TypeError):
        _get_google_cloud_logs_url("2023-10-01T12:00:00Z")

def test_future_date():
    # Test with final_time set to a future date
    environ['GCP_PROJECT'] = 'my_project'
    environ['FUNCTION_NAME'] = 'my_function'
    environ['FUNCTION_REGION'] = 'us-central1'
    final_time = datetime(2030, 10, 1, 12, 0, 0)
    expected_url = (
        "https://console.cloud.google.com/logs/viewer?project=my_project&resource=cloud_function"
        "%2Ffunction_name%2Fmy_function%2Fregion%2Fus-central1&minLogLevel=0&expandAll=false"
        "&timestamp=2030-10-01T12:00:00Z&customFacets=&limitCustomFacetWidth=true"
        "&dateRangeStart=2030-10-01T11:00:00Z&dateRangeEnd=2030-10-01T12:00:00Z"
        "&interval=PT1H&scrollTimestamp=2030-10-01T12:00:00Z"
    )
    assert _get_google_cloud_logs_url(final_time) == expected_url

def test_performance_and_scalability():
    # Performance and scalability test with multiple calls
    environ['GCP_PROJECT'] = 'my_project'
    environ['FUNCTION_NAME'] = 'my_function'
    environ['FUNCTION_REGION'] = 'us-central1'
    final_time = datetime(2023, 10, 1, 12, 0, 0)
    for _ in range(1000):
        _get_google_cloud_logs_url(final_time)

def test_exact_one_hour_difference():
    # Test with final_time exactly one hour after a known timestamp
    environ['GCP_PROJECT'] = 'my_project'
    environ['FUNCTION_NAME'] = 'my_function'
    environ['FUNCTION_REGION'] = 'us-central1'
    final_time = datetime(2023, 10, 1, 12, 0, 0)
    expected_url = (
        "https://console.cloud.google.com/logs/viewer?project=my_project&resource=cloud_function"
        "%2Ffunction_name%2Fmy_function%2Fregion%2Fus-central1&minLogLevel=0&expandAll=false"
        "&timestamp=2023-10-01T12:00:00Z&customFacets=&limitCustomFacetWidth=true"
        "&dateRangeStart=2023-10-01T11:00:00Z&dateRangeEnd=2023-10-01T12:00:00Z"
        "&interval=PT1H&scrollTimestamp=2023-10-01T12:00:00Z"
    )
    assert _get_google_cloud_logs_url(final_time) == expected_url

🔘 (none found) − ⏪ Replay Tests

@codeflash-ai
⚡️ Speed up _get_google_cloud_logs_url() by 12%
df098bc 
This can be optimized by avoiding the repeated calls to `datetime.strftime()`, storing environment variables in local variables to reduce repeated dictionary lookups, and simplifying the string formatting process. Here is the optimized version.



### Changes Made.
1. **Local Environment Variables**: Stored the environment variables in local variables to avoid multiple lookups.
2. **String Formatting**: Used f-strings for more efficient and readable string concatenation.

This should reduce the number of function calls and dictionary lookups, resulting in a slight performance improvement.
@codeflash-ai codeflash-ai bot added the ⚡️ codeflash Optimization PR opened by Codeflash AI label Jun 15, 2024
@codeflash-ai codeflash-ai bot requested a review from misrasaurabh1 June 15, 2024 06:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@misrasaurabh1 misrasaurabh1 Awaiting requested review from misrasaurabh1

Assignees

No one assigned

Labels

⚡️ codeflash Optimization PR opened by Codeflash AI

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant