diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c6e6415b65..94d6f5c18e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,7 +24,7 @@ jobs: timeout-minutes: 10 steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: 3.12 @@ -39,7 +39,7 @@ jobs: timeout-minutes: 10 steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: 3.12 @@ -54,7 +54,7 @@ jobs: timeout-minutes: 10 steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: 3.12 @@ -70,11 +70,14 @@ jobs: # This will also trigger "make dist" that creates the Python packages make aws-lambda-layer - name: Upload Python Packages - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: - name: ${{ github.sha }} + name: artifact-build_lambda_layer path: | dist/* + if-no-files-found: 'error' + # since this artifact will be merged, compression is not necessary + compression-level: '0' docs: name: Build SDK API Doc @@ -82,7 +85,7 @@ jobs: timeout-minutes: 10 steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: 3.12 @@ -91,7 +94,23 @@ jobs: make apidocs cd docs/_build && zip -r gh-pages ./ - - uses: actions/upload-artifact@v3.1.1 + - uses: actions/upload-artifact@v4 + with: + name: artifact-docs + path: | + docs/_build/gh-pages.zip + if-no-files-found: 'error' + # since this artifact will be merged, compression is not necessary + compression-level: '0' + + merge: + name: Create Release Artifact + runs-on: ubuntu-latest + needs: [build_lambda_layer, docs] + steps: + - uses: actions/upload-artifact/merge@v4 with: + # Craft expects release assets from github to be a single artifact named after the sha. name: ${{ github.sha }} - path: docs/_build/gh-pages.zip + pattern: artifact-* + delete-merged: true diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 86cba0e022..6e3aef78c5 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -46,7 +46,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4.1.7 + uses: actions/checkout@v4.2.0 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index fd560bb17a..2ebb4b33fa 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -18,7 +18,7 @@ jobs: runs-on: ubuntu-latest name: "Release a new version" steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 with: token: ${{ secrets.GH_RELEASE_PAT }} fetch-depth: 0 diff --git a/.github/workflows/test-integrations-ai.yml b/.github/workflows/test-integrations-ai.yml index c3c8f7a689..1a9f9a6e1b 100644 --- a/.github/workflows/test-integrations-ai.yml +++ b/.github/workflows/test-integrations-ai.yml @@ -27,14 +27,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.7","3.9","3.11","3.12"] + python-version: ["3.7","3.9","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -66,13 +66,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-huggingface_hub-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -82,12 +82,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-ai-pinned: name: AI (pinned) timeout-minutes: 30 @@ -95,14 +99,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.7","3.9","3.11","3.12"] + python-version: ["3.7","3.9","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -134,13 +138,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-huggingface_hub" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -150,12 +154,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All AI tests passed needs: test-ai-pinned diff --git a/.github/workflows/test-integrations-aws-lambda.yml b/.github/workflows/test-integrations-aws-lambda.yml index 10e319f8a2..d1996d288d 100644 --- a/.github/workflows/test-integrations-aws-lambda.yml +++ b/.github/workflows/test-integrations-aws-lambda.yml @@ -32,7 +32,7 @@ jobs: name: permissions check runs-on: ubuntu-20.04 steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 with: persist-credentials: false - name: Check permissions on PR @@ -67,7 +67,7 @@ jobs: os: [ubuntu-20.04] needs: check-permissions steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 with: ref: ${{ github.event.pull_request.head.sha || github.ref }} - uses: actions/setup-python@v5 @@ -85,13 +85,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-aws_lambda" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -101,12 +101,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All AWS Lambda tests passed needs: test-aws_lambda-pinned diff --git a/.github/workflows/test-integrations-cloud-computing.yml b/.github/workflows/test-integrations-cloud-computing.yml index 94dd3473cd..ecaf412274 100644 --- a/.github/workflows/test-integrations-cloud-computing.yml +++ b/.github/workflows/test-integrations-cloud-computing.yml @@ -27,14 +27,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8","3.11","3.12"] + python-version: ["3.8","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -62,13 +62,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-gcp-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -78,12 +78,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-cloud_computing-pinned: name: Cloud Computing (pinned) timeout-minutes: 30 @@ -91,14 +95,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.6","3.7","3.9","3.11","3.12"] + python-version: ["3.6","3.7","3.9","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -126,13 +130,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-gcp" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -142,12 +146,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All Cloud Computing tests passed needs: test-cloud_computing-pinned diff --git a/.github/workflows/test-integrations-common.yml b/.github/workflows/test-integrations-common.yml index dbb3cb5d53..03673b8061 100644 --- a/.github/workflows/test-integrations-common.yml +++ b/.github/workflows/test-integrations-common.yml @@ -34,7 +34,7 @@ jobs: # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -50,13 +50,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-common" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -66,12 +66,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All Common tests passed needs: test-common-pinned diff --git a/.github/workflows/test-integrations-data-processing.yml b/.github/workflows/test-integrations-data-processing.yml index 6eb3a9f71f..f2029df24f 100644 --- a/.github/workflows/test-integrations-data-processing.yml +++ b/.github/workflows/test-integrations-data-processing.yml @@ -27,14 +27,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.6","3.7","3.8","3.10","3.11","3.12"] + python-version: ["3.6","3.7","3.8","3.10","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -80,13 +80,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-spark-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -96,12 +96,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-data_processing-pinned: name: Data Processing (pinned) timeout-minutes: 30 @@ -116,7 +120,7 @@ jobs: # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -162,13 +166,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-spark" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -178,12 +182,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All Data Processing tests passed needs: test-data_processing-pinned diff --git a/.github/workflows/test-integrations-databases.yml b/.github/workflows/test-integrations-databases.yml index eca776d1c4..6a9f43eac0 100644 --- a/.github/workflows/test-integrations-databases.yml +++ b/.github/workflows/test-integrations-databases.yml @@ -27,7 +27,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.7","3.8","3.11","3.12"] + python-version: ["3.7","3.8","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 @@ -52,7 +52,7 @@ jobs: SENTRY_PYTHON_TEST_POSTGRES_USER: postgres SENTRY_PYTHON_TEST_POSTGRES_PASSWORD: sentry steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -89,13 +89,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-sqlalchemy-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -105,12 +105,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-databases-pinned: name: Databases (pinned) timeout-minutes: 30 @@ -143,7 +147,7 @@ jobs: SENTRY_PYTHON_TEST_POSTGRES_USER: postgres SENTRY_PYTHON_TEST_POSTGRES_PASSWORD: sentry steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -180,13 +184,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-sqlalchemy" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -196,12 +200,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All Databases tests passed needs: test-databases-pinned diff --git a/.github/workflows/test-integrations-graphql.yml b/.github/workflows/test-integrations-graphql.yml index c89423327a..3f35caa706 100644 --- a/.github/workflows/test-integrations-graphql.yml +++ b/.github/workflows/test-integrations-graphql.yml @@ -27,14 +27,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.7","3.8","3.11","3.12"] + python-version: ["3.7","3.8","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -62,13 +62,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-strawberry-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -78,12 +78,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-graphql-pinned: name: GraphQL (pinned) timeout-minutes: 30 @@ -98,7 +102,7 @@ jobs: # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -126,13 +130,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-strawberry" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -142,12 +146,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All GraphQL tests passed needs: test-graphql-pinned diff --git a/.github/workflows/test-integrations-miscellaneous.yml b/.github/workflows/test-integrations-miscellaneous.yml index 492338c40e..5761fa4434 100644 --- a/.github/workflows/test-integrations-miscellaneous.yml +++ b/.github/workflows/test-integrations-miscellaneous.yml @@ -27,14 +27,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.6","3.8","3.11","3.12"] + python-version: ["3.6","3.8","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -66,13 +66,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-trytond-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -82,12 +82,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-miscellaneous-pinned: name: Miscellaneous (pinned) timeout-minutes: 30 @@ -95,14 +99,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.6","3.7","3.8","3.9","3.10","3.11","3.12"] + python-version: ["3.6","3.7","3.8","3.9","3.10","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -134,13 +138,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-trytond" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -150,12 +154,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All Miscellaneous tests passed needs: test-miscellaneous-pinned diff --git a/.github/workflows/test-integrations-networking.yml b/.github/workflows/test-integrations-networking.yml index fb55e708ae..5469cf89a1 100644 --- a/.github/workflows/test-integrations-networking.yml +++ b/.github/workflows/test-integrations-networking.yml @@ -27,14 +27,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8","3.9","3.11","3.12"] + python-version: ["3.8","3.9","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -62,13 +62,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-requests-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -78,12 +78,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-networking-pinned: name: Networking (pinned) timeout-minutes: 30 @@ -91,14 +95,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.6","3.7","3.8","3.9","3.10","3.11","3.12"] + python-version: ["3.6","3.7","3.8","3.9","3.10","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -126,13 +130,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-requests" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -142,12 +146,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All Networking tests passed needs: test-networking-pinned diff --git a/.github/workflows/test-integrations-web-frameworks-1.yml b/.github/workflows/test-integrations-web-frameworks-1.yml index 01b391992d..0a1e2935fb 100644 --- a/.github/workflows/test-integrations-web-frameworks-1.yml +++ b/.github/workflows/test-integrations-web-frameworks-1.yml @@ -27,7 +27,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8","3.10","3.11","3.12"] + python-version: ["3.8","3.10","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 @@ -52,7 +52,7 @@ jobs: SENTRY_PYTHON_TEST_POSTGRES_USER: postgres SENTRY_PYTHON_TEST_POSTGRES_PASSWORD: sentry steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -80,13 +80,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-fastapi-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -96,12 +96,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-web_frameworks_1-pinned: name: Web Frameworks 1 (pinned) timeout-minutes: 30 @@ -134,7 +138,7 @@ jobs: SENTRY_PYTHON_TEST_POSTGRES_USER: postgres SENTRY_PYTHON_TEST_POSTGRES_PASSWORD: sentry steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -162,13 +166,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-fastapi" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -178,12 +182,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All Web Frameworks 1 tests passed needs: test-web_frameworks_1-pinned diff --git a/.github/workflows/test-integrations-web-frameworks-2.yml b/.github/workflows/test-integrations-web-frameworks-2.yml index 310921a250..c6e2268a43 100644 --- a/.github/workflows/test-integrations-web-frameworks-2.yml +++ b/.github/workflows/test-integrations-web-frameworks-2.yml @@ -27,14 +27,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.6","3.7","3.8","3.11","3.12"] + python-version: ["3.6","3.7","3.8","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -86,13 +86,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh "py${{ matrix.python-version }}-tornado-latest" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -102,12 +102,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true test-web_frameworks_2-pinned: name: Web Frameworks 2 (pinned) timeout-minutes: 30 @@ -115,14 +119,14 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.6","3.7","3.8","3.9","3.11","3.12"] + python-version: ["3.6","3.7","3.8","3.9","3.11","3.12","3.13"] # python3.6 reached EOL and is no longer being supported on # new versions of hosted runners on Github Actions # ubuntu-20.04 is the last version that supported python3.6 # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 os: [ubuntu-20.04] steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} @@ -174,13 +178,13 @@ jobs: set -x # print commands that are executed ./scripts/runtox.sh --exclude-latest "py${{ matrix.python-version }}-tornado" - name: Generate coverage XML (Python 3.6) - if: ${{ !cancelled() && matrix.python-version == '3.6' }} + if: ${{ !cancelled() && matrix.python-version == '3.6' }} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: ${{ !cancelled() && matrix.python-version != '3.6' }} + if: ${{ !cancelled() && matrix.python-version != '3.6' }} run: | coverage combine .coverage-sentry-* coverage xml @@ -190,12 +194,16 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 with: token: ${{ secrets.CODECOV_TOKEN }} files: .junitxml + verbose: true check_required_tests: name: All Web Frameworks 2 tests passed needs: test-web_frameworks_2-pinned diff --git a/CHANGELOG.md b/CHANGELOG.md index 0fa0621afb..7db062694d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,100 @@ # Changelog +## 2.15.0 + +### Integrations + +- Configure HTTP methods to capture in ASGI/WSGI middleware and frameworks (#3531) by @antonpirker + + We've added a new option to the Django, Flask, Starlette and FastAPI integrations called `http_methods_to_capture`. This is a configurable tuple of HTTP method verbs that should create a transaction in Sentry. The default is `("CONNECT", "DELETE", "GET", "PATCH", "POST", "PUT", "TRACE",)`. `OPTIONS` and `HEAD` are not included by default. + + Here's how to use it (substitute Flask for your framework integration): + + ```python + sentry_sdk.init( + integrations=[ + FlaskIntegration( + http_methods_to_capture=("GET", "POST"), + ), + ], + ) + +- Django: Allow ASGI to use `drf_request` in `DjangoRequestExtractor` (#3572) by @PakawiNz +- Django: Don't let `RawPostDataException` bubble up (#3553) by @sentrivana +- Django: Add `sync_capable` to `SentryWrappingMiddleware` (#3510) by @szokeasaurusrex +- AIOHTTP: Add `failed_request_status_codes` (#3551) by @szokeasaurusrex + + You can now define a set of integers that will determine which status codes + should be reported to Sentry. + + ```python + sentry_sdk.init( + integrations=[ + AioHttpIntegration( + failed_request_status_codes={403, *range(500, 600)}, + ) + ] + ) + ``` + + Examples of valid `failed_request_status_codes`: + + - `{500}` will only send events on HTTP 500. + - `{400, *range(500, 600)}` will send events on HTTP 400 as well as the 5xx range. + - `{500, 503}` will send events on HTTP 500 and 503. + - `set()` (the empty set) will not send events for any HTTP status code. + + The default is `{*range(500, 600)}`, meaning that all 5xx status codes are reported to Sentry. + +- AIOHTTP: Delete test which depends on AIOHTTP behavior (#3568) by @szokeasaurusrex +- AIOHTTP: Handle invalid responses (#3554) by @szokeasaurusrex +- FastAPI/Starlette: Support new `failed_request_status_codes` (#3563) by @szokeasaurusrex + + The format of `failed_request_status_codes` has changed from a list + of integers and containers to a set: + + ```python + sentry_sdk.init( + integrations=StarletteIntegration( + failed_request_status_codes={403, *range(500, 600)}, + ), + ) + ``` + + The old way of defining `failed_request_status_codes` will continue to work + for the time being. Examples of valid new-style `failed_request_status_codes`: + + - `{500}` will only send events on HTTP 500. + - `{400, *range(500, 600)}` will send events on HTTP 400 as well as the 5xx range. + - `{500, 503}` will send events on HTTP 500 and 503. + - `set()` (the empty set) will not send events for any HTTP status code. + + The default is `{*range(500, 600)}`, meaning that all 5xx status codes are reported to Sentry. + +- FastAPI/Starlette: Fix `failed_request_status_codes=[]` (#3561) by @szokeasaurusrex +- FastAPI/Starlette: Remove invalid `failed_request_status_code` tests (#3560) by @szokeasaurusrex +- FastAPI/Starlette: Refactor shared test parametrization (#3562) by @szokeasaurusrex + +### Miscellaneous + +- Deprecate `sentry_sdk.metrics` (#3512) by @szokeasaurusrex +- Add `name` parameter to `start_span()` and deprecate `description` parameter (#3524 & #3525) by @antonpirker +- Fix `add_query_source` with modules outside of project root (#3313) by @rominf +- Test more integrations on 3.13 (#3578) by @sentrivana +- Fix trailing whitespace (#3579) by @sentrivana +- Improve `get_integration` typing (#3550) by @szokeasaurusrex +- Make import-related tests stable (#3548) by @BYK +- Fix breadcrumb sorting (#3511) by @sentrivana +- Fix breadcrumb timestamp casting and its tests (#3546) by @BYK +- Don't use deprecated `logger.warn` (#3552) by @sentrivana +- Fix Cohere API change (#3549) by @BYK +- Fix deprecation message (#3536) by @antonpirker +- Remove experimental `explain_plan` feature. (#3534) by @antonpirker +- X-fail one of the Lambda tests (#3592) by @antonpirker +- Update Codecov config (#3507) by @antonpirker +- Update `actions/upload-artifact` to `v4` with merge (#3545) by @joshuarli +- Bump `actions/checkout` from `4.1.7` to `4.2.0` (#3585) by @dependabot + ## 2.14.0 ### Various fixes & improvements @@ -47,7 +142,7 @@ init_sentry() ray.init( - runtime_env=dict(worker_process_setup_hook=init_sentry), + runtime_env=dict(worker_process_setup_hook=init_sentry), ) ``` For more information, see the documentation for the [Ray integration](https://docs.sentry.io/platforms/python/integrations/ray/). @@ -99,7 +194,7 @@ For more information, see the documentation for the [Dramatiq integration](https://docs.sentry.io/platforms/python/integrations/dramatiq/). - **New config option:** Expose `custom_repr` function that precedes `safe_repr` invocation in serializer (#3438) by @sl0thentr0py - + See: https://docs.sentry.io/platforms/python/configuration/options/#custom-repr - Profiling: Add client SDK info to profile chunk (#3386) by @Zylphrex diff --git a/docs/conf.py b/docs/conf.py index 875dfcb575..c1a219e278 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ copyright = "2019-{}, Sentry Team and Contributors".format(datetime.now().year) author = "Sentry Team and Contributors" -release = "2.14.0" +release = "2.15.0" version = ".".join(release.split(".")[:2]) # The short X.Y version. diff --git a/scripts/split-tox-gh-actions/templates/check_permissions.jinja b/scripts/split-tox-gh-actions/templates/check_permissions.jinja index 4c418cd67a..4b85f9329a 100644 --- a/scripts/split-tox-gh-actions/templates/check_permissions.jinja +++ b/scripts/split-tox-gh-actions/templates/check_permissions.jinja @@ -2,7 +2,7 @@ name: permissions check runs-on: ubuntu-20.04 steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 with: persist-credentials: false diff --git a/scripts/split-tox-gh-actions/templates/test_group.jinja b/scripts/split-tox-gh-actions/templates/test_group.jinja index e63d6e0235..f232fb0bc4 100644 --- a/scripts/split-tox-gh-actions/templates/test_group.jinja +++ b/scripts/split-tox-gh-actions/templates/test_group.jinja @@ -39,7 +39,7 @@ {% endif %} steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 {% if needs_github_secrets %} {% raw %} with: @@ -78,14 +78,14 @@ {% endfor %} - name: Generate coverage XML (Python 3.6) - if: {% raw %}${{ !cancelled() && matrix.python-version == '3.6' }}{% endraw %} + if: {% raw %}${{ !cancelled() && matrix.python-version == '3.6' }}{% endraw %} run: | export COVERAGE_RCFILE=.coveragerc36 coverage combine .coverage-sentry-* coverage xml --ignore-errors - name: Generate coverage XML - if: {% raw %}${{ !cancelled() && matrix.python-version != '3.6' }}{% endraw %} + if: {% raw %}${{ !cancelled() && matrix.python-version != '3.6' }}{% endraw %} run: | coverage combine .coverage-sentry-* coverage xml @@ -96,10 +96,14 @@ with: token: {% raw %}${{ secrets.CODECOV_TOKEN }}{% endraw %} files: coverage.xml + # make sure no plugins alter our coverage reports + plugin: noop + verbose: true - name: Upload test results to Codecov if: {% raw %}${{ !cancelled() }}{% endraw %} uses: codecov/test-results-action@v1 with: token: {% raw %}${{ secrets.CODECOV_TOKEN }}{% endraw %} - files: .junitxml \ No newline at end of file + files: .junitxml + verbose: true diff --git a/sentry_sdk/ai/monitoring.py b/sentry_sdk/ai/monitoring.py index e1679b0bc6..860833b8f5 100644 --- a/sentry_sdk/ai/monitoring.py +++ b/sentry_sdk/ai/monitoring.py @@ -33,7 +33,7 @@ def sync_wrapped(*args, **kwargs): curr_pipeline = _ai_pipeline_name.get() op = span_kwargs.get("op", "ai.run" if curr_pipeline else "ai.pipeline") - with start_span(description=description, op=op, **span_kwargs) as span: + with start_span(name=description, op=op, **span_kwargs) as span: for k, v in kwargs.pop("sentry_tags", {}).items(): span.set_tag(k, v) for k, v in kwargs.pop("sentry_data", {}).items(): @@ -62,7 +62,7 @@ async def async_wrapped(*args, **kwargs): curr_pipeline = _ai_pipeline_name.get() op = span_kwargs.get("op", "ai.run" if curr_pipeline else "ai.pipeline") - with start_span(description=description, op=op, **span_kwargs) as span: + with start_span(name=description, op=op, **span_kwargs) as span: for k, v in kwargs.pop("sentry_tags", {}).items(): span.set_tag(k, v) for k, v in kwargs.pop("sentry_data", {}).items(): diff --git a/sentry_sdk/client.py b/sentry_sdk/client.py index f8bc76771b..0dd216ab21 100644 --- a/sentry_sdk/client.py +++ b/sentry_sdk/client.py @@ -5,7 +5,7 @@ from collections.abc import Mapping from datetime import datetime, timezone from importlib import import_module -from typing import cast +from typing import cast, overload from sentry_sdk._compat import PY37, check_uwsgi_thread_support from sentry_sdk.utils import ( @@ -54,6 +54,7 @@ from typing import Sequence from typing import Type from typing import Union + from typing import TypeVar from sentry_sdk._types import Event, Hint, SDKInfo from sentry_sdk.integrations import Integration @@ -62,6 +63,7 @@ from sentry_sdk.session import Session from sentry_sdk.transport import Transport + I = TypeVar("I", bound=Integration) # noqa: E741 _client_init_debug = ContextVar("client_init_debug") @@ -195,8 +197,20 @@ def capture_session(self, *args, **kwargs): # type: (*Any, **Any) -> None return None - def get_integration(self, *args, **kwargs): - # type: (*Any, **Any) -> Any + if TYPE_CHECKING: + + @overload + def get_integration(self, name_or_class): + # type: (str) -> Optional[Integration] + ... + + @overload + def get_integration(self, name_or_class): + # type: (type[I]) -> Optional[I] + ... + + def get_integration(self, name_or_class): + # type: (Union[str, type[Integration]]) -> Optional[Integration] return None def close(self, *args, **kwargs): @@ -815,10 +829,22 @@ def capture_session( else: self.session_flusher.add_session(session) + if TYPE_CHECKING: + + @overload + def get_integration(self, name_or_class): + # type: (str) -> Optional[Integration] + ... + + @overload + def get_integration(self, name_or_class): + # type: (type[I]) -> Optional[I] + ... + def get_integration( self, name_or_class # type: Union[str, Type[Integration]] ): - # type: (...) -> Any + # type: (...) -> Optional[Integration] """Returns the integration for this client by name or class. If the client does not have that integration then `None` is returned. """ diff --git a/sentry_sdk/consts.py b/sentry_sdk/consts.py index 5f79031787..b0be144659 100644 --- a/sentry_sdk/consts.py +++ b/sentry_sdk/consts.py @@ -53,7 +53,6 @@ class EndpointType(Enum): Experiments = TypedDict( "Experiments", { - "attach_explain_plans": dict[str, Any], "max_spans": Optional[int], "record_sql_params": Optional[bool], "continuous_profiling_auto_start": Optional[bool], @@ -567,4 +566,4 @@ def _get_default_options(): del _get_default_options -VERSION = "2.14.0" +VERSION = "2.15.0" diff --git a/sentry_sdk/db/__init__.py b/sentry_sdk/db/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/sentry_sdk/db/explain_plan/__init__.py b/sentry_sdk/db/explain_plan/__init__.py deleted file mode 100644 index 1cc475f0f4..0000000000 --- a/sentry_sdk/db/explain_plan/__init__.py +++ /dev/null @@ -1,59 +0,0 @@ -from datetime import datetime, timedelta, timezone -from typing import TYPE_CHECKING - -if TYPE_CHECKING: - from typing import Any - - -EXPLAIN_CACHE = {} -EXPLAIN_CACHE_SIZE = 50 -EXPLAIN_CACHE_TIMEOUT_SECONDS = 60 * 60 * 24 - - -def cache_statement(statement, options): - # type: (str, dict[str, Any]) -> None - global EXPLAIN_CACHE - - now = datetime.now(timezone.utc) - explain_cache_timeout_seconds = options.get( - "explain_cache_timeout_seconds", EXPLAIN_CACHE_TIMEOUT_SECONDS - ) - expiration_time = now + timedelta(seconds=explain_cache_timeout_seconds) - - EXPLAIN_CACHE[hash(statement)] = expiration_time - - -def remove_expired_cache_items(): - # type: () -> None - """ - Remove expired cache items from the cache. - """ - global EXPLAIN_CACHE - - now = datetime.now(timezone.utc) - - for key, expiration_time in EXPLAIN_CACHE.items(): - expiration_in_the_past = expiration_time < now - if expiration_in_the_past: - del EXPLAIN_CACHE[key] - - -def should_run_explain_plan(statement, options): - # type: (str, dict[str, Any]) -> bool - """ - Check cache if the explain plan for the given statement should be run. - """ - global EXPLAIN_CACHE - - remove_expired_cache_items() - - key = hash(statement) - if key in EXPLAIN_CACHE: - return False - - explain_cache_size = options.get("explain_cache_size", EXPLAIN_CACHE_SIZE) - cache_is_full = len(EXPLAIN_CACHE.keys()) >= explain_cache_size - if cache_is_full: - return False - - return True diff --git a/sentry_sdk/db/explain_plan/django.py b/sentry_sdk/db/explain_plan/django.py deleted file mode 100644 index 21ebc9c81a..0000000000 --- a/sentry_sdk/db/explain_plan/django.py +++ /dev/null @@ -1,48 +0,0 @@ -from typing import TYPE_CHECKING - -from sentry_sdk.db.explain_plan import cache_statement, should_run_explain_plan - -if TYPE_CHECKING: - from typing import Any - from typing import Callable - - from sentry_sdk.tracing import Span - - -def attach_explain_plan_to_span( - span, connection, statement, parameters, mogrify, options -): - # type: (Span, Any, str, Any, Callable[[str, Any], bytes], dict[str, Any]) -> None - """ - Run EXPLAIN or EXPLAIN ANALYZE on the given statement and attach the explain plan to the span data. - - Usage: - ``` - sentry_sdk.init( - dsn="...", - _experiments={ - "attach_explain_plans": { - "explain_cache_size": 1000, # Run explain plan for the 1000 most run queries - "explain_cache_timeout_seconds": 60 * 60 * 24, # Run the explain plan for each statement only every 24 hours - "use_explain_analyze": True, # Run "explain analyze" instead of only "explain" - } - } - ``` - """ - if not statement.strip().upper().startswith("SELECT"): - return - - if not should_run_explain_plan(statement, options): - return - - analyze = "ANALYZE" if options.get("use_explain_analyze", False) else "" - explain_statement = ("EXPLAIN %s " % analyze) + mogrify( - statement, parameters - ).decode("utf-8") - - with connection.cursor() as cursor: - cursor.execute(explain_statement) - explain_plan = [row for row in cursor.fetchall()] - - span.set_data("db.explain_plan", explain_plan) - cache_statement(statement, options) diff --git a/sentry_sdk/db/explain_plan/sqlalchemy.py b/sentry_sdk/db/explain_plan/sqlalchemy.py deleted file mode 100644 index 9320ff8fb3..0000000000 --- a/sentry_sdk/db/explain_plan/sqlalchemy.py +++ /dev/null @@ -1,48 +0,0 @@ -from typing import TYPE_CHECKING - -from sentry_sdk.db.explain_plan import cache_statement, should_run_explain_plan -from sentry_sdk.integrations import DidNotEnable - -try: - from sqlalchemy.sql import text # type: ignore -except ImportError: - raise DidNotEnable("SQLAlchemy not installed.") - -if TYPE_CHECKING: - from typing import Any - - from sentry_sdk.tracing import Span - - -def attach_explain_plan_to_span(span, connection, statement, parameters, options): - # type: (Span, Any, str, Any, dict[str, Any]) -> None - """ - Run EXPLAIN or EXPLAIN ANALYZE on the given statement and attach the explain plan to the span data. - - Usage: - ``` - sentry_sdk.init( - dsn="...", - _experiments={ - "attach_explain_plans": { - "explain_cache_size": 1000, # Run explain plan for the 1000 most run queries - "explain_cache_timeout_seconds": 60 * 60 * 24, # Run the explain plan for each statement only every 24 hours - "use_explain_analyze": True, # Run "explain analyze" instead of only "explain" - } - } - ``` - """ - if not statement.strip().upper().startswith("SELECT"): - return - - if not should_run_explain_plan(statement, options): - return - - analyze = "ANALYZE" if options.get("use_explain_analyze", False) else "" - explain_statement = (("EXPLAIN %s " % analyze) + statement) % parameters - - result = connection.execute(text(explain_statement)) - explain_plan = [row for row in result] - - span.set_data("db.explain_plan", explain_plan) - cache_statement(statement, options) diff --git a/sentry_sdk/integrations/__init__.py b/sentry_sdk/integrations/__init__.py index 35f809bde7..6c24ca1625 100644 --- a/sentry_sdk/integrations/__init__.py +++ b/sentry_sdk/integrations/__init__.py @@ -16,6 +16,9 @@ from typing import Type +_DEFAULT_FAILED_REQUEST_STATUS_CODES = frozenset(range(500, 600)) + + _installer_lock = Lock() # Set of all integration identifiers we have attempted to install diff --git a/sentry_sdk/integrations/_wsgi_common.py b/sentry_sdk/integrations/_wsgi_common.py index 14a4c4aea4..7266a91f56 100644 --- a/sentry_sdk/integrations/_wsgi_common.py +++ b/sentry_sdk/integrations/_wsgi_common.py @@ -1,3 +1,4 @@ +from contextlib import contextmanager import json from copy import deepcopy @@ -15,6 +16,7 @@ if TYPE_CHECKING: from typing import Any from typing import Dict + from typing import Iterator from typing import Mapping from typing import MutableMapping from typing import Optional @@ -37,6 +39,25 @@ x[len("HTTP_") :] for x in SENSITIVE_ENV_KEYS if x.startswith("HTTP_") ) +DEFAULT_HTTP_METHODS_TO_CAPTURE = ( + "CONNECT", + "DELETE", + "GET", + # "HEAD", # do not capture HEAD requests by default + # "OPTIONS", # do not capture OPTIONS requests by default + "PATCH", + "POST", + "PUT", + "TRACE", +) + + +# This noop context manager can be replaced with "from contextlib import nullcontext" when we drop Python 3.6 support +@contextmanager +def nullcontext(): + # type: () -> Iterator[None] + yield + def request_body_within_bounds(client, content_length): # type: (Optional[sentry_sdk.client.BaseClient], int) -> bool @@ -152,7 +173,13 @@ def json(self): if not self.is_json(): return None - raw_data = self.raw_data() + try: + raw_data = self.raw_data() + except (RawPostDataException, ValueError): + # The body might have already been read, in which case this will + # fail + raw_data = None + if raw_data is None: return None @@ -204,7 +231,7 @@ def _filter_headers(headers): def _in_http_status_code_range(code, code_ranges): - # type: (int, list[HttpStatusCodeRange]) -> bool + # type: (object, list[HttpStatusCodeRange]) -> bool for target in code_ranges: if isinstance(target, int): if code == target: @@ -220,3 +247,18 @@ def _in_http_status_code_range(code, code_ranges): ) return False + + +class HttpCodeRangeContainer: + """ + Wrapper to make it possible to use list[HttpStatusCodeRange] as a Container[int]. + Used for backwards compatibility with the old `failed_request_status_codes` option. + """ + + def __init__(self, code_ranges): + # type: (list[HttpStatusCodeRange]) -> None + self._code_ranges = code_ranges + + def __contains__(self, item): + # type: (object) -> bool + return _in_http_status_code_range(item, self._code_ranges) diff --git a/sentry_sdk/integrations/aiohttp.py b/sentry_sdk/integrations/aiohttp.py index 33f2fc095c..d0226bc156 100644 --- a/sentry_sdk/integrations/aiohttp.py +++ b/sentry_sdk/integrations/aiohttp.py @@ -1,10 +1,15 @@ import sys import weakref +from functools import wraps import sentry_sdk from sentry_sdk.api import continue_trace from sentry_sdk.consts import OP, SPANSTATUS, SPANDATA -from sentry_sdk.integrations import Integration, DidNotEnable +from sentry_sdk.integrations import ( + _DEFAULT_FAILED_REQUEST_STATUS_CODES, + Integration, + DidNotEnable, +) from sentry_sdk.integrations.logging import ignore_logger from sentry_sdk.sessions import track_session from sentry_sdk.integrations._wsgi_common import ( @@ -47,6 +52,8 @@ from aiohttp.web_request import Request from aiohttp.web_urldispatcher import UrlMappingMatchInfo from aiohttp import TraceRequestStartParams, TraceRequestEndParams + + from collections.abc import Set from types import SimpleNamespace from typing import Any from typing import Optional @@ -64,14 +71,20 @@ class AioHttpIntegration(Integration): identifier = "aiohttp" origin = f"auto.http.{identifier}" - def __init__(self, transaction_style="handler_name"): - # type: (str) -> None + def __init__( + self, + transaction_style="handler_name", # type: str + *, + failed_request_status_codes=_DEFAULT_FAILED_REQUEST_STATUS_CODES, # type: Set[int] + ): + # type: (...) -> None if transaction_style not in TRANSACTION_STYLE_VALUES: raise ValueError( "Invalid value for transaction_style: %s (must be in %s)" % (transaction_style, TRANSACTION_STYLE_VALUES) ) self.transaction_style = transaction_style + self._failed_request_status_codes = failed_request_status_codes @staticmethod def setup_once(): @@ -99,7 +112,8 @@ def setup_once(): async def sentry_app_handle(self, request, *args, **kwargs): # type: (Any, Request, *Any, **Any) -> Any - if sentry_sdk.get_client().get_integration(AioHttpIntegration) is None: + integration = sentry_sdk.get_client().get_integration(AioHttpIntegration) + if integration is None: return await old_handle(self, request, *args, **kwargs) weak_request = weakref.ref(request) @@ -130,6 +144,13 @@ async def sentry_app_handle(self, request, *args, **kwargs): response = await old_handle(self, request) except HTTPException as e: transaction.set_http_status(e.status_code) + + if ( + e.status_code + in integration._failed_request_status_codes + ): + _capture_exception() + raise except (asyncio.CancelledError, ConnectionResetError): transaction.set_status(SPANSTATUS.CANCELLED) @@ -139,18 +160,31 @@ async def sentry_app_handle(self, request, *args, **kwargs): # have no way to tell. Do not set span status. reraise(*_capture_exception()) - transaction.set_http_status(response.status) + try: + # A valid response handler will return a valid response with a status. But, if the handler + # returns an invalid response (e.g. None), the line below will raise an AttributeError. + # Even though this is likely invalid, we need to handle this case to ensure we don't break + # the application. + response_status = response.status + except AttributeError: + pass + else: + transaction.set_http_status(response_status) + return response Application._handle = sentry_app_handle old_urldispatcher_resolve = UrlDispatcher.resolve + @wraps(old_urldispatcher_resolve) async def sentry_urldispatcher_resolve(self, request): # type: (UrlDispatcher, Request) -> UrlMappingMatchInfo rv = await old_urldispatcher_resolve(self, request) integration = sentry_sdk.get_client().get_integration(AioHttpIntegration) + if integration is None: + return rv name = None @@ -205,7 +239,7 @@ async def on_request_start(session, trace_config_ctx, params): span = sentry_sdk.start_span( op=OP.HTTP_CLIENT, - description="%s %s" + name="%s %s" % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE), origin=AioHttpIntegration.origin, ) diff --git a/sentry_sdk/integrations/anthropic.py b/sentry_sdk/integrations/anthropic.py index 41d8e9d7d5..f3fd8d2d92 100644 --- a/sentry_sdk/integrations/anthropic.py +++ b/sentry_sdk/integrations/anthropic.py @@ -7,7 +7,6 @@ from sentry_sdk.scope import should_send_default_pii from sentry_sdk.utils import ( capture_internal_exceptions, - ensure_integration_enabled, event_from_exception, package_version, ) @@ -78,10 +77,11 @@ def _calculate_token_usage(result, span): def _wrap_message_create(f): # type: (Any) -> Any @wraps(f) - @ensure_integration_enabled(AnthropicIntegration, f) def _sentry_patched_create(*args, **kwargs): # type: (*Any, **Any) -> Any - if "messages" not in kwargs: + integration = sentry_sdk.get_client().get_integration(AnthropicIntegration) + + if integration is None or "messages" not in kwargs: return f(*args, **kwargs) try: @@ -94,7 +94,7 @@ def _sentry_patched_create(*args, **kwargs): span = sentry_sdk.start_span( op=OP.ANTHROPIC_MESSAGES_CREATE, - description="Anthropic messages create", + name="Anthropic messages create", origin=AnthropicIntegration.origin, ) span.__enter__() @@ -106,8 +106,6 @@ def _sentry_patched_create(*args, **kwargs): span.__exit__(None, None, None) raise exc from None - integration = sentry_sdk.get_client().get_integration(AnthropicIntegration) - with capture_internal_exceptions(): span.set_data(SPANDATA.AI_MODEL_ID, model) span.set_data(SPANDATA.AI_STREAMING, False) diff --git a/sentry_sdk/integrations/arq.py b/sentry_sdk/integrations/arq.py index 7a9f7a747d..4640204725 100644 --- a/sentry_sdk/integrations/arq.py +++ b/sentry_sdk/integrations/arq.py @@ -79,7 +79,7 @@ async def _sentry_enqueue_job(self, function, *args, **kwargs): return await old_enqueue_job(self, function, *args, **kwargs) with sentry_sdk.start_span( - op=OP.QUEUE_SUBMIT_ARQ, description=function, origin=ArqIntegration.origin + op=OP.QUEUE_SUBMIT_ARQ, name=function, origin=ArqIntegration.origin ): return await old_enqueue_job(self, function, *args, **kwargs) diff --git a/sentry_sdk/integrations/asgi.py b/sentry_sdk/integrations/asgi.py index 33fe18bd82..1b256c8eee 100644 --- a/sentry_sdk/integrations/asgi.py +++ b/sentry_sdk/integrations/asgi.py @@ -18,6 +18,10 @@ _get_request_data, _get_url, ) +from sentry_sdk.integrations._wsgi_common import ( + DEFAULT_HTTP_METHODS_TO_CAPTURE, + nullcontext, +) from sentry_sdk.sessions import track_session from sentry_sdk.tracing import ( SOURCE_FOR_STYLE, @@ -89,17 +93,19 @@ class SentryAsgiMiddleware: "transaction_style", "mechanism_type", "span_origin", + "http_methods_to_capture", ) def __init__( self, - app, - unsafe_context_data=False, - transaction_style="endpoint", - mechanism_type="asgi", - span_origin="manual", + app, # type: Any + unsafe_context_data=False, # type: bool + transaction_style="endpoint", # type: str + mechanism_type="asgi", # type: str + span_origin="manual", # type: str + http_methods_to_capture=DEFAULT_HTTP_METHODS_TO_CAPTURE, # type: Tuple[str, ...] ): - # type: (Any, bool, str, str, str) -> None + # type: (...) -> None """ Instrument an ASGI application with Sentry. Provides HTTP/websocket data to sent events and basic handling for exceptions bubbling up @@ -134,6 +140,7 @@ def __init__( self.mechanism_type = mechanism_type self.span_origin = span_origin self.app = app + self.http_methods_to_capture = http_methods_to_capture if _looks_like_asgi3(app): self.__call__ = self._run_asgi3 # type: Callable[..., Any] @@ -185,52 +192,59 @@ async def _run_app(self, scope, receive, send, asgi_version): scope, ) - if ty in ("http", "websocket"): - transaction = continue_trace( - _get_headers(scope), - op="{}.server".format(ty), - name=transaction_name, - source=transaction_source, - origin=self.span_origin, - ) - logger.debug( - "[ASGI] Created transaction (continuing trace): %s", - transaction, - ) - else: - transaction = Transaction( - op=OP.HTTP_SERVER, - name=transaction_name, - source=transaction_source, - origin=self.span_origin, - ) + method = scope.get("method", "").upper() + transaction = None + if method in self.http_methods_to_capture: + if ty in ("http", "websocket"): + transaction = continue_trace( + _get_headers(scope), + op="{}.server".format(ty), + name=transaction_name, + source=transaction_source, + origin=self.span_origin, + ) + logger.debug( + "[ASGI] Created transaction (continuing trace): %s", + transaction, + ) + else: + transaction = Transaction( + op=OP.HTTP_SERVER, + name=transaction_name, + source=transaction_source, + origin=self.span_origin, + ) + logger.debug( + "[ASGI] Created transaction (new): %s", transaction + ) + + transaction.set_tag("asgi.type", ty) logger.debug( - "[ASGI] Created transaction (new): %s", transaction + "[ASGI] Set transaction name and source on transaction: '%s' / '%s'", + transaction.name, + transaction.source, ) - transaction.set_tag("asgi.type", ty) - logger.debug( - "[ASGI] Set transaction name and source on transaction: '%s' / '%s'", - transaction.name, - transaction.source, - ) - - with sentry_sdk.start_transaction( - transaction, - custom_sampling_context={"asgi_scope": scope}, + with ( + sentry_sdk.start_transaction( + transaction, + custom_sampling_context={"asgi_scope": scope}, + ) + if transaction is not None + else nullcontext() ): logger.debug("[ASGI] Started transaction: %s", transaction) try: async def _sentry_wrapped_send(event): # type: (Dict[str, Any]) -> Any - is_http_response = ( - event.get("type") == "http.response.start" - and transaction is not None - and "status" in event - ) - if is_http_response: - transaction.set_http_status(event["status"]) + if transaction is not None: + is_http_response = ( + event.get("type") == "http.response.start" + and "status" in event + ) + if is_http_response: + transaction.set_http_status(event["status"]) return await send(event) diff --git a/sentry_sdk/integrations/asyncio.py b/sentry_sdk/integrations/asyncio.py index 313a306164..7021d7fceb 100644 --- a/sentry_sdk/integrations/asyncio.py +++ b/sentry_sdk/integrations/asyncio.py @@ -46,7 +46,7 @@ async def _coro_creating_hub_and_span(): with sentry_sdk.isolation_scope(): with sentry_sdk.start_span( op=OP.FUNCTION, - description=get_name(coro), + name=get_name(coro), origin=AsyncioIntegration.origin, ): try: diff --git a/sentry_sdk/integrations/asyncpg.py b/sentry_sdk/integrations/asyncpg.py index 4c1611613b..b05d5615ba 100644 --- a/sentry_sdk/integrations/asyncpg.py +++ b/sentry_sdk/integrations/asyncpg.py @@ -165,7 +165,7 @@ async def _inner(*args: Any, **kwargs: Any) -> T: with sentry_sdk.start_span( op=OP.DB, - description="connect", + name="connect", origin=AsyncPGIntegration.origin, ) as span: span.set_data(SPANDATA.DB_SYSTEM, "postgresql") diff --git a/sentry_sdk/integrations/atexit.py b/sentry_sdk/integrations/atexit.py index 43e25c1848..dfc6d08e1a 100644 --- a/sentry_sdk/integrations/atexit.py +++ b/sentry_sdk/integrations/atexit.py @@ -5,8 +5,6 @@ import sentry_sdk from sentry_sdk.utils import logger from sentry_sdk.integrations import Integration -from sentry_sdk.utils import ensure_integration_enabled - from typing import TYPE_CHECKING if TYPE_CHECKING: @@ -44,13 +42,16 @@ def __init__(self, callback=None): def setup_once(): # type: () -> None @atexit.register - @ensure_integration_enabled(AtexitIntegration) def _shutdown(): # type: () -> None - logger.debug("atexit: got shutdown signal") client = sentry_sdk.get_client() integration = client.get_integration(AtexitIntegration) + if integration is None: + return + + logger.debug("atexit: got shutdown signal") logger.debug("atexit: shutting down client") sentry_sdk.get_isolation_scope().end_session() + client.close(callback=integration.callback) diff --git a/sentry_sdk/integrations/aws_lambda.py b/sentry_sdk/integrations/aws_lambda.py index f0cdf31f8c..831cde8999 100644 --- a/sentry_sdk/integrations/aws_lambda.py +++ b/sentry_sdk/integrations/aws_lambda.py @@ -1,3 +1,4 @@ +import functools import json import re import sys @@ -70,7 +71,7 @@ def sentry_init_error(*args, **kwargs): def _wrap_handler(handler): # type: (F) -> F - @ensure_integration_enabled(AwsLambdaIntegration, handler) + @functools.wraps(handler) def sentry_handler(aws_event, aws_context, *args, **kwargs): # type: (Any, Any, *Any, **Any) -> Any @@ -84,6 +85,12 @@ def sentry_handler(aws_event, aws_context, *args, **kwargs): # will be the same for all events in the list, since they're all hitting # the lambda in the same request.) + client = sentry_sdk.get_client() + integration = client.get_integration(AwsLambdaIntegration) + + if integration is None: + return handler(aws_event, aws_context, *args, **kwargs) + if isinstance(aws_event, list) and len(aws_event) >= 1: request_data = aws_event[0] batch_size = len(aws_event) @@ -97,9 +104,6 @@ def sentry_handler(aws_event, aws_context, *args, **kwargs): # this is empty request_data = {} - client = sentry_sdk.get_client() - integration = client.get_integration(AwsLambdaIntegration) - configured_time = aws_context.get_remaining_time_in_millis() with sentry_sdk.isolation_scope() as scope: diff --git a/sentry_sdk/integrations/boto3.py b/sentry_sdk/integrations/boto3.py index 8a59b9b797..c8da56fb14 100644 --- a/sentry_sdk/integrations/boto3.py +++ b/sentry_sdk/integrations/boto3.py @@ -69,7 +69,7 @@ def _sentry_request_created(service_id, request, operation_name, **kwargs): description = "aws.%s.%s" % (service_id, operation_name) span = sentry_sdk.start_span( op=OP.HTTP_CLIENT, - description=description, + name=description, origin=Boto3Integration.origin, ) @@ -107,7 +107,7 @@ def _sentry_after_call(context, parsed, **kwargs): streaming_span = span.start_child( op=OP.HTTP_CLIENT_STREAM, - description=span.description, + name=span.description, origin=Boto3Integration.origin, ) diff --git a/sentry_sdk/integrations/bottle.py b/sentry_sdk/integrations/bottle.py index b1800bd191..dc573eb958 100644 --- a/sentry_sdk/integrations/bottle.py +++ b/sentry_sdk/integrations/bottle.py @@ -1,3 +1,5 @@ +import functools + import sentry_sdk from sentry_sdk.tracing import SOURCE_FOR_STYLE from sentry_sdk.utils import ( @@ -81,10 +83,12 @@ def sentry_patched_wsgi_app(self, environ, start_response): old_handle = Bottle._handle - @ensure_integration_enabled(BottleIntegration, old_handle) + @functools.wraps(old_handle) def _patched_handle(self, environ): # type: (Bottle, Dict[str, Any]) -> Any integration = sentry_sdk.get_client().get_integration(BottleIntegration) + if integration is None: + return old_handle(self, environ) scope = sentry_sdk.get_isolation_scope() scope._name = "bottle" diff --git a/sentry_sdk/integrations/celery/__init__.py b/sentry_sdk/integrations/celery/__init__.py index 88a2119c09..9a984de8c3 100644 --- a/sentry_sdk/integrations/celery/__init__.py +++ b/sentry_sdk/integrations/celery/__init__.py @@ -248,13 +248,15 @@ def __exit__(self, exc_type, exc_value, traceback): def _wrap_task_run(f): # type: (F) -> F @wraps(f) - @ensure_integration_enabled(CeleryIntegration, f) def apply_async(*args, **kwargs): # type: (*Any, **Any) -> Any # Note: kwargs can contain headers=None, so no setdefault! # Unsure which backend though. - kwarg_headers = kwargs.get("headers") or {} integration = sentry_sdk.get_client().get_integration(CeleryIntegration) + if integration is None: + return f(*args, **kwargs) + + kwarg_headers = kwargs.get("headers") or {} propagate_traces = kwarg_headers.pop( "sentry-propagate-traces", integration.propagate_traces ) @@ -274,7 +276,7 @@ def apply_async(*args, **kwargs): span_mgr = ( sentry_sdk.start_span( op=OP.QUEUE_SUBMIT_CELERY, - description=task_name, + name=task_name, origin=CeleryIntegration.origin, ) if not task_started_from_beat @@ -374,7 +376,7 @@ def _inner(*args, **kwargs): try: with sentry_sdk.start_span( op=OP.QUEUE_PROCESS, - description=task.name, + name=task.name, origin=CeleryIntegration.origin, ) as span: _set_messaging_destination_name(task, span) @@ -503,7 +505,7 @@ def sentry_publish(self, *args, **kwargs): with sentry_sdk.start_span( op=OP.QUEUE_PUBLISH, - description=task_name, + name=task_name, origin=CeleryIntegration.origin, ) as span: if task_id is not None: diff --git a/sentry_sdk/integrations/clickhouse_driver.py b/sentry_sdk/integrations/clickhouse_driver.py index 02707fb7c5..daf4c2257c 100644 --- a/sentry_sdk/integrations/clickhouse_driver.py +++ b/sentry_sdk/integrations/clickhouse_driver.py @@ -83,7 +83,7 @@ def _inner(*args: P.args, **kwargs: P.kwargs) -> T: span = sentry_sdk.start_span( op=OP.DB, - description=query, + name=query, origin=ClickhouseDriverIntegration.origin, ) diff --git a/sentry_sdk/integrations/cohere.py b/sentry_sdk/integrations/cohere.py index 1d4e86a71b..b4c2af91da 100644 --- a/sentry_sdk/integrations/cohere.py +++ b/sentry_sdk/integrations/cohere.py @@ -14,11 +14,7 @@ import sentry_sdk from sentry_sdk.scope import should_send_default_pii from sentry_sdk.integrations import DidNotEnable, Integration -from sentry_sdk.utils import ( - capture_internal_exceptions, - event_from_exception, - ensure_integration_enabled, -) +from sentry_sdk.utils import capture_internal_exceptions, event_from_exception try: from cohere.client import Client @@ -26,7 +22,6 @@ from cohere import ( ChatStreamEndEvent, NonStreamedChatResponse, - StreamedChatResponse_StreamEnd, ) if TYPE_CHECKING: @@ -34,6 +29,12 @@ except ImportError: raise DidNotEnable("Cohere not installed") +try: + # cohere 5.9.3+ + from cohere import StreamEndStreamedChatResponse +except ImportError: + from cohere import StreamedChatResponse_StreamEnd as StreamEndStreamedChatResponse + COLLECTED_CHAT_PARAMS = { "model": SPANDATA.AI_MODEL_ID, @@ -129,20 +130,22 @@ def collect_chat_response_fields(span, res, include_pii): set_data_normalized(span, "ai.warnings", res.meta.warnings) @wraps(f) - @ensure_integration_enabled(CohereIntegration, f) def new_chat(*args, **kwargs): # type: (*Any, **Any) -> Any - if "message" not in kwargs: - return f(*args, **kwargs) + integration = sentry_sdk.get_client().get_integration(CohereIntegration) - if not isinstance(kwargs.get("message"), str): + if ( + integration is None + or "message" not in kwargs + or not isinstance(kwargs.get("message"), str) + ): return f(*args, **kwargs) message = kwargs.get("message") span = sentry_sdk.start_span( op=consts.OP.COHERE_CHAT_COMPLETIONS_CREATE, - description="cohere.client.Chat", + name="cohere.client.Chat", origin=CohereIntegration.origin, ) span.__enter__() @@ -153,8 +156,6 @@ def new_chat(*args, **kwargs): span.__exit__(None, None, None) raise e from None - integration = sentry_sdk.get_client().get_integration(CohereIntegration) - with capture_internal_exceptions(): if should_send_default_pii() and integration.include_prompts: set_data_normalized( @@ -189,7 +190,7 @@ def new_iterator(): with capture_internal_exceptions(): for x in old_iterator: if isinstance(x, ChatStreamEndEvent) or isinstance( - x, StreamedChatResponse_StreamEnd + x, StreamEndStreamedChatResponse ): collect_chat_response_fields( span, @@ -222,15 +223,17 @@ def _wrap_embed(f): # type: (Callable[..., Any]) -> Callable[..., Any] @wraps(f) - @ensure_integration_enabled(CohereIntegration, f) def new_embed(*args, **kwargs): # type: (*Any, **Any) -> Any + integration = sentry_sdk.get_client().get_integration(CohereIntegration) + if integration is None: + return f(*args, **kwargs) + with sentry_sdk.start_span( op=consts.OP.COHERE_EMBEDDINGS_CREATE, - description="Cohere Embedding Creation", + name="Cohere Embedding Creation", origin=CohereIntegration.origin, ) as span: - integration = sentry_sdk.get_client().get_integration(CohereIntegration) if "texts" in kwargs and ( should_send_default_pii() and integration.include_prompts ): diff --git a/sentry_sdk/integrations/django/__init__.py b/sentry_sdk/integrations/django/__init__.py index 8fce1d138e..c9f20dd49b 100644 --- a/sentry_sdk/integrations/django/__init__.py +++ b/sentry_sdk/integrations/django/__init__.py @@ -6,7 +6,6 @@ import sentry_sdk from sentry_sdk.consts import OP, SPANDATA -from sentry_sdk.db.explain_plan.django import attach_explain_plan_to_span from sentry_sdk.scope import add_global_event_processor, should_send_default_pii from sentry_sdk.serializer import add_global_repr_processor from sentry_sdk.tracing import SOURCE_FOR_STYLE, TRANSACTION_SOURCE_URL @@ -26,7 +25,10 @@ from sentry_sdk.integrations import Integration, DidNotEnable from sentry_sdk.integrations.logging import ignore_logger from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware -from sentry_sdk.integrations._wsgi_common import RequestExtractor +from sentry_sdk.integrations._wsgi_common import ( + DEFAULT_HTTP_METHODS_TO_CAPTURE, + RequestExtractor, +) try: from django import VERSION as DJANGO_VERSION @@ -126,13 +128,14 @@ class DjangoIntegration(Integration): def __init__( self, - transaction_style="url", - middleware_spans=True, - signals_spans=True, - cache_spans=False, - signals_denylist=None, + transaction_style="url", # type: str + middleware_spans=True, # type: bool + signals_spans=True, # type: bool + cache_spans=False, # type: bool + signals_denylist=None, # type: Optional[list[signals.Signal]] + http_methods_to_capture=DEFAULT_HTTP_METHODS_TO_CAPTURE, # type: tuple[str, ...] ): - # type: (str, bool, bool, bool, Optional[list[signals.Signal]]) -> None + # type: (...) -> None if transaction_style not in TRANSACTION_STYLE_VALUES: raise ValueError( "Invalid value for transaction_style: %s (must be in %s)" @@ -146,6 +149,8 @@ def __init__( self.cache_spans = cache_spans + self.http_methods_to_capture = tuple(map(str.upper, http_methods_to_capture)) + @staticmethod def setup_once(): # type: () -> None @@ -173,10 +178,17 @@ def sentry_patched_wsgi_handler(self, environ, start_response): use_x_forwarded_for = settings.USE_X_FORWARDED_HOST + integration = sentry_sdk.get_client().get_integration(DjangoIntegration) + middleware = SentryWsgiMiddleware( bound_old_app, use_x_forwarded_for, span_origin=DjangoIntegration.origin, + http_methods_to_capture=( + integration.http_methods_to_capture + if integration + else DEFAULT_HTTP_METHODS_TO_CAPTURE + ), ) return middleware(environ, start_response) @@ -412,10 +424,11 @@ def _set_transaction_name_and_source(scope, transaction_style, request): pass -@ensure_integration_enabled(DjangoIntegration) def _before_get_response(request): # type: (WSGIRequest) -> None integration = sentry_sdk.get_client().get_integration(DjangoIntegration) + if integration is None: + return _patch_drf() @@ -441,11 +454,10 @@ def _attempt_resolve_again(request, scope, transaction_style): _set_transaction_name_and_source(scope, transaction_style, request) -@ensure_integration_enabled(DjangoIntegration) def _after_get_response(request): # type: (WSGIRequest) -> None integration = sentry_sdk.get_client().get_integration(DjangoIntegration) - if integration.transaction_style != "url": + if integration is None or integration.transaction_style != "url": return scope = sentry_sdk.get_current_scope() @@ -492,13 +504,6 @@ def wsgi_request_event_processor(event, hint): # We have a `asgi_request_event_processor` for this. return event - try: - drf_request = request._sentry_drf_request_backref() - if drf_request is not None: - request = drf_request - except AttributeError: - pass - with capture_internal_exceptions(): DjangoRequestExtractor(request).extract_into_event(event) @@ -511,11 +516,12 @@ def wsgi_request_event_processor(event, hint): return wsgi_request_event_processor -@ensure_integration_enabled(DjangoIntegration) def _got_request_exception(request=None, **kwargs): # type: (WSGIRequest, **Any) -> None client = sentry_sdk.get_client() integration = client.get_integration(DjangoIntegration) + if integration is None: + return if request is not None and integration.transaction_style == "url": scope = sentry_sdk.get_current_scope() @@ -530,6 +536,16 @@ def _got_request_exception(request=None, **kwargs): class DjangoRequestExtractor(RequestExtractor): + def __init__(self, request): + # type: (Union[WSGIRequest, ASGIRequest]) -> None + try: + drf_request = request._sentry_drf_request_backref() + if drf_request is not None: + request = drf_request + except AttributeError: + pass + self.request = request + def env(self): # type: () -> Dict[str, str] return self.request.META @@ -634,20 +650,6 @@ def execute(self, sql, params=None): span_origin=DjangoIntegration.origin_db, ) as span: _set_db_data(span, self) - options = ( - sentry_sdk.get_client() - .options["_experiments"] - .get("attach_explain_plans") - ) - if options is not None: - attach_explain_plan_to_span( - span, - self.cursor.connection, - sql, - params, - self.mogrify, - options, - ) result = real_execute(self, sql, params) with capture_internal_exceptions(): @@ -683,7 +685,7 @@ def connect(self): with sentry_sdk.start_span( op=OP.DB, - description="connect", + name="connect", origin=DjangoIntegration.origin_db, ) as span: _set_db_data(span, self) diff --git a/sentry_sdk/integrations/django/asgi.py b/sentry_sdk/integrations/django/asgi.py index aa2f3e8c6d..bcc83b8e59 100644 --- a/sentry_sdk/integrations/django/asgi.py +++ b/sentry_sdk/integrations/django/asgi.py @@ -174,7 +174,7 @@ async def sentry_wrapped_callback(request, *args, **kwargs): with sentry_sdk.start_span( op=OP.VIEW_RENDER, - description=request.resolver_match.view_name, + name=request.resolver_match.view_name, origin=DjangoIntegration.origin, ): return await callback(request, *args, **kwargs) diff --git a/sentry_sdk/integrations/django/caching.py b/sentry_sdk/integrations/django/caching.py index 25b04f4820..4bd7cb7236 100644 --- a/sentry_sdk/integrations/django/caching.py +++ b/sentry_sdk/integrations/django/caching.py @@ -52,7 +52,7 @@ def _instrument_call( with sentry_sdk.start_span( op=op, - description=description, + name=description, origin=DjangoIntegration.origin, ) as span: value = original_method(*args, **kwargs) diff --git a/sentry_sdk/integrations/django/middleware.py b/sentry_sdk/integrations/django/middleware.py index 981d192864..245276566e 100644 --- a/sentry_sdk/integrations/django/middleware.py +++ b/sentry_sdk/integrations/django/middleware.py @@ -87,7 +87,7 @@ def _check_middleware_span(old_method): middleware_span = sentry_sdk.start_span( op=OP.MIDDLEWARE_DJANGO, - description=description, + name=description, origin=DjangoIntegration.origin, ) middleware_span.set_tag("django.function_name", function_name) @@ -125,6 +125,7 @@ def sentry_wrapped_method(*args, **kwargs): class SentryWrappingMiddleware( _asgi_middleware_mixin_factory(_check_middleware_span) # type: ignore ): + sync_capable = getattr(middleware, "sync_capable", True) async_capable = DJANGO_SUPPORTS_ASYNC_MIDDLEWARE and getattr( middleware, "async_capable", False ) diff --git a/sentry_sdk/integrations/django/signals_handlers.py b/sentry_sdk/integrations/django/signals_handlers.py index dd0eabe4a7..cb0f8b9d2e 100644 --- a/sentry_sdk/integrations/django/signals_handlers.py +++ b/sentry_sdk/integrations/django/signals_handlers.py @@ -66,7 +66,7 @@ def wrapper(*args, **kwargs): signal_name = _get_receiver_name(receiver) with sentry_sdk.start_span( op=OP.EVENT_DJANGO, - description=signal_name, + name=signal_name, origin=DjangoIntegration.origin, ) as span: span.set_data("signal", signal_name) diff --git a/sentry_sdk/integrations/django/templates.py b/sentry_sdk/integrations/django/templates.py index 6edcdebf73..10e8a924b7 100644 --- a/sentry_sdk/integrations/django/templates.py +++ b/sentry_sdk/integrations/django/templates.py @@ -70,7 +70,7 @@ def rendered_content(self): # type: (SimpleTemplateResponse) -> str with sentry_sdk.start_span( op=OP.TEMPLATE_RENDER, - description=_get_template_name_description(self.template_name), + name=_get_template_name_description(self.template_name), origin=DjangoIntegration.origin, ) as span: span.set_data("context", self.context_data) @@ -98,7 +98,7 @@ def render(request, template_name, context=None, *args, **kwargs): with sentry_sdk.start_span( op=OP.TEMPLATE_RENDER, - description=_get_template_name_description(template_name), + name=_get_template_name_description(template_name), origin=DjangoIntegration.origin, ) as span: span.set_data("context", context) diff --git a/sentry_sdk/integrations/django/views.py b/sentry_sdk/integrations/django/views.py index a81ddd601f..cb81d3555c 100644 --- a/sentry_sdk/integrations/django/views.py +++ b/sentry_sdk/integrations/django/views.py @@ -35,7 +35,7 @@ def sentry_patched_render(self): # type: (SimpleTemplateResponse) -> Any with sentry_sdk.start_span( op=OP.VIEW_RESPONSE_RENDER, - description="serialize response", + name="serialize response", origin=DjangoIntegration.origin, ): return old_render(self) @@ -84,7 +84,7 @@ def sentry_wrapped_callback(request, *args, **kwargs): with sentry_sdk.start_span( op=OP.VIEW_RENDER, - description=request.resolver_match.view_name, + name=request.resolver_match.view_name, origin=DjangoIntegration.origin, ): return callback(request, *args, **kwargs) diff --git a/sentry_sdk/integrations/fastapi.py b/sentry_sdk/integrations/fastapi.py index 6233a746cc..c3816b6565 100644 --- a/sentry_sdk/integrations/fastapi.py +++ b/sentry_sdk/integrations/fastapi.py @@ -99,10 +99,10 @@ def _sentry_call(*args, **kwargs): async def _sentry_app(*args, **kwargs): # type: (*Any, **Any) -> Any - if sentry_sdk.get_client().get_integration(FastApiIntegration) is None: + integration = sentry_sdk.get_client().get_integration(FastApiIntegration) + if integration is None: return await old_app(*args, **kwargs) - integration = sentry_sdk.get_client().get_integration(FastApiIntegration) request = args[0] _set_transaction_name_and_source( diff --git a/sentry_sdk/integrations/flask.py b/sentry_sdk/integrations/flask.py index 7b0fcf3187..128301ddb4 100644 --- a/sentry_sdk/integrations/flask.py +++ b/sentry_sdk/integrations/flask.py @@ -1,6 +1,9 @@ import sentry_sdk from sentry_sdk.integrations import DidNotEnable, Integration -from sentry_sdk.integrations._wsgi_common import RequestExtractor +from sentry_sdk.integrations._wsgi_common import ( + DEFAULT_HTTP_METHODS_TO_CAPTURE, + RequestExtractor, +) from sentry_sdk.integrations.wsgi import SentryWsgiMiddleware from sentry_sdk.scope import should_send_default_pii from sentry_sdk.tracing import SOURCE_FOR_STYLE @@ -52,14 +55,19 @@ class FlaskIntegration(Integration): transaction_style = "" - def __init__(self, transaction_style="endpoint"): - # type: (str) -> None + def __init__( + self, + transaction_style="endpoint", # type: str + http_methods_to_capture=DEFAULT_HTTP_METHODS_TO_CAPTURE, # type: tuple[str, ...] + ): + # type: (...) -> None if transaction_style not in TRANSACTION_STYLE_VALUES: raise ValueError( "Invalid value for transaction_style: %s (must be in %s)" % (transaction_style, TRANSACTION_STYLE_VALUES) ) self.transaction_style = transaction_style + self.http_methods_to_capture = tuple(map(str.upper, http_methods_to_capture)) @staticmethod def setup_once(): @@ -83,9 +91,16 @@ def sentry_patched_wsgi_app(self, environ, start_response): if sentry_sdk.get_client().get_integration(FlaskIntegration) is None: return old_app(self, environ, start_response) + integration = sentry_sdk.get_client().get_integration(FlaskIntegration) + middleware = SentryWsgiMiddleware( lambda *a, **kw: old_app(self, *a, **kw), span_origin=FlaskIntegration.origin, + http_methods_to_capture=( + integration.http_methods_to_capture + if integration + else DEFAULT_HTTP_METHODS_TO_CAPTURE + ), ) return middleware(environ, start_response) @@ -118,10 +133,12 @@ def _set_transaction_name_and_source(scope, transaction_style, request): pass -@ensure_integration_enabled(FlaskIntegration) def _request_started(app, **kwargs): # type: (Flask, **Any) -> None integration = sentry_sdk.get_client().get_integration(FlaskIntegration) + if integration is None: + return + request = flask_request._get_current_object() # Set the transaction name and source here, diff --git a/sentry_sdk/integrations/gcp.py b/sentry_sdk/integrations/gcp.py index 688d0de4d4..3983f550d3 100644 --- a/sentry_sdk/integrations/gcp.py +++ b/sentry_sdk/integrations/gcp.py @@ -1,3 +1,4 @@ +import functools import sys from copy import deepcopy from datetime import datetime, timedelta, timezone @@ -13,7 +14,6 @@ from sentry_sdk.utils import ( AnnotatedValue, capture_internal_exceptions, - ensure_integration_enabled, event_from_exception, logger, TimeoutThread, @@ -39,12 +39,14 @@ def _wrap_func(func): # type: (F) -> F - @ensure_integration_enabled(GcpIntegration, func) + @functools.wraps(func) def sentry_func(functionhandler, gcp_event, *args, **kwargs): # type: (Any, Any, *Any, **Any) -> Any client = sentry_sdk.get_client() integration = client.get_integration(GcpIntegration) + if integration is None: + return func(functionhandler, gcp_event, *args, **kwargs) configured_time = environ.get("FUNCTION_TIMEOUT_SEC") if not configured_time: diff --git a/sentry_sdk/integrations/graphene.py b/sentry_sdk/integrations/graphene.py index 1b33bf76bf..03731dcaaa 100644 --- a/sentry_sdk/integrations/graphene.py +++ b/sentry_sdk/integrations/graphene.py @@ -142,9 +142,9 @@ def graphql_span(schema, source, kwargs): scope = sentry_sdk.get_current_scope() if scope.span: - _graphql_span = scope.span.start_child(op=op, description=operation_name) + _graphql_span = scope.span.start_child(op=op, name=operation_name) else: - _graphql_span = sentry_sdk.start_span(op=op, description=operation_name) + _graphql_span = sentry_sdk.start_span(op=op, name=operation_name) _graphql_span.set_data("graphql.document", source) _graphql_span.set_data("graphql.operation.name", operation_name) diff --git a/sentry_sdk/integrations/grpc/aio/client.py b/sentry_sdk/integrations/grpc/aio/client.py index 143f0e43a9..e8adeba05e 100644 --- a/sentry_sdk/integrations/grpc/aio/client.py +++ b/sentry_sdk/integrations/grpc/aio/client.py @@ -50,7 +50,7 @@ async def intercept_unary_unary( with sentry_sdk.start_span( op=OP.GRPC_CLIENT, - description="unary unary call to %s" % method.decode(), + name="unary unary call to %s" % method.decode(), origin=SPAN_ORIGIN, ) as span: span.set_data("type", "unary unary") @@ -80,7 +80,7 @@ async def intercept_unary_stream( with sentry_sdk.start_span( op=OP.GRPC_CLIENT, - description="unary stream call to %s" % method.decode(), + name="unary stream call to %s" % method.decode(), origin=SPAN_ORIGIN, ) as span: span.set_data("type", "unary stream") diff --git a/sentry_sdk/integrations/grpc/client.py b/sentry_sdk/integrations/grpc/client.py index 2155824eaf..a5b4f9f52e 100644 --- a/sentry_sdk/integrations/grpc/client.py +++ b/sentry_sdk/integrations/grpc/client.py @@ -29,7 +29,7 @@ def intercept_unary_unary(self, continuation, client_call_details, request): with sentry_sdk.start_span( op=OP.GRPC_CLIENT, - description="unary unary call to %s" % method, + name="unary unary call to %s" % method, origin=SPAN_ORIGIN, ) as span: span.set_data("type", "unary unary") @@ -50,7 +50,7 @@ def intercept_unary_stream(self, continuation, client_call_details, request): with sentry_sdk.start_span( op=OP.GRPC_CLIENT, - description="unary stream call to %s" % method, + name="unary stream call to %s" % method, origin=SPAN_ORIGIN, ) as span: span.set_data("type", "unary stream") diff --git a/sentry_sdk/integrations/httpx.py b/sentry_sdk/integrations/httpx.py index 3ab47bce70..6f80b93f4d 100644 --- a/sentry_sdk/integrations/httpx.py +++ b/sentry_sdk/integrations/httpx.py @@ -53,7 +53,7 @@ def send(self, request, **kwargs): with sentry_sdk.start_span( op=OP.HTTP_CLIENT, - description="%s %s" + name="%s %s" % ( request.method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE, @@ -109,7 +109,7 @@ async def send(self, request, **kwargs): with sentry_sdk.start_span( op=OP.HTTP_CLIENT, - description="%s %s" + name="%s %s" % ( request.method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE, diff --git a/sentry_sdk/integrations/huey.py b/sentry_sdk/integrations/huey.py index 98fab46711..7db57680f6 100644 --- a/sentry_sdk/integrations/huey.py +++ b/sentry_sdk/integrations/huey.py @@ -59,7 +59,7 @@ def _sentry_enqueue(self, task): # type: (Huey, Task) -> Optional[Union[Result, ResultGroup]] with sentry_sdk.start_span( op=OP.QUEUE_SUBMIT_HUEY, - description=task.name, + name=task.name, origin=HueyIntegration.origin, ): if not isinstance(task, PeriodicTask): diff --git a/sentry_sdk/integrations/huggingface_hub.py b/sentry_sdk/integrations/huggingface_hub.py index c7ed6907dd..d09f6e2163 100644 --- a/sentry_sdk/integrations/huggingface_hub.py +++ b/sentry_sdk/integrations/huggingface_hub.py @@ -13,7 +13,6 @@ from sentry_sdk.utils import ( capture_internal_exceptions, event_from_exception, - ensure_integration_enabled, ) try: @@ -55,9 +54,12 @@ def _capture_exception(exc): def _wrap_text_generation(f): # type: (Callable[..., Any]) -> Callable[..., Any] @wraps(f) - @ensure_integration_enabled(HuggingfaceHubIntegration, f) def new_text_generation(*args, **kwargs): # type: (*Any, **Any) -> Any + integration = sentry_sdk.get_client().get_integration(HuggingfaceHubIntegration) + if integration is None: + return f(*args, **kwargs) + if "prompt" in kwargs: prompt = kwargs["prompt"] elif len(args) >= 2: @@ -73,7 +75,7 @@ def new_text_generation(*args, **kwargs): span = sentry_sdk.start_span( op=consts.OP.HUGGINGFACE_HUB_CHAT_COMPLETIONS_CREATE, - description="Text Generation", + name="Text Generation", origin=HuggingfaceHubIntegration.origin, ) span.__enter__() @@ -84,8 +86,6 @@ def new_text_generation(*args, **kwargs): span.__exit__(None, None, None) raise e from None - integration = sentry_sdk.get_client().get_integration(HuggingfaceHubIntegration) - with capture_internal_exceptions(): if should_send_default_pii() and integration.include_prompts: set_data_normalized(span, SPANDATA.AI_INPUT_MESSAGES, prompt) diff --git a/sentry_sdk/integrations/langchain.py b/sentry_sdk/integrations/langchain.py index a77dec430d..11cf82c000 100644 --- a/sentry_sdk/integrations/langchain.py +++ b/sentry_sdk/integrations/langchain.py @@ -146,8 +146,8 @@ def _create_span(self, run_id, parent_id, **kwargs): watched_span = WatchedSpan(sentry_sdk.start_span(**kwargs)) if kwargs.get("op", "").startswith("ai.pipeline."): - if kwargs.get("description"): - set_ai_pipeline_name(kwargs.get("description")) + if kwargs.get("name"): + set_ai_pipeline_name(kwargs.get("name")) watched_span.is_pipeline = True watched_span.span.__enter__() @@ -186,7 +186,7 @@ def on_llm_start( run_id, kwargs.get("parent_run_id"), op=OP.LANGCHAIN_RUN, - description=kwargs.get("name") or "Langchain LLM call", + name=kwargs.get("name") or "Langchain LLM call", origin=LangchainIntegration.origin, ) span = watched_span.span @@ -208,7 +208,7 @@ def on_chat_model_start(self, serialized, messages, *, run_id, **kwargs): run_id, kwargs.get("parent_run_id"), op=OP.LANGCHAIN_CHAT_COMPLETIONS_CREATE, - description=kwargs.get("name") or "Langchain Chat Model", + name=kwargs.get("name") or "Langchain Chat Model", origin=LangchainIntegration.origin, ) span = watched_span.span @@ -312,7 +312,7 @@ def on_chain_start(self, serialized, inputs, *, run_id, **kwargs): if kwargs.get("parent_run_id") is not None else OP.LANGCHAIN_PIPELINE ), - description=kwargs.get("name") or "Chain execution", + name=kwargs.get("name") or "Chain execution", origin=LangchainIntegration.origin, ) metadata = kwargs.get("metadata") @@ -345,7 +345,7 @@ def on_agent_action(self, action, *, run_id, **kwargs): run_id, kwargs.get("parent_run_id"), op=OP.LANGCHAIN_AGENT, - description=action.tool or "AI tool usage", + name=action.tool or "AI tool usage", origin=LangchainIntegration.origin, ) if action.tool_input and should_send_default_pii() and self.include_prompts: @@ -378,9 +378,7 @@ def on_tool_start(self, serialized, input_str, *, run_id, **kwargs): run_id, kwargs.get("parent_run_id"), op=OP.LANGCHAIN_TOOL, - description=serialized.get("name") - or kwargs.get("name") - or "AI tool usage", + name=serialized.get("name") or kwargs.get("name") or "AI tool usage", origin=LangchainIntegration.origin, ) if should_send_default_pii() and self.include_prompts: @@ -422,6 +420,8 @@ def new_configure(*args, **kwargs): # type: (Any, Any) -> Any integration = sentry_sdk.get_client().get_integration(LangchainIntegration) + if integration is None: + return f(*args, **kwargs) with capture_internal_exceptions(): new_callbacks = [] # type: List[BaseCallbackHandler] @@ -445,7 +445,7 @@ def new_configure(*args, **kwargs): elif isinstance(existing_callbacks, BaseCallbackHandler): new_callbacks.append(existing_callbacks) else: - logger.warn("Unknown callback type: %s", existing_callbacks) + logger.debug("Unknown callback type: %s", existing_callbacks) already_added = False for callback in new_callbacks: diff --git a/sentry_sdk/integrations/litestar.py b/sentry_sdk/integrations/litestar.py index bf4fdf49bf..4b04dada8a 100644 --- a/sentry_sdk/integrations/litestar.py +++ b/sentry_sdk/integrations/litestar.py @@ -139,7 +139,7 @@ async def _create_span_call(self, scope, receive, send): middleware_name = self.__class__.__name__ with sentry_sdk.start_span( op=OP.MIDDLEWARE_LITESTAR, - description=middleware_name, + name=middleware_name, origin=LitestarIntegration.origin, ) as middleware_span: middleware_span.set_tag("litestar.middleware_name", middleware_name) @@ -151,7 +151,7 @@ async def _sentry_receive(*args, **kwargs): return await receive(*args, **kwargs) with sentry_sdk.start_span( op=OP.MIDDLEWARE_LITESTAR_RECEIVE, - description=getattr(receive, "__qualname__", str(receive)), + name=getattr(receive, "__qualname__", str(receive)), origin=LitestarIntegration.origin, ) as span: span.set_tag("litestar.middleware_name", middleware_name) @@ -168,7 +168,7 @@ async def _sentry_send(message): return await send(message) with sentry_sdk.start_span( op=OP.MIDDLEWARE_LITESTAR_SEND, - description=getattr(send, "__qualname__", str(send)), + name=getattr(send, "__qualname__", str(send)), origin=LitestarIntegration.origin, ) as span: span.set_tag("litestar.middleware_name", middleware_name) diff --git a/sentry_sdk/integrations/openai.py b/sentry_sdk/integrations/openai.py index 5cf0817c87..272f142b05 100644 --- a/sentry_sdk/integrations/openai.py +++ b/sentry_sdk/integrations/openai.py @@ -10,7 +10,6 @@ from sentry_sdk.utils import ( capture_internal_exceptions, event_from_exception, - ensure_integration_enabled, ) from typing import TYPE_CHECKING @@ -113,11 +112,12 @@ def _calculate_chat_completion_usage( def _wrap_chat_completion_create(f): # type: (Callable[..., Any]) -> Callable[..., Any] - @ensure_integration_enabled(OpenAIIntegration, f) + @wraps(f) def new_chat_completion(*args, **kwargs): # type: (*Any, **Any) -> Any - if "messages" not in kwargs: - # invalid call (in all versions of openai), let it return error + integration = sentry_sdk.get_client().get_integration(OpenAIIntegration) + if integration is None or "messages" not in kwargs: + # no "messages" means invalid call (in all versions of openai), let it return error return f(*args, **kwargs) try: @@ -133,7 +133,7 @@ def new_chat_completion(*args, **kwargs): span = sentry_sdk.start_span( op=consts.OP.OPENAI_CHAT_COMPLETIONS_CREATE, - description="Chat Completion", + name="Chat Completion", origin=OpenAIIntegration.origin, ) span.__enter__() @@ -144,8 +144,6 @@ def new_chat_completion(*args, **kwargs): span.__exit__(None, None, None) raise e from None - integration = sentry_sdk.get_client().get_integration(OpenAIIntegration) - with capture_internal_exceptions(): if should_send_default_pii() and integration.include_prompts: set_data_normalized(span, SPANDATA.AI_INPUT_MESSAGES, messages) @@ -218,15 +216,17 @@ def _wrap_embeddings_create(f): # type: (Callable[..., Any]) -> Callable[..., Any] @wraps(f) - @ensure_integration_enabled(OpenAIIntegration, f) def new_embeddings_create(*args, **kwargs): # type: (*Any, **Any) -> Any + integration = sentry_sdk.get_client().get_integration(OpenAIIntegration) + if integration is None: + return f(*args, **kwargs) + with sentry_sdk.start_span( op=consts.OP.OPENAI_EMBEDDINGS_CREATE, - description="OpenAI Embedding Creation", + name="OpenAI Embedding Creation", origin=OpenAIIntegration.origin, ) as span: - integration = sentry_sdk.get_client().get_integration(OpenAIIntegration) if "input" in kwargs and ( should_send_default_pii() and integration.include_prompts ): diff --git a/sentry_sdk/integrations/opentelemetry/span_processor.py b/sentry_sdk/integrations/opentelemetry/span_processor.py index 1a2951983e..e00562a509 100644 --- a/sentry_sdk/integrations/opentelemetry/span_processor.py +++ b/sentry_sdk/integrations/opentelemetry/span_processor.py @@ -147,7 +147,7 @@ def on_start(self, otel_span, parent_context=None): if sentry_parent_span: sentry_span = sentry_parent_span.start_child( span_id=trace_data["span_id"], - description=otel_span.name, + name=otel_span.name, start_timestamp=start_timestamp, instrumenter=INSTRUMENTER.OTEL, origin=SPAN_ORIGIN, diff --git a/sentry_sdk/integrations/pymongo.py b/sentry_sdk/integrations/pymongo.py index ebfaa19766..f65ad73687 100644 --- a/sentry_sdk/integrations/pymongo.py +++ b/sentry_sdk/integrations/pymongo.py @@ -158,7 +158,7 @@ def started(self, event): query = json.dumps(command, default=str) span = sentry_sdk.start_span( op=OP.DB, - description=query, + name=query, origin=PyMongoIntegration.origin, ) diff --git a/sentry_sdk/integrations/pyramid.py b/sentry_sdk/integrations/pyramid.py index 3ef7000343..d1475ada65 100644 --- a/sentry_sdk/integrations/pyramid.py +++ b/sentry_sdk/integrations/pyramid.py @@ -1,3 +1,4 @@ +import functools import os import sys import weakref @@ -73,10 +74,12 @@ def setup_once(): old_call_view = router._call_view - @ensure_integration_enabled(PyramidIntegration, old_call_view) + @functools.wraps(old_call_view) def sentry_patched_call_view(registry, request, *args, **kwargs): # type: (Any, Request, *Any, **Any) -> Response integration = sentry_sdk.get_client().get_integration(PyramidIntegration) + if integration is None: + return old_call_view(registry, request, *args, **kwargs) _set_transaction_name_and_source( sentry_sdk.get_current_scope(), integration.transaction_style, request diff --git a/sentry_sdk/integrations/ray.py b/sentry_sdk/integrations/ray.py index bafd42c8d6..2f5086ed92 100644 --- a/sentry_sdk/integrations/ray.py +++ b/sentry_sdk/integrations/ray.py @@ -88,7 +88,7 @@ def _remote_method_with_header_propagation(*args, **kwargs): """ with sentry_sdk.start_span( op=OP.QUEUE_SUBMIT_RAY, - description=qualname_from_function(f), + name=qualname_from_function(f), origin=RayIntegration.origin, ) as span: tracing = { diff --git a/sentry_sdk/integrations/redis/_async_common.py b/sentry_sdk/integrations/redis/_async_common.py index d311b3fa0f..196e85e74b 100644 --- a/sentry_sdk/integrations/redis/_async_common.py +++ b/sentry_sdk/integrations/redis/_async_common.py @@ -37,7 +37,7 @@ async def _sentry_execute(self, *args, **kwargs): with sentry_sdk.start_span( op=OP.DB_REDIS, - description="redis.pipeline.execute", + name="redis.pipeline.execute", origin=SPAN_ORIGIN, ) as span: with capture_internal_exceptions(): @@ -78,7 +78,7 @@ async def _sentry_execute_command(self, name, *args, **kwargs): if cache_properties["is_cache_key"] and cache_properties["op"] is not None: cache_span = sentry_sdk.start_span( op=cache_properties["op"], - description=cache_properties["description"], + name=cache_properties["description"], origin=SPAN_ORIGIN, ) cache_span.__enter__() @@ -87,7 +87,7 @@ async def _sentry_execute_command(self, name, *args, **kwargs): db_span = sentry_sdk.start_span( op=db_properties["op"], - description=db_properties["description"], + name=db_properties["description"], origin=SPAN_ORIGIN, ) db_span.__enter__() diff --git a/sentry_sdk/integrations/redis/_sync_common.py b/sentry_sdk/integrations/redis/_sync_common.py index 177e89143d..ef10e9e4f0 100644 --- a/sentry_sdk/integrations/redis/_sync_common.py +++ b/sentry_sdk/integrations/redis/_sync_common.py @@ -38,7 +38,7 @@ def sentry_patched_execute(self, *args, **kwargs): with sentry_sdk.start_span( op=OP.DB_REDIS, - description="redis.pipeline.execute", + name="redis.pipeline.execute", origin=SPAN_ORIGIN, ) as span: with capture_internal_exceptions(): @@ -83,7 +83,7 @@ def sentry_patched_execute_command(self, name, *args, **kwargs): if cache_properties["is_cache_key"] and cache_properties["op"] is not None: cache_span = sentry_sdk.start_span( op=cache_properties["op"], - description=cache_properties["description"], + name=cache_properties["description"], origin=SPAN_ORIGIN, ) cache_span.__enter__() @@ -92,7 +92,7 @@ def sentry_patched_execute_command(self, name, *args, **kwargs): db_span = sentry_sdk.start_span( op=db_properties["op"], - description=db_properties["description"], + name=db_properties["description"], origin=SPAN_ORIGIN, ) db_span.__enter__() diff --git a/sentry_sdk/integrations/sanic.py b/sentry_sdk/integrations/sanic.py index e2f24e5b6b..26e29cb78c 100644 --- a/sentry_sdk/integrations/sanic.py +++ b/sentry_sdk/integrations/sanic.py @@ -212,9 +212,7 @@ async def _context_exit(request, response=None): if not request.ctx._sentry_do_integration: return - integration = sentry_sdk.get_client().get_integration( - SanicIntegration - ) # type: Integration + integration = sentry_sdk.get_client().get_integration(SanicIntegration) response_status = None if response is None else response.status diff --git a/sentry_sdk/integrations/socket.py b/sentry_sdk/integrations/socket.py index beec7dbf3e..0866ceb608 100644 --- a/sentry_sdk/integrations/socket.py +++ b/sentry_sdk/integrations/socket.py @@ -55,7 +55,7 @@ def create_connection( with sentry_sdk.start_span( op=OP.SOCKET_CONNECTION, - description=_get_span_description(address[0], address[1]), + name=_get_span_description(address[0], address[1]), origin=SocketIntegration.origin, ) as span: span.set_data("address", address) @@ -81,7 +81,7 @@ def getaddrinfo(host, port, family=0, type=0, proto=0, flags=0): with sentry_sdk.start_span( op=OP.SOCKET_DNS, - description=_get_span_description(host, port), + name=_get_span_description(host, port), origin=SocketIntegration.origin, ) as span: span.set_data("host", host) diff --git a/sentry_sdk/integrations/sqlalchemy.py b/sentry_sdk/integrations/sqlalchemy.py index a968b7db9e..0a54108e75 100644 --- a/sentry_sdk/integrations/sqlalchemy.py +++ b/sentry_sdk/integrations/sqlalchemy.py @@ -1,6 +1,4 @@ -import sentry_sdk from sentry_sdk.consts import SPANSTATUS, SPANDATA -from sentry_sdk.db.explain_plan.sqlalchemy import attach_explain_plan_to_span from sentry_sdk.integrations import Integration, DidNotEnable from sentry_sdk.tracing_utils import add_query_source, record_sql_queries from sentry_sdk.utils import ( @@ -68,17 +66,6 @@ def _before_cursor_execute( if span is not None: _set_db_data(span, conn) - options = ( - sentry_sdk.get_client().options["_experiments"].get("attach_explain_plans") - ) - if options is not None: - attach_explain_plan_to_span( - span, - conn, - statement, - parameters, - options, - ) context._sentry_sql_span = span diff --git a/sentry_sdk/integrations/starlette.py b/sentry_sdk/integrations/starlette.py index 9df30fba72..03584fdad7 100644 --- a/sentry_sdk/integrations/starlette.py +++ b/sentry_sdk/integrations/starlette.py @@ -1,12 +1,19 @@ import asyncio import functools +import warnings +from collections.abc import Set from copy import deepcopy import sentry_sdk from sentry_sdk.consts import OP -from sentry_sdk.integrations import DidNotEnable, Integration +from sentry_sdk.integrations import ( + DidNotEnable, + Integration, + _DEFAULT_FAILED_REQUEST_STATUS_CODES, +) from sentry_sdk.integrations._wsgi_common import ( - _in_http_status_code_range, + DEFAULT_HTTP_METHODS_TO_CAPTURE, + HttpCodeRangeContainer, _is_json_content_type, request_body_within_bounds, ) @@ -30,7 +37,7 @@ from typing import TYPE_CHECKING if TYPE_CHECKING: - from typing import Any, Awaitable, Callable, Dict, Optional, Tuple + from typing import Any, Awaitable, Callable, Container, Dict, Optional, Tuple, Union from sentry_sdk._types import Event, HttpStatusCodeRange @@ -76,11 +83,12 @@ class StarletteIntegration(Integration): def __init__( self, - transaction_style="url", - failed_request_status_codes=None, - middleware_spans=True, + transaction_style="url", # type: str + failed_request_status_codes=_DEFAULT_FAILED_REQUEST_STATUS_CODES, # type: Union[Set[int], list[HttpStatusCodeRange], None] + middleware_spans=True, # type: bool + http_methods_to_capture=DEFAULT_HTTP_METHODS_TO_CAPTURE, # type: tuple[str, ...] ): - # type: (str, Optional[list[HttpStatusCodeRange]], bool) -> None + # type: (...) -> None if transaction_style not in TRANSACTION_STYLE_VALUES: raise ValueError( "Invalid value for transaction_style: %s (must be in %s)" @@ -88,9 +96,26 @@ def __init__( ) self.transaction_style = transaction_style self.middleware_spans = middleware_spans - self.failed_request_status_codes = failed_request_status_codes or [ - range(500, 599) - ] + self.http_methods_to_capture = tuple(map(str.upper, http_methods_to_capture)) + + if isinstance(failed_request_status_codes, Set): + self.failed_request_status_codes = ( + failed_request_status_codes + ) # type: Container[int] + else: + warnings.warn( + "Passing a list or None for failed_request_status_codes is deprecated. " + "Please pass a set of int instead.", + DeprecationWarning, + stacklevel=2, + ) + + if failed_request_status_codes is None: + self.failed_request_status_codes = _DEFAULT_FAILED_REQUEST_STATUS_CODES + else: + self.failed_request_status_codes = HttpCodeRangeContainer( + failed_request_status_codes + ) @staticmethod def setup_once(): @@ -132,7 +157,7 @@ async def _create_span_call(app, scope, receive, send, **kwargs): with sentry_sdk.start_span( op=OP.MIDDLEWARE_STARLETTE, - description=middleware_name, + name=middleware_name, origin=StarletteIntegration.origin, ) as middleware_span: middleware_span.set_tag("starlette.middleware_name", middleware_name) @@ -142,7 +167,7 @@ async def _sentry_receive(*args, **kwargs): # type: (*Any, **Any) -> Any with sentry_sdk.start_span( op=OP.MIDDLEWARE_STARLETTE_RECEIVE, - description=getattr(receive, "__qualname__", str(receive)), + name=getattr(receive, "__qualname__", str(receive)), origin=StarletteIntegration.origin, ) as span: span.set_tag("starlette.middleware_name", middleware_name) @@ -157,7 +182,7 @@ async def _sentry_send(*args, **kwargs): # type: (*Any, **Any) -> Any with sentry_sdk.start_span( op=OP.MIDDLEWARE_STARLETTE_SEND, - description=getattr(send, "__qualname__", str(send)), + name=getattr(send, "__qualname__", str(send)), origin=StarletteIntegration.origin, ) as span: span.set_tag("starlette.middleware_name", middleware_name) @@ -220,15 +245,14 @@ async def _sentry_patched_exception_handler(self, *args, **kwargs): exp = args[0] - is_http_server_error = ( - hasattr(exp, "status_code") - and isinstance(exp.status_code, int) - and _in_http_status_code_range( - exp.status_code, integration.failed_request_status_codes + if integration is not None: + is_http_server_error = ( + hasattr(exp, "status_code") + and isinstance(exp.status_code, int) + and exp.status_code in integration.failed_request_status_codes ) - ) - if is_http_server_error: - _capture_exception(exp, handled=True) + if is_http_server_error: + _capture_exception(exp, handled=True) # Find a matching handler old_handler = None @@ -369,6 +393,11 @@ async def _sentry_patched_asgi_app(self, scope, receive, send): mechanism_type=StarletteIntegration.identifier, transaction_style=integration.transaction_style, span_origin=StarletteIntegration.origin, + http_methods_to_capture=( + integration.http_methods_to_capture + if integration + else DEFAULT_HTTP_METHODS_TO_CAPTURE + ), ) middleware.__call__ = middleware._run_asgi3 @@ -449,12 +478,15 @@ def event_processor(event, hint): else: - @ensure_integration_enabled(StarletteIntegration, old_func) + @functools.wraps(old_func) def _sentry_sync_func(*args, **kwargs): # type: (*Any, **Any) -> Any integration = sentry_sdk.get_client().get_integration( StarletteIntegration ) + if integration is None: + return old_func(*args, **kwargs) + sentry_scope = sentry_sdk.get_isolation_scope() if sentry_scope.profile is not None: diff --git a/sentry_sdk/integrations/starlite.py b/sentry_sdk/integrations/starlite.py index 72bea97854..8714ee2f08 100644 --- a/sentry_sdk/integrations/starlite.py +++ b/sentry_sdk/integrations/starlite.py @@ -138,7 +138,7 @@ async def _create_span_call(self, scope, receive, send): middleware_name = self.__class__.__name__ with sentry_sdk.start_span( op=OP.MIDDLEWARE_STARLITE, - description=middleware_name, + name=middleware_name, origin=StarliteIntegration.origin, ) as middleware_span: middleware_span.set_tag("starlite.middleware_name", middleware_name) @@ -150,7 +150,7 @@ async def _sentry_receive(*args, **kwargs): return await receive(*args, **kwargs) with sentry_sdk.start_span( op=OP.MIDDLEWARE_STARLITE_RECEIVE, - description=getattr(receive, "__qualname__", str(receive)), + name=getattr(receive, "__qualname__", str(receive)), origin=StarliteIntegration.origin, ) as span: span.set_tag("starlite.middleware_name", middleware_name) @@ -167,7 +167,7 @@ async def _sentry_send(message): return await send(message) with sentry_sdk.start_span( op=OP.MIDDLEWARE_STARLITE_SEND, - description=getattr(send, "__qualname__", str(send)), + name=getattr(send, "__qualname__", str(send)), origin=StarliteIntegration.origin, ) as span: span.set_tag("starlite.middleware_name", middleware_name) diff --git a/sentry_sdk/integrations/stdlib.py b/sentry_sdk/integrations/stdlib.py index bef29ebec7..287c8cb272 100644 --- a/sentry_sdk/integrations/stdlib.py +++ b/sentry_sdk/integrations/stdlib.py @@ -90,7 +90,7 @@ def putrequest(self, method, url, *args, **kwargs): span = sentry_sdk.start_span( op=OP.HTTP_CLIENT, - description="%s %s" + name="%s %s" % (method, parsed_url.url if parsed_url else SENSITIVE_DATA_SUBSTITUTE), origin="auto.http.stdlib.httplib", ) @@ -203,7 +203,7 @@ def sentry_patched_popen_init(self, *a, **kw): with sentry_sdk.start_span( op=OP.SUBPROCESS, - description=description, + name=description, origin="auto.subprocess.stdlib.subprocess", ) as span: for k, v in sentry_sdk.get_current_scope().iter_trace_propagation_headers( diff --git a/sentry_sdk/integrations/strawberry.py b/sentry_sdk/integrations/strawberry.py index ac792c8612..570d10ed07 100644 --- a/sentry_sdk/integrations/strawberry.py +++ b/sentry_sdk/integrations/strawberry.py @@ -1,3 +1,4 @@ +import functools import hashlib from inspect import isawaitable @@ -87,10 +88,13 @@ def _patch_schema_init(): # type: () -> None old_schema_init = Schema.__init__ - @ensure_integration_enabled(StrawberryIntegration, old_schema_init) + @functools.wraps(old_schema_init) def _sentry_patched_schema_init(self, *args, **kwargs): # type: (Schema, Any, Any) -> None integration = sentry_sdk.get_client().get_integration(StrawberryIntegration) + if integration is None: + return old_schema_init(self, *args, **kwargs) + extensions = kwargs.get("extensions") or [] if integration.async_execution is not None: @@ -182,13 +186,13 @@ def on_operation(self): if span: self.graphql_span = span.start_child( op=op, - description=description, + name=description, origin=StrawberryIntegration.origin, ) else: self.graphql_span = sentry_sdk.start_span( op=op, - description=description, + name=description, origin=StrawberryIntegration.origin, ) @@ -211,7 +215,7 @@ def on_validate(self): # type: () -> Generator[None, None, None] self.validation_span = self.graphql_span.start_child( op=OP.GRAPHQL_VALIDATE, - description="validation", + name="validation", origin=StrawberryIntegration.origin, ) @@ -223,7 +227,7 @@ def on_parse(self): # type: () -> Generator[None, None, None] self.parsing_span = self.graphql_span.start_child( op=OP.GRAPHQL_PARSE, - description="parsing", + name="parsing", origin=StrawberryIntegration.origin, ) @@ -253,7 +257,7 @@ async def resolve(self, _next, root, info, *args, **kwargs): with self.graphql_span.start_child( op=OP.GRAPHQL_RESOLVE, - description="resolving {}".format(field_path), + name="resolving {}".format(field_path), origin=StrawberryIntegration.origin, ) as span: span.set_data("graphql.field_name", info.field_name) @@ -274,7 +278,7 @@ def resolve(self, _next, root, info, *args, **kwargs): with self.graphql_span.start_child( op=OP.GRAPHQL_RESOLVE, - description="resolving {}".format(field_path), + name="resolving {}".format(field_path), origin=StrawberryIntegration.origin, ) as span: span.set_data("graphql.field_name", info.field_name) diff --git a/sentry_sdk/integrations/sys_exit.py b/sentry_sdk/integrations/sys_exit.py index 39539b4c15..2341e11359 100644 --- a/sentry_sdk/integrations/sys_exit.py +++ b/sentry_sdk/integrations/sys_exit.py @@ -1,11 +1,8 @@ +import functools import sys import sentry_sdk -from sentry_sdk.utils import ( - ensure_integration_enabled, - capture_internal_exceptions, - event_from_exception, -) +from sentry_sdk.utils import capture_internal_exceptions, event_from_exception from sentry_sdk.integrations import Integration from sentry_sdk._types import TYPE_CHECKING @@ -41,13 +38,13 @@ def _patch_sys_exit(): # type: () -> None old_exit = sys.exit # type: Callable[[Union[str, int, None]], NoReturn] - @ensure_integration_enabled(SysExitIntegration, old_exit) + @functools.wraps(old_exit) def sentry_patched_exit(__status=0): # type: (Union[str, int, None]) -> NoReturn # @ensure_integration_enabled ensures that this is non-None - integration = sentry_sdk.get_client().get_integration( - SysExitIntegration - ) # type: SysExitIntegration + integration = sentry_sdk.get_client().get_integration(SysExitIntegration) + if integration is None: + old_exit(__status) try: old_exit(__status) @@ -60,7 +57,7 @@ def sentry_patched_exit(__status=0): _capture_exception(e) raise e - sys.exit = sentry_patched_exit # type: ignore + sys.exit = sentry_patched_exit def _capture_exception(exc): diff --git a/sentry_sdk/integrations/threading.py b/sentry_sdk/integrations/threading.py index c729e208a5..5de736e23b 100644 --- a/sentry_sdk/integrations/threading.py +++ b/sentry_sdk/integrations/threading.py @@ -6,7 +6,6 @@ from sentry_sdk.integrations import Integration from sentry_sdk.scope import use_isolation_scope, use_scope from sentry_sdk.utils import ( - ensure_integration_enabled, event_from_exception, capture_internal_exceptions, logger, @@ -51,10 +50,12 @@ def setup_once(): old_start = Thread.start @wraps(old_start) - @ensure_integration_enabled(ThreadingIntegration, old_start) def sentry_start(self, *a, **kw): # type: (Thread, *Any, **Any) -> Any integration = sentry_sdk.get_client().get_integration(ThreadingIntegration) + if integration is None: + return old_start(self, *a, **kw) + if integration.propagate_scope: isolation_scope = sentry_sdk.get_isolation_scope() current_scope = sentry_sdk.get_current_scope() diff --git a/sentry_sdk/integrations/wsgi.py b/sentry_sdk/integrations/wsgi.py index 00aad30854..50deae10c5 100644 --- a/sentry_sdk/integrations/wsgi.py +++ b/sentry_sdk/integrations/wsgi.py @@ -6,7 +6,11 @@ from sentry_sdk.api import continue_trace from sentry_sdk.consts import OP from sentry_sdk.scope import should_send_default_pii -from sentry_sdk.integrations._wsgi_common import _filter_headers +from sentry_sdk.integrations._wsgi_common import ( + DEFAULT_HTTP_METHODS_TO_CAPTURE, + _filter_headers, + nullcontext, +) from sentry_sdk.sessions import track_session from sentry_sdk.scope import use_isolation_scope from sentry_sdk.tracing import Transaction, TRANSACTION_SOURCE_ROUTE @@ -66,13 +70,25 @@ def get_request_url(environ, use_x_forwarded_for=False): class SentryWsgiMiddleware: - __slots__ = ("app", "use_x_forwarded_for", "span_origin") + __slots__ = ( + "app", + "use_x_forwarded_for", + "span_origin", + "http_methods_to_capture", + ) - def __init__(self, app, use_x_forwarded_for=False, span_origin="manual"): - # type: (Callable[[Dict[str, str], Callable[..., Any]], Any], bool, str) -> None + def __init__( + self, + app, # type: Callable[[Dict[str, str], Callable[..., Any]], Any] + use_x_forwarded_for=False, # type: bool + span_origin="manual", # type: str + http_methods_to_capture=DEFAULT_HTTP_METHODS_TO_CAPTURE, # type: Tuple[str, ...] + ): + # type: (...) -> None self.app = app self.use_x_forwarded_for = use_x_forwarded_for self.span_origin = span_origin + self.http_methods_to_capture = http_methods_to_capture def __call__(self, environ, start_response): # type: (Dict[str, str], Callable[..., Any]) -> _ScopedResponse @@ -92,16 +108,24 @@ def __call__(self, environ, start_response): ) ) - transaction = continue_trace( - environ, - op=OP.HTTP_SERVER, - name="generic WSGI request", - source=TRANSACTION_SOURCE_ROUTE, - origin=self.span_origin, - ) + method = environ.get("REQUEST_METHOD", "").upper() + transaction = None + if method in self.http_methods_to_capture: + transaction = continue_trace( + environ, + op=OP.HTTP_SERVER, + name="generic WSGI request", + source=TRANSACTION_SOURCE_ROUTE, + origin=self.span_origin, + ) - with sentry_sdk.start_transaction( - transaction, custom_sampling_context={"wsgi_environ": environ} + with ( + sentry_sdk.start_transaction( + transaction, + custom_sampling_context={"wsgi_environ": environ}, + ) + if transaction is not None + else nullcontext() ): try: response = self.app( @@ -120,7 +144,7 @@ def __call__(self, environ, start_response): def _sentry_start_response( # type: ignore old_start_response, # type: StartResponse - transaction, # type: Transaction + transaction, # type: Optional[Transaction] status, # type: str response_headers, # type: WsgiResponseHeaders exc_info=None, # type: Optional[WsgiExcInfo] @@ -128,7 +152,8 @@ def _sentry_start_response( # type: ignore # type: (...) -> WsgiResponseIter with capture_internal_exceptions(): status_int = int(status.split(" ", 1)[0]) - transaction.set_http_status(status_int) + if transaction is not None: + transaction.set_http_status(status_int) if exc_info is None: # The Django Rest Framework WSGI test client, and likely other diff --git a/sentry_sdk/metrics.py b/sentry_sdk/metrics.py index 05dc13042c..f6e9fd6bde 100644 --- a/sentry_sdk/metrics.py +++ b/sentry_sdk/metrics.py @@ -5,6 +5,7 @@ import sys import threading import time +import warnings import zlib from abc import ABC, abstractmethod from contextlib import contextmanager @@ -54,6 +55,14 @@ from sentry_sdk._types import MetricValue +warnings.warn( + "The sentry_sdk.metrics module is deprecated and will be removed in the next major release. " + "Sentry will reject all metrics sent after October 7, 2024. " + "Learn more: https://sentry.zendesk.com/hc/en-us/articles/26369339769883-Upcoming-API-Changes-to-Metrics", + DeprecationWarning, + stacklevel=2, +) + _in_metrics = ContextVar("in_metrics", default=False) _set = set # set is shadowed below @@ -817,7 +826,7 @@ def __enter__(self): # type: (...) -> _Timing self.entered = TIMING_FUNCTIONS[self.unit]() self._validate_invocation("context-manager") - self._span = sentry_sdk.start_span(op="metric.timing", description=self.key) + self._span = sentry_sdk.start_span(op="metric.timing", name=self.key) if self.tags: for key, value in self.tags.items(): if isinstance(value, (tuple, list)): diff --git a/sentry_sdk/scope.py b/sentry_sdk/scope.py index 6e0d0925c8..0c0482904e 100644 --- a/sentry_sdk/scope.py +++ b/sentry_sdk/scope.py @@ -1,5 +1,6 @@ import os import sys +import warnings from copy import copy from collections import deque from contextlib import contextmanager @@ -30,6 +31,7 @@ capture_internal_exception, capture_internal_exceptions, ContextVar, + datetime_from_isoformat, disable_capture_event, event_from_exception, exc_info_from_error, @@ -966,7 +968,7 @@ def start_transaction( transaction=None, instrumenter=INSTRUMENTER.SENTRY, custom_sampling_context=None, - **kwargs + **kwargs, ): # type: (Optional[Transaction], str, Optional[SamplingContext], Unpack[TransactionKwargs]) -> Union[Transaction, NoOpSpan] """ @@ -1066,6 +1068,13 @@ def start_span(self, instrumenter=INSTRUMENTER.SENTRY, **kwargs): be removed in the next major version. Going forward, it should only be used by the SDK itself. """ + if kwargs.get("description") is not None: + warnings.warn( + "The `description` parameter is deprecated. Please use `name` instead.", + DeprecationWarning, + stacklevel=2, + ) + with new_scope(): kwargs.setdefault("scope", self) @@ -1307,7 +1316,17 @@ def _apply_breadcrumbs_to_event(self, event, hint, options): event.setdefault("breadcrumbs", {}).setdefault("values", []).extend( self._breadcrumbs ) - event["breadcrumbs"]["values"].sort(key=lambda crumb: crumb["timestamp"]) + + # Attempt to sort timestamps + try: + for crumb in event["breadcrumbs"]["values"]: + if isinstance(crumb["timestamp"], str): + crumb["timestamp"] = datetime_from_isoformat(crumb["timestamp"]) + + event["breadcrumbs"]["values"].sort(key=lambda crumb: crumb["timestamp"]) + except Exception as err: + logger.debug("Error when sorting breadcrumbs", exc_info=err) + pass def _apply_user_to_event(self, event, hint, options): # type: (Event, Hint, Optional[Dict[str, Any]]) -> None diff --git a/sentry_sdk/tracing.py b/sentry_sdk/tracing.py index 3ca9744b54..7ce577b1d0 100644 --- a/sentry_sdk/tracing.py +++ b/sentry_sdk/tracing.py @@ -70,7 +70,7 @@ class SpanKwargs(TypedDict, total=False): """ description: str - """A description of what operation is being performed within the span.""" + """A description of what operation is being performed within the span. This argument is DEPRECATED. Please use the `name` parameter, instead.""" hub: Optional["sentry_sdk.Hub"] """The hub to use for this span. This argument is DEPRECATED. Please use the `scope` parameter, instead.""" @@ -97,10 +97,10 @@ class SpanKwargs(TypedDict, total=False): Default "manual". """ - class TransactionKwargs(SpanKwargs, total=False): name: str - """Identifier of the transaction. Will show up in the Sentry UI.""" + """A string describing what operation is being performed within the span/transaction.""" + class TransactionKwargs(SpanKwargs, total=False): source: str """ A string describing the source of the transaction name. This will be used to determine the transaction's type. @@ -227,6 +227,10 @@ class Span: :param op: The span's operation. A list of recommended values is available here: https://develop.sentry.dev/sdk/performance/span-operations/ :param description: A description of what operation is being performed within the span. + + .. deprecated:: 2.15.0 + Please use the `name` parameter, instead. + :param name: A string describing what operation is being performed within the span. :param hub: The hub to use for this span. .. deprecated:: 2.0.0 @@ -261,6 +265,7 @@ class Span: "_local_aggregator", "scope", "origin", + "name", ) def __init__( @@ -278,6 +283,7 @@ def __init__( start_timestamp=None, # type: Optional[Union[datetime, float]] scope=None, # type: Optional[sentry_sdk.Scope] origin="manual", # type: str + name=None, # type: Optional[str] ): # type: (...) -> None self.trace_id = trace_id or uuid.uuid4().hex @@ -286,7 +292,7 @@ def __init__( self.same_process_as_parent = same_process_as_parent self.sampled = sampled self.op = op - self.description = description + self.description = name or description self.status = status self.hub = hub # backwards compatibility self.scope = scope @@ -400,6 +406,13 @@ def start_child(self, instrumenter=INSTRUMENTER.SENTRY, **kwargs): be removed in the next major version. Going forward, it should only be used by the SDK itself. """ + if kwargs.get("description") is not None: + warnings.warn( + "The `description` parameter is deprecated. Please use `name` instead.", + DeprecationWarning, + stacklevel=2, + ) + configuration_instrumenter = sentry_sdk.get_client().options["instrumenter"] if instrumenter != configuration_instrumenter: @@ -750,7 +763,7 @@ class Transaction(Span): "_baggage", ) - def __init__( + def __init__( # type: ignore[misc] self, name="", # type: str parent_sampled=None, # type: Optional[bool] @@ -1298,4 +1311,8 @@ async def my_async_function(): has_tracing_enabled, maybe_create_breadcrumbs_from_span, ) -from sentry_sdk.metrics import LocalAggregator + +with warnings.catch_warnings(): + # The code in this file which uses `LocalAggregator` is only called from the deprecated `metrics` module. + warnings.simplefilter("ignore", DeprecationWarning) + from sentry_sdk.metrics import LocalAggregator diff --git a/sentry_sdk/tracing_utils.py b/sentry_sdk/tracing_utils.py index 0df1ae5bd4..461199e0cb 100644 --- a/sentry_sdk/tracing_utils.py +++ b/sentry_sdk/tracing_utils.py @@ -146,7 +146,7 @@ def record_sql_queries( with sentry_sdk.start_span( op=OP.DB, - description=query, + name=query, origin=span_origin, ) as span: for k, v in data.items(): @@ -180,6 +180,26 @@ def _get_frame_module_abs_path(frame): return None +def _should_be_included( + is_sentry_sdk_frame, # type: bool + namespace, # type: Optional[str] + in_app_include, # type: Optional[list[str]] + in_app_exclude, # type: Optional[list[str]] + abs_path, # type: Optional[str] + project_root, # type: Optional[str] +): + # type: (...) -> bool + # in_app_include takes precedence over in_app_exclude + should_be_included = _module_in_list(namespace, in_app_include) + should_be_excluded = _is_external_source(abs_path) or _module_in_list( + namespace, in_app_exclude + ) + return not is_sentry_sdk_frame and ( + should_be_included + or (_is_in_project_root(abs_path, project_root) and not should_be_excluded) + ) + + def add_query_source(span): # type: (sentry_sdk.tracing.Span) -> None """ @@ -221,19 +241,15 @@ def add_query_source(span): "sentry_sdk." ) - # in_app_include takes precedence over in_app_exclude - should_be_included = ( - not ( - _is_external_source(abs_path) - or _module_in_list(namespace, in_app_exclude) - ) - ) or _module_in_list(namespace, in_app_include) - - if ( - _is_in_project_root(abs_path, project_root) - and should_be_included - and not is_sentry_sdk_frame - ): + should_be_included = _should_be_included( + is_sentry_sdk_frame=is_sentry_sdk_frame, + namespace=namespace, + in_app_include=in_app_include, + in_app_exclude=in_app_exclude, + abs_path=abs_path, + project_root=project_root, + ) + if should_be_included: break frame = frame.f_back @@ -649,7 +665,7 @@ async def func_with_tracing(*args, **kwargs): with span.start_child( op=OP.FUNCTION, - description=qualname_from_function(func), + name=qualname_from_function(func), ): return await func(*args, **kwargs) @@ -677,7 +693,7 @@ def func_with_tracing(*args, **kwargs): with span.start_child( op=OP.FUNCTION, - description=qualname_from_function(func), + name=qualname_from_function(func), ): return func(*args, **kwargs) diff --git a/sentry_sdk/utils.py b/sentry_sdk/utils.py index 9f49b9470f..44cb98bfed 100644 --- a/sentry_sdk/utils.py +++ b/sentry_sdk/utils.py @@ -239,6 +239,31 @@ def format_timestamp(value): return utctime.strftime("%Y-%m-%dT%H:%M:%S.%fZ") +ISO_TZ_SEPARATORS = frozenset(("+", "-")) + + +def datetime_from_isoformat(value): + # type: (str) -> datetime + try: + result = datetime.fromisoformat(value) + except (AttributeError, ValueError): + # py 3.6 + timestamp_format = ( + "%Y-%m-%dT%H:%M:%S.%f" if "." in value else "%Y-%m-%dT%H:%M:%S" + ) + if value.endswith("Z"): + value = value[:-1] + "+0000" + + if value[-6] in ISO_TZ_SEPARATORS: + timestamp_format += "%z" + value = value[:-3] + value[-2:] + elif value[-5] in ISO_TZ_SEPARATORS: + timestamp_format += "%z" + + result = datetime.strptime(value, timestamp_format) + return result.astimezone(timezone.utc) + + def event_hint_with_exc_info(exc_info=None): # type: (Optional[ExcInfo]) -> Dict[str, Optional[ExcInfo]] """Creates a hint with the exc info filled in.""" diff --git a/setup.py b/setup.py index c11b6b771e..b5be538292 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ def get_file_text(file_name): setup( name="sentry-sdk", - version="2.14.0", + version="2.15.0", author="Sentry Team and Contributors", author_email="hello@sentry.io", url="https://github.com/getsentry/sentry-python", diff --git a/tests/integrations/aiohttp/test_aiohttp.py b/tests/integrations/aiohttp/test_aiohttp.py index 43e3bec546..5b25629a83 100644 --- a/tests/integrations/aiohttp/test_aiohttp.py +++ b/tests/integrations/aiohttp/test_aiohttp.py @@ -7,6 +7,13 @@ from aiohttp import web, ClientSession from aiohttp.client import ServerDisconnectedError from aiohttp.web_request import Request +from aiohttp.web_exceptions import ( + HTTPInternalServerError, + HTTPNetworkAuthenticationRequired, + HTTPBadRequest, + HTTPNotFound, + HTTPUnavailableForLegalReasons, +) from sentry_sdk import capture_message, start_transaction from sentry_sdk.integrations.aiohttp import AioHttpIntegration @@ -596,3 +603,118 @@ async def hello(request): (event,) = events assert event["contexts"]["trace"]["origin"] == "auto.http.aiohttp" assert event["spans"][0]["origin"] == "auto.http.aiohttp" + + +@pytest.mark.parametrize( + ("integration_kwargs", "exception_to_raise", "should_capture"), + ( + ({}, None, False), + ({}, HTTPBadRequest, False), + ( + {}, + HTTPUnavailableForLegalReasons(None), + False, + ), # Highest 4xx status code (451) + ({}, HTTPInternalServerError, True), + ({}, HTTPNetworkAuthenticationRequired, True), # Highest 5xx status code (511) + ({"failed_request_status_codes": set()}, HTTPInternalServerError, False), + ( + {"failed_request_status_codes": set()}, + HTTPNetworkAuthenticationRequired, + False, + ), + ({"failed_request_status_codes": {404, *range(500, 600)}}, HTTPNotFound, True), + ( + {"failed_request_status_codes": {404, *range(500, 600)}}, + HTTPInternalServerError, + True, + ), + ( + {"failed_request_status_codes": {404, *range(500, 600)}}, + HTTPBadRequest, + False, + ), + ), +) +@pytest.mark.asyncio +async def test_failed_request_status_codes( + sentry_init, + aiohttp_client, + capture_events, + integration_kwargs, + exception_to_raise, + should_capture, +): + sentry_init(integrations=[AioHttpIntegration(**integration_kwargs)]) + events = capture_events() + + async def handle(_): + if exception_to_raise is not None: + raise exception_to_raise + else: + return web.Response(status=200) + + app = web.Application() + app.router.add_get("/", handle) + + client = await aiohttp_client(app) + resp = await client.get("/") + + expected_status = ( + 200 if exception_to_raise is None else exception_to_raise.status_code + ) + assert resp.status == expected_status + + if should_capture: + (event,) = events + assert event["exception"]["values"][0]["type"] == exception_to_raise.__name__ + else: + assert not events + + +@pytest.mark.asyncio +async def test_failed_request_status_codes_with_returned_status( + sentry_init, aiohttp_client, capture_events +): + """ + Returning a web.Response with a failed_request_status_code should not be reported to Sentry. + """ + sentry_init(integrations=[AioHttpIntegration(failed_request_status_codes={500})]) + events = capture_events() + + async def handle(_): + return web.Response(status=500) + + app = web.Application() + app.router.add_get("/", handle) + + client = await aiohttp_client(app) + resp = await client.get("/") + + assert resp.status == 500 + assert not events + + +@pytest.mark.asyncio +async def test_failed_request_status_codes_non_http_exception( + sentry_init, aiohttp_client, capture_events +): + """ + If an exception, which is not an instance of HTTPException, is raised, it should be captured, even if + failed_request_status_codes is empty. + """ + sentry_init(integrations=[AioHttpIntegration(failed_request_status_codes=set())]) + events = capture_events() + + async def handle(_): + 1 / 0 + + app = web.Application() + app.router.add_get("/", handle) + + client = await aiohttp_client(app) + resp = await client.get("/") + assert resp.status == 500 + + (event,) = events + assert event["exception"]["values"][0]["type"] == "ZeroDivisionError" diff --git a/tests/integrations/asyncio/test_asyncio.py b/tests/integrations/asyncio/test_asyncio.py index a7ecd8034a..c9e572ca73 100644 --- a/tests/integrations/asyncio/test_asyncio.py +++ b/tests/integrations/asyncio/test_asyncio.py @@ -75,7 +75,7 @@ async def test_create_task( events = capture_events() with sentry_sdk.start_transaction(name="test_transaction_for_create_task"): - with sentry_sdk.start_span(op="root", description="not so important"): + with sentry_sdk.start_span(op="root", name="not so important"): tasks = [event_loop.create_task(foo()), event_loop.create_task(bar())] await asyncio.wait(tasks, return_when=asyncio.FIRST_EXCEPTION) @@ -118,7 +118,7 @@ async def test_gather( events = capture_events() with sentry_sdk.start_transaction(name="test_transaction_for_gather"): - with sentry_sdk.start_span(op="root", description="not so important"): + with sentry_sdk.start_span(op="root", name="not so important"): await asyncio.gather(foo(), bar(), return_exceptions=True) sentry_sdk.flush() @@ -161,7 +161,7 @@ async def test_exception( events = capture_events() with sentry_sdk.start_transaction(name="test_exception"): - with sentry_sdk.start_span(op="root", description="not so important"): + with sentry_sdk.start_span(op="root", name="not so important"): tasks = [event_loop.create_task(boom()), event_loop.create_task(bar())] await asyncio.wait(tasks, return_when=asyncio.FIRST_EXCEPTION) diff --git a/tests/integrations/aws_lambda/test_aws.py b/tests/integrations/aws_lambda/test_aws.py index cc62b7e7ad..75dc930da5 100644 --- a/tests/integrations/aws_lambda/test_aws.py +++ b/tests/integrations/aws_lambda/test_aws.py @@ -317,6 +317,9 @@ def test_handler(event, context): } +@pytest.mark.xfail( + reason="Amazon changed something (2024-10-01) and on Python 3.9+ our SDK can not capture events in the init phase of the Lambda function anymore. We need to fix this somehow." +) def test_init_error(run_lambda_function, lambda_runtime): envelope_items, _ = run_lambda_function( LAMBDA_PRELUDE diff --git a/tests/integrations/django/myapp/settings.py b/tests/integrations/django/myapp/settings.py index 0678762b6b..d70adf63ec 100644 --- a/tests/integrations/django/myapp/settings.py +++ b/tests/integrations/django/myapp/settings.py @@ -132,7 +132,7 @@ def middleware(request): except (ImportError, KeyError): from sentry_sdk.utils import logger - logger.warn("No psycopg2 found, testing with SQLite.") + logger.warning("No psycopg2 found, testing with SQLite.") # Password validation diff --git a/tests/integrations/django/myapp/urls.py b/tests/integrations/django/myapp/urls.py index b9e821afa8..79dd4edd52 100644 --- a/tests/integrations/django/myapp/urls.py +++ b/tests/integrations/django/myapp/urls.py @@ -43,6 +43,7 @@ def path(path, *args, **kwargs): ), path("middleware-exc", views.message, name="middleware_exc"), path("message", views.message, name="message"), + path("nomessage", views.nomessage, name="nomessage"), path("view-with-signal", views.view_with_signal, name="view_with_signal"), path("mylogin", views.mylogin, name="mylogin"), path("classbased", views.ClassBasedView.as_view(), name="classbased"), diff --git a/tests/integrations/django/myapp/views.py b/tests/integrations/django/myapp/views.py index c1950059fe..5e8cc39053 100644 --- a/tests/integrations/django/myapp/views.py +++ b/tests/integrations/django/myapp/views.py @@ -115,6 +115,11 @@ def message(request): return HttpResponse("ok") +@csrf_exempt +def nomessage(request): + return HttpResponse("ok") + + @csrf_exempt def view_with_signal(request): custom_signal = Signal() diff --git a/tests/integrations/django/test_basic.py b/tests/integrations/django/test_basic.py index 45c25595f3..2089f1e936 100644 --- a/tests/integrations/django/test_basic.py +++ b/tests/integrations/django/test_basic.py @@ -3,6 +3,7 @@ import re import pytest from functools import partial +from unittest.mock import patch from werkzeug.test import Client @@ -10,6 +11,7 @@ from django.contrib.auth.models import User from django.core.management import execute_from_command_line from django.db.utils import OperationalError, ProgrammingError, DataError +from django.http.request import RawPostDataException try: from django.urls import reverse @@ -20,7 +22,11 @@ from sentry_sdk._compat import PY310 from sentry_sdk import capture_message, capture_exception from sentry_sdk.consts import SPANDATA -from sentry_sdk.integrations.django import DjangoIntegration, _set_db_data +from sentry_sdk.integrations.django import ( + DjangoIntegration, + DjangoRequestExtractor, + _set_db_data, +) from sentry_sdk.integrations.django.signals_handlers import _get_receiver_name from sentry_sdk.integrations.executing import ExecutingIntegration from sentry_sdk.tracing import Span @@ -139,7 +145,11 @@ def test_transaction_with_class_view(sentry_init, client, capture_events): def test_has_trace_if_performance_enabled(sentry_init, client, capture_events): sentry_init( - integrations=[DjangoIntegration()], + integrations=[ + DjangoIntegration( + http_methods_to_capture=("HEAD",), + ) + ], traces_sample_rate=1.0, ) events = capture_events() @@ -186,7 +196,11 @@ def test_has_trace_if_performance_disabled(sentry_init, client, capture_events): def test_trace_from_headers_if_performance_enabled(sentry_init, client, capture_events): sentry_init( - integrations=[DjangoIntegration()], + integrations=[ + DjangoIntegration( + http_methods_to_capture=("HEAD",), + ) + ], traces_sample_rate=1.0, ) @@ -219,7 +233,11 @@ def test_trace_from_headers_if_performance_disabled( sentry_init, client, capture_events ): sentry_init( - integrations=[DjangoIntegration()], + integrations=[ + DjangoIntegration( + http_methods_to_capture=("HEAD",), + ) + ], ) events = capture_events() @@ -740,6 +758,26 @@ def test_read_request(sentry_init, client, capture_events): assert "data" not in event["request"] +def test_request_body_already_read(sentry_init, client, capture_events): + sentry_init(integrations=[DjangoIntegration()]) + + events = capture_events() + + class MockExtractor(DjangoRequestExtractor): + def raw_data(self): + raise RawPostDataException + + with patch("sentry_sdk.integrations.django.DjangoRequestExtractor", MockExtractor): + client.post( + reverse("post_echo"), data=b'{"hey": 42}', content_type="application/json" + ) + + (event,) = events + + assert event["message"] == "hi" + assert "data" not in event["request"] + + def test_template_tracing_meta(sentry_init, client, capture_events): sentry_init(integrations=[DjangoIntegration()]) events = capture_events() @@ -1157,3 +1195,48 @@ def test_span_origin(sentry_init, client, capture_events): signal_span_found = True assert signal_span_found + + +def test_transaction_http_method_default(sentry_init, client, capture_events): + """ + By default OPTIONS and HEAD requests do not create a transaction. + """ + sentry_init( + integrations=[DjangoIntegration()], + traces_sample_rate=1.0, + ) + events = capture_events() + + client.get("/nomessage") + client.options("/nomessage") + client.head("/nomessage") + + (event,) = events + + assert len(events) == 1 + assert event["request"]["method"] == "GET" + + +def test_transaction_http_method_custom(sentry_init, client, capture_events): + sentry_init( + integrations=[ + DjangoIntegration( + http_methods_to_capture=( + "OPTIONS", + "head", + ), # capitalization does not matter + ) + ], + traces_sample_rate=1.0, + ) + events = capture_events() + + client.get("/nomessage") + client.options("/nomessage") + client.head("/nomessage") + + assert len(events) == 2 + + (event1, event2) = events + assert event1["request"]["method"] == "OPTIONS" + assert event2["request"]["method"] == "HEAD" diff --git a/tests/integrations/django/test_middleware.py b/tests/integrations/django/test_middleware.py new file mode 100644 index 0000000000..2a8d94f623 --- /dev/null +++ b/tests/integrations/django/test_middleware.py @@ -0,0 +1,34 @@ +from typing import Optional + +import pytest + +from sentry_sdk.integrations.django.middleware import _wrap_middleware + + +def _sync_capable_middleware_factory(sync_capable): + # type: (Optional[bool]) -> type + """Create a middleware class with a sync_capable attribute set to the value passed to the factory. + If the factory is called with None, the middleware class will not have a sync_capable attribute. + """ + sc = sync_capable # rename so we can set sync_capable in the class + + class TestMiddleware: + nonlocal sc + if sc is not None: + sync_capable = sc + + return TestMiddleware + + +@pytest.mark.parametrize( + ("middleware", "sync_capable"), + ( + (_sync_capable_middleware_factory(True), True), + (_sync_capable_middleware_factory(False), False), + (_sync_capable_middleware_factory(None), True), + ), +) +def test_wrap_middleware_sync_capable_attribute(middleware, sync_capable): + wrapped_middleware = _wrap_middleware(middleware, "test_middleware") + + assert wrapped_middleware.sync_capable is sync_capable diff --git a/tests/integrations/fastapi/test_fastapi.py b/tests/integrations/fastapi/test_fastapi.py index 7eaa0e0c90..93d048c029 100644 --- a/tests/integrations/fastapi/test_fastapi.py +++ b/tests/integrations/fastapi/test_fastapi.py @@ -1,9 +1,11 @@ import json import logging +import pytest import threading +import warnings from unittest import mock -import pytest +import fastapi from fastapi import FastAPI, HTTPException, Request from fastapi.testclient import TestClient from fastapi.middleware.trustedhost import TrustedHostMiddleware @@ -12,6 +14,12 @@ from sentry_sdk.integrations.asgi import SentryAsgiMiddleware from sentry_sdk.integrations.fastapi import FastApiIntegration from sentry_sdk.integrations.starlette import StarletteIntegration +from sentry_sdk.utils import parse_version + + +FASTAPI_VERSION = parse_version(fastapi.__version__) + +from tests.integrations.starlette import test_starlette def fastapi_app_factory(): @@ -28,6 +36,17 @@ async def _message(): capture_message("Hi") return {"message": "Hi"} + @app.delete("/nomessage") + @app.get("/nomessage") + @app.head("/nomessage") + @app.options("/nomessage") + @app.patch("/nomessage") + @app.post("/nomessage") + @app.put("/nomessage") + @app.trace("/nomessage") + async def _nomessage(): + return {"message": "nothing here..."} + @app.get("/message/{message_id}") async def _message_with_id(message_id): capture_message("Hi") @@ -503,38 +522,28 @@ def test_transaction_name_in_middleware( ) -@pytest.mark.parametrize( - "failed_request_status_codes,status_code,expected_error", - [ - (None, 500, True), - (None, 400, False), - ([500, 501], 500, True), - ([500, 501], 401, False), - ([range(400, 499)], 401, True), - ([range(400, 499)], 500, False), - ([range(400, 499), range(500, 599)], 300, False), - ([range(400, 499), range(500, 599)], 403, True), - ([range(400, 499), range(500, 599)], 503, True), - ([range(400, 403), 500, 501], 401, True), - ([range(400, 403), 500, 501], 405, False), - ([range(400, 403), 500, 501], 501, True), - ([range(400, 403), 500, 501], 503, False), - ([None], 500, False), - ], -) -def test_configurable_status_codes( +@test_starlette.parametrize_test_configurable_status_codes_deprecated +def test_configurable_status_codes_deprecated( sentry_init, capture_events, failed_request_status_codes, status_code, expected_error, ): + with pytest.warns(DeprecationWarning): + starlette_integration = StarletteIntegration( + failed_request_status_codes=failed_request_status_codes + ) + + with pytest.warns(DeprecationWarning): + fast_api_integration = FastApiIntegration( + failed_request_status_codes=failed_request_status_codes + ) + sentry_init( integrations=[ - StarletteIntegration( - failed_request_status_codes=failed_request_status_codes - ), - FastApiIntegration(failed_request_status_codes=failed_request_status_codes), + starlette_integration, + fast_api_integration, ] ) @@ -553,3 +562,114 @@ async def _error(): assert len(events) == 1 else: assert not events + + +@pytest.mark.skipif( + FASTAPI_VERSION < (0, 80), + reason="Requires FastAPI >= 0.80, because earlier versions do not support HTTP 'HEAD' requests", +) +def test_transaction_http_method_default(sentry_init, capture_events): + """ + By default OPTIONS and HEAD requests do not create a transaction. + """ + # FastAPI is heavily based on Starlette so we also need + # to enable StarletteIntegration. + # In the future this will be auto enabled. + sentry_init( + traces_sample_rate=1.0, + integrations=[ + StarletteIntegration(), + FastApiIntegration(), + ], + ) + + app = fastapi_app_factory() + + events = capture_events() + + client = TestClient(app) + client.get("/nomessage") + client.options("/nomessage") + client.head("/nomessage") + + assert len(events) == 1 + + (event,) = events + + assert event["request"]["method"] == "GET" + + +@pytest.mark.skipif( + FASTAPI_VERSION < (0, 80), + reason="Requires FastAPI >= 0.80, because earlier versions do not support HTTP 'HEAD' requests", +) +def test_transaction_http_method_custom(sentry_init, capture_events): + # FastAPI is heavily based on Starlette so we also need + # to enable StarletteIntegration. + # In the future this will be auto enabled. + sentry_init( + traces_sample_rate=1.0, + integrations=[ + StarletteIntegration( + http_methods_to_capture=( + "OPTIONS", + "head", + ), # capitalization does not matter + ), + FastApiIntegration( + http_methods_to_capture=( + "OPTIONS", + "head", + ), # capitalization does not matter + ), + ], + ) + + app = fastapi_app_factory() + + events = capture_events() + + client = TestClient(app) + client.get("/nomessage") + client.options("/nomessage") + client.head("/nomessage") + + assert len(events) == 2 + + (event1, event2) = events + + assert event1["request"]["method"] == "OPTIONS" + assert event2["request"]["method"] == "HEAD" + + +@test_starlette.parametrize_test_configurable_status_codes +def test_configurable_status_codes( + sentry_init, + capture_events, + failed_request_status_codes, + status_code, + expected_error, +): + integration_kwargs = {} + if failed_request_status_codes is not None: + integration_kwargs["failed_request_status_codes"] = failed_request_status_codes + + with warnings.catch_warnings(): + warnings.simplefilter("error", DeprecationWarning) + starlette_integration = StarletteIntegration(**integration_kwargs) + fastapi_integration = FastApiIntegration(**integration_kwargs) + + sentry_init(integrations=[starlette_integration, fastapi_integration]) + + events = capture_events() + + app = FastAPI() + + @app.get("/error") + async def _error(): + raise HTTPException(status_code) + + client = TestClient(app) + client.get("/error") + + assert len(events) == int(expected_error) diff --git a/tests/integrations/flask/test_flask.py b/tests/integrations/flask/test_flask.py index 03a3b0b9d0..6febb12b8b 100644 --- a/tests/integrations/flask/test_flask.py +++ b/tests/integrations/flask/test_flask.py @@ -47,6 +47,10 @@ def hi(): capture_message("hi") return "ok" + @app.route("/nomessage") + def nohi(): + return "ok" + @app.route("/message/") def hi_with_id(message_id): capture_message("hi again") @@ -962,3 +966,71 @@ def test_span_origin(sentry_init, app, capture_events): (_, event) = events assert event["contexts"]["trace"]["origin"] == "auto.http.flask" + + +def test_transaction_http_method_default( + sentry_init, + app, + capture_events, +): + """ + By default OPTIONS and HEAD requests do not create a transaction. + """ + sentry_init( + traces_sample_rate=1.0, + integrations=[flask_sentry.FlaskIntegration()], + ) + events = capture_events() + + client = app.test_client() + response = client.get("/nomessage") + assert response.status_code == 200 + + response = client.options("/nomessage") + assert response.status_code == 200 + + response = client.head("/nomessage") + assert response.status_code == 200 + + (event,) = events + + assert len(events) == 1 + assert event["request"]["method"] == "GET" + + +def test_transaction_http_method_custom( + sentry_init, + app, + capture_events, +): + """ + Configure FlaskIntegration to ONLY capture OPTIONS and HEAD requests. + """ + sentry_init( + traces_sample_rate=1.0, + integrations=[ + flask_sentry.FlaskIntegration( + http_methods_to_capture=( + "OPTIONS", + "head", + ) # capitalization does not matter + ) # case does not matter + ], + ) + events = capture_events() + + client = app.test_client() + response = client.get("/nomessage") + assert response.status_code == 200 + + response = client.options("/nomessage") + assert response.status_code == 200 + + response = client.head("/nomessage") + assert response.status_code == 200 + + assert len(events) == 2 + + (event1, event2) = events + assert event1["request"]["method"] == "OPTIONS" + assert event2["request"]["method"] == "HEAD" diff --git a/tests/integrations/grpc/test_grpc.py b/tests/integrations/grpc/test_grpc.py index 66b65bbbf7..a8872ef0b5 100644 --- a/tests/integrations/grpc/test_grpc.py +++ b/tests/integrations/grpc/test_grpc.py @@ -357,7 +357,7 @@ class TestService(gRPCTestServiceServicer): def TestServe(request, context): # noqa: N802 with start_span( op="test", - description="test", + name="test", origin="auto.grpc.grpc.TestService", ): pass diff --git a/tests/integrations/grpc/test_grpc_aio.py b/tests/integrations/grpc/test_grpc_aio.py index 2ff91dcf16..fff22626d9 100644 --- a/tests/integrations/grpc/test_grpc_aio.py +++ b/tests/integrations/grpc/test_grpc_aio.py @@ -282,7 +282,7 @@ def __init__(self): async def TestServe(cls, request, context): # noqa: N802 with start_span( op="test", - description="test", + name="test", origin="auto.grpc.grpc.TestService.aio", ): pass diff --git a/tests/integrations/opentelemetry/test_span_processor.py b/tests/integrations/opentelemetry/test_span_processor.py index 7045b52f17..ec5cf6af23 100644 --- a/tests/integrations/opentelemetry/test_span_processor.py +++ b/tests/integrations/opentelemetry/test_span_processor.py @@ -361,7 +361,7 @@ def test_on_start_child(): fake_span.start_child.assert_called_once_with( span_id="1234567890abcdef", - description="Sample OTel Span", + name="Sample OTel Span", start_timestamp=datetime.fromtimestamp( otel_span.start_time / 1e9, timezone.utc ), diff --git a/tests/integrations/ray/test_ray.py b/tests/integrations/ray/test_ray.py index f1c109533b..02c08c2a9e 100644 --- a/tests/integrations/ray/test_ray.py +++ b/tests/integrations/ray/test_ray.py @@ -52,7 +52,7 @@ def test_ray_tracing(): @ray.remote def example_task(): - with sentry_sdk.start_span(op="task", description="example task step"): + with sentry_sdk.start_span(op="task", name="example task step"): ... return sentry_sdk.get_client().transport.envelopes @@ -177,7 +177,7 @@ def __init__(self): self.n = 0 def increment(self): - with sentry_sdk.start_span(op="task", description="example task step"): + with sentry_sdk.start_span(op="task", name="example task step"): self.n += 1 return sentry_sdk.get_client().transport.envelopes diff --git a/tests/integrations/starlette/test_starlette.py b/tests/integrations/starlette/test_starlette.py index 918ad1185e..1ba9eb7589 100644 --- a/tests/integrations/starlette/test_starlette.py +++ b/tests/integrations/starlette/test_starlette.py @@ -6,6 +6,7 @@ import os import re import threading +import warnings from unittest import mock import pytest @@ -112,6 +113,9 @@ async def _message(request): capture_message("hi") return starlette.responses.JSONResponse({"status": "ok"}) + async def _nomessage(request): + return starlette.responses.JSONResponse({"status": "ok"}) + async def _message_with_id(request): capture_message("hi") return starlette.responses.JSONResponse({"status": "ok"}) @@ -141,12 +145,25 @@ async def _render_template(request): } return templates.TemplateResponse("trace_meta.html", template_context) + all_methods = [ + "CONNECT", + "DELETE", + "GET", + "HEAD", + "OPTIONS", + "PATCH", + "POST", + "PUT", + "TRACE", + ] + app = starlette.applications.Starlette( debug=debug, routes=[ starlette.routing.Route("/some_url", _homepage), starlette.routing.Route("/custom_error", _custom_error), starlette.routing.Route("/message", _message), + starlette.routing.Route("/nomessage", _nomessage, methods=all_methods), starlette.routing.Route("/message/{message_id}", _message_with_id), starlette.routing.Route("/sync/thread_ids", _thread_ids_sync), starlette.routing.Route("/async/thread_ids", _thread_ids_async), @@ -1133,7 +1150,22 @@ def test_span_origin(sentry_init, capture_events): assert span["origin"] == "auto.http.starlette" -@pytest.mark.parametrize( +class NonIterableContainer: + """Wraps any container and makes it non-iterable. + + Used to test backwards compatibility with our old way of defining failed_request_status_codes, which allowed + passing in a list of (possibly non-iterable) containers. The Python standard library does not provide any built-in + non-iterable containers, so we have to define our own. + """ + + def __init__(self, inner): + self.inner = inner + + def __contains__(self, item): + return item in self.inner + + +parametrize_test_configurable_status_codes_deprecated = pytest.mark.parametrize( "failed_request_status_codes,status_code,expected_error", [ (None, 500, True), @@ -1149,23 +1181,30 @@ def test_span_origin(sentry_init, capture_events): ([range(400, 403), 500, 501], 405, False), ([range(400, 403), 500, 501], 501, True), ([range(400, 403), 500, 501], 503, False), - ([None], 500, False), + ([], 500, False), + ([NonIterableContainer(range(500, 600))], 500, True), + ([NonIterableContainer(range(500, 600))], 404, False), ], ) -def test_configurable_status_codes( +"""Test cases for configurable status codes (deprecated API). +Also used by the FastAPI tests. +""" + + +@parametrize_test_configurable_status_codes_deprecated +def test_configurable_status_codes_deprecated( sentry_init, capture_events, failed_request_status_codes, status_code, expected_error, ): - sentry_init( - integrations=[ - StarletteIntegration( - failed_request_status_codes=failed_request_status_codes - ) - ] - ) + with pytest.warns(DeprecationWarning): + starlette_integration = StarletteIntegration( + failed_request_status_codes=failed_request_status_codes + ) + + sentry_init(integrations=[starlette_integration]) events = capture_events() @@ -1185,3 +1224,123 @@ async def _error(request): assert len(events) == 1 else: assert not events + + +@pytest.mark.skipif( + STARLETTE_VERSION < (0, 21), + reason="Requires Starlette >= 0.21, because earlier versions do not support HTTP 'HEAD' requests", +) +def test_transaction_http_method_default(sentry_init, capture_events): + """ + By default OPTIONS and HEAD requests do not create a transaction. + """ + sentry_init( + traces_sample_rate=1.0, + integrations=[ + StarletteIntegration(), + ], + ) + events = capture_events() + + starlette_app = starlette_app_factory() + + client = TestClient(starlette_app) + client.get("/nomessage") + client.options("/nomessage") + client.head("/nomessage") + + assert len(events) == 1 + + (event,) = events + + assert event["request"]["method"] == "GET" + + +@pytest.mark.skipif( + STARLETTE_VERSION < (0, 21), + reason="Requires Starlette >= 0.21, because earlier versions do not support HTTP 'HEAD' requests", +) +def test_transaction_http_method_custom(sentry_init, capture_events): + sentry_init( + traces_sample_rate=1.0, + integrations=[ + StarletteIntegration( + http_methods_to_capture=( + "OPTIONS", + "head", + ), # capitalization does not matter + ), + ], + debug=True, + ) + events = capture_events() + + starlette_app = starlette_app_factory() + + client = TestClient(starlette_app) + client.get("/nomessage") + client.options("/nomessage") + client.head("/nomessage") + + assert len(events) == 2 + + (event1, event2) = events + + assert event1["request"]["method"] == "OPTIONS" + assert event2["request"]["method"] == "HEAD" + + +parametrize_test_configurable_status_codes = pytest.mark.parametrize( + ("failed_request_status_codes", "status_code", "expected_error"), + ( + (None, 500, True), + (None, 400, False), + ({500, 501}, 500, True), + ({500, 501}, 401, False), + ({*range(400, 500)}, 401, True), + ({*range(400, 500)}, 500, False), + ({*range(400, 600)}, 300, False), + ({*range(400, 600)}, 403, True), + ({*range(400, 600)}, 503, True), + ({*range(400, 403), 500, 501}, 401, True), + ({*range(400, 403), 500, 501}, 405, False), + ({*range(400, 403), 500, 501}, 501, True), + ({*range(400, 403), 500, 501}, 503, False), + (set(), 500, False), + ), +) + + +@parametrize_test_configurable_status_codes +def test_configurable_status_codes( + sentry_init, + capture_events, + failed_request_status_codes, + status_code, + expected_error, +): + integration_kwargs = {} + if failed_request_status_codes is not None: + integration_kwargs["failed_request_status_codes"] = failed_request_status_codes + + with warnings.catch_warnings(): + warnings.simplefilter("error", DeprecationWarning) + starlette_integration = StarletteIntegration(**integration_kwargs) + + sentry_init(integrations=[starlette_integration]) + + events = capture_events() + + async def _error(_): + raise HTTPException(status_code) + + app = starlette.applications.Starlette( + routes=[ + starlette.routing.Route("/error", _error, methods=["GET"]), + ], + ) + + client = TestClient(app) + client.get("/error") + + assert len(events) == int(expected_error) diff --git a/tests/integrations/threading/test_threading.py b/tests/integrations/threading/test_threading.py index 2b6b280c1e..0d14fae352 100644 --- a/tests/integrations/threading/test_threading.py +++ b/tests/integrations/threading/test_threading.py @@ -80,7 +80,7 @@ def test_propagates_threadpool_hub(sentry_init, capture_events, propagate_hub): events = capture_events() def double(number): - with sentry_sdk.start_span(op="task", description=str(number)): + with sentry_sdk.start_span(op="task", name=str(number)): return number * 2 with sentry_sdk.start_transaction(name="test_handles_threadpool"): diff --git a/tests/profiler/test_continuous_profiler.py b/tests/profiler/test_continuous_profiler.py index de647a6a45..1b96f27036 100644 --- a/tests/profiler/test_continuous_profiler.py +++ b/tests/profiler/test_continuous_profiler.py @@ -168,6 +168,7 @@ def assert_single_transaction_without_profile_chunks(envelopes): assert "profile" not in transaction["contexts"] +@pytest.mark.forked @pytest.mark.parametrize( "mode", [ diff --git a/tests/test_basics.py b/tests/test_basics.py index c9d80118c2..139f919a68 100644 --- a/tests/test_basics.py +++ b/tests/test_basics.py @@ -8,6 +8,7 @@ import pytest from sentry_sdk.client import Client +from sentry_sdk.utils import datetime_from_isoformat from tests.conftest import patch_start_tracing_child import sentry_sdk @@ -28,6 +29,7 @@ from sentry_sdk.integrations import ( _AUTO_ENABLING_INTEGRATIONS, _DEFAULT_INTEGRATIONS, + DidNotEnable, Integration, setup_integrations, ) @@ -39,18 +41,6 @@ from sentry_sdk.tracing_utils import has_tracing_enabled -def _redis_installed(): # type: () -> bool - """ - Determines whether Redis is installed. - """ - try: - import redis # noqa: F401 - except ImportError: - return False - - return True - - class NoOpIntegration(Integration): """ A simple no-op integration for testing purposes. @@ -89,20 +79,35 @@ def error_processor(event, exc_info): assert event["exception"]["values"][0]["value"] == "aha! whatever" +class ModuleImportErrorSimulator: + def __init__(self, modules, error_cls=DidNotEnable): + self.modules = modules + self.error_cls = error_cls + for sys_module in list(sys.modules.keys()): + if any(sys_module.startswith(module) for module in modules): + del sys.modules[sys_module] + + def find_spec(self, fullname, _path, _target=None): + if fullname in self.modules: + raise self.error_cls("Test import failure for %s" % fullname) + + def __enter__(self): + # WARNING: We need to be first to avoid pytest messing with local imports + sys.meta_path.insert(0, self) + + def __exit__(self, *_args): + sys.meta_path.remove(self) + + def test_auto_enabling_integrations_catches_import_error(sentry_init, caplog): caplog.set_level(logging.DEBUG) - redis_index = _AUTO_ENABLING_INTEGRATIONS.index( - "sentry_sdk.integrations.redis.RedisIntegration" - ) # noqa: N806 - sentry_init(auto_enabling_integrations=True, debug=True) + with ModuleImportErrorSimulator( + [i.rsplit(".", 1)[0] for i in _AUTO_ENABLING_INTEGRATIONS] + ): + sentry_init(auto_enabling_integrations=True, debug=True) for import_string in _AUTO_ENABLING_INTEGRATIONS: - # Ignore redis in the test case, because it does not raise a DidNotEnable - # exception on import; rather, it raises the exception upon enabling. - if _AUTO_ENABLING_INTEGRATIONS[redis_index] == import_string: - continue - assert any( record.message.startswith( "Did not import default integration {}:".format(import_string) @@ -397,11 +402,12 @@ def test_breadcrumbs(sentry_init, capture_events): def test_breadcrumb_ordering(sentry_init, capture_events): sentry_init() events = capture_events() + now = datetime.datetime.now(datetime.timezone.utc).replace(microsecond=0) timestamps = [ - datetime.datetime.now() - datetime.timedelta(days=10), - datetime.datetime.now() - datetime.timedelta(days=8), - datetime.datetime.now() - datetime.timedelta(days=12), + now - datetime.timedelta(days=10), + now - datetime.timedelta(days=8), + now - datetime.timedelta(days=12), ] for timestamp in timestamps: @@ -417,10 +423,48 @@ def test_breadcrumb_ordering(sentry_init, capture_events): assert len(event["breadcrumbs"]["values"]) == len(timestamps) timestamps_from_event = [ - datetime.datetime.strptime( - x["timestamp"].replace("Z", ""), "%Y-%m-%dT%H:%M:%S.%f" + datetime_from_isoformat(x["timestamp"]) for x in event["breadcrumbs"]["values"] + ] + assert timestamps_from_event == sorted(timestamps) + + +def test_breadcrumb_ordering_different_types(sentry_init, capture_events): + sentry_init() + events = capture_events() + now = datetime.datetime.now(datetime.timezone.utc) + + timestamps = [ + now - datetime.timedelta(days=10), + now - datetime.timedelta(days=8), + now.replace(microsecond=0) - datetime.timedelta(days=12), + now - datetime.timedelta(days=9), + now - datetime.timedelta(days=13), + now.replace(microsecond=0) - datetime.timedelta(days=11), + ] + + breadcrumb_timestamps = [ + timestamps[0], + timestamps[1].isoformat(), + datetime.datetime.strftime(timestamps[2], "%Y-%m-%dT%H:%M:%S") + "Z", + datetime.datetime.strftime(timestamps[3], "%Y-%m-%dT%H:%M:%S.%f") + "+00:00", + datetime.datetime.strftime(timestamps[4], "%Y-%m-%dT%H:%M:%S.%f") + "+0000", + datetime.datetime.strftime(timestamps[5], "%Y-%m-%dT%H:%M:%S.%f") + "-0000", + ] + + for i, timestamp in enumerate(timestamps): + add_breadcrumb( + message="Authenticated at %s" % timestamp, + category="auth", + level="info", + timestamp=breadcrumb_timestamps[i], ) - for x in event["breadcrumbs"]["values"] + + capture_exception(ValueError()) + (event,) = events + + assert len(event["breadcrumbs"]["values"]) == len(timestamps) + timestamps_from_event = [ + datetime_from_isoformat(x["timestamp"]) for x in event["breadcrumbs"]["values"] ] assert timestamps_from_event == sorted(timestamps) @@ -843,9 +887,9 @@ def test_functions_to_trace_with_class(sentry_init, capture_events): assert event["spans"][1]["description"] == "tests.test_basics.WorldGreeter.greet" -@pytest.mark.skipif(_redis_installed(), reason="skipping because redis is installed") def test_redis_disabled_when_not_installed(sentry_init): - sentry_init() + with ModuleImportErrorSimulator(["redis"], ImportError): + sentry_init() assert sentry_sdk.get_client().get_integration(RedisIntegration) is None diff --git a/tests/test_scrubber.py b/tests/test_scrubber.py index a544c31cc0..2c462153dd 100644 --- a/tests/test_scrubber.py +++ b/tests/test_scrubber.py @@ -146,7 +146,7 @@ def test_span_data_scrubbing(sentry_init, capture_events): events = capture_events() with start_transaction(name="hi"): - with start_span(op="foo", description="bar") as span: + with start_span(op="foo", name="bar") as span: span.set_data("password", "secret") span.set_data("datafoo", "databar") diff --git a/tests/test_tracing_utils.py b/tests/test_tracing_utils.py new file mode 100644 index 0000000000..239e631156 --- /dev/null +++ b/tests/test_tracing_utils.py @@ -0,0 +1,96 @@ +from dataclasses import asdict, dataclass +from typing import Optional, List + +from sentry_sdk.tracing_utils import _should_be_included +import pytest + + +def id_function(val): + # type: (object) -> str + if isinstance(val, ShouldBeIncludedTestCase): + return val.id + + +@dataclass(frozen=True) +class ShouldBeIncludedTestCase: + id: str + is_sentry_sdk_frame: bool + namespace: Optional[str] = None + in_app_include: Optional[List[str]] = None + in_app_exclude: Optional[List[str]] = None + abs_path: Optional[str] = None + project_root: Optional[str] = None + + +@pytest.mark.parametrize( + "test_case, expected", + [ + ( + ShouldBeIncludedTestCase( + id="Frame from Sentry SDK", + is_sentry_sdk_frame=True, + ), + False, + ), + ( + ShouldBeIncludedTestCase( + id="Frame from Django installed in virtualenv inside project root", + is_sentry_sdk_frame=False, + abs_path="/home/username/some_project/.venv/lib/python3.12/site-packages/django/db/models/sql/compiler", + project_root="/home/username/some_project", + namespace="django.db.models.sql.compiler", + in_app_include=["django"], + ), + True, + ), + ( + ShouldBeIncludedTestCase( + id="Frame from project", + is_sentry_sdk_frame=False, + abs_path="/home/username/some_project/some_project/__init__.py", + project_root="/home/username/some_project", + namespace="some_project", + ), + True, + ), + ( + ShouldBeIncludedTestCase( + id="Frame from project module in `in_app_exclude`", + is_sentry_sdk_frame=False, + abs_path="/home/username/some_project/some_project/exclude_me/some_module.py", + project_root="/home/username/some_project", + namespace="some_project.exclude_me.some_module", + in_app_exclude=["some_project.exclude_me"], + ), + False, + ), + ( + ShouldBeIncludedTestCase( + id="Frame from system-wide installed Django", + is_sentry_sdk_frame=False, + abs_path="/usr/lib/python3.12/site-packages/django/db/models/sql/compiler", + project_root="/home/username/some_project", + namespace="django.db.models.sql.compiler", + ), + False, + ), + ( + ShouldBeIncludedTestCase( + id="Frame from system-wide installed Django with `django` in `in_app_include`", + is_sentry_sdk_frame=False, + abs_path="/usr/lib/python3.12/site-packages/django/db/models/sql/compiler", + project_root="/home/username/some_project", + namespace="django.db.models.sql.compiler", + in_app_include=["django"], + ), + True, + ), + ], + ids=id_function, +) +def test_should_be_included(test_case, expected): + # type: (ShouldBeIncludedTestCase, bool) -> None + """Checking logic, see: https://github.com/getsentry/sentry-python/issues/3312""" + kwargs = asdict(test_case) + kwargs.pop("id") + assert _should_be_included(**kwargs) == expected diff --git a/tests/test_utils.py b/tests/test_utils.py index 4df343a357..c46cac7f9f 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -12,6 +12,7 @@ from sentry_sdk.utils import ( Components, Dsn, + datetime_from_isoformat, env_to_bool, format_timestamp, get_current_thread_meta, @@ -61,6 +62,55 @@ def _normalize_distribution_name(name): return re.sub(r"[-_.]+", "-", name).lower() +@pytest.mark.parametrize( + ("input_str", "expected_output"), + ( + ( + "2021-01-01T00:00:00.000000Z", + datetime(2021, 1, 1, tzinfo=timezone.utc), + ), # UTC time + ( + "2021-01-01T00:00:00.000000", + datetime(2021, 1, 1, tzinfo=datetime.now().astimezone().tzinfo), + ), # No TZ -- assume UTC + ( + "2021-01-01T00:00:00Z", + datetime(2021, 1, 1, tzinfo=timezone.utc), + ), # UTC - No milliseconds + ( + "2021-01-01T00:00:00.000000+00:00", + datetime(2021, 1, 1, tzinfo=timezone.utc), + ), + ( + "2021-01-01T00:00:00.000000-00:00", + datetime(2021, 1, 1, tzinfo=timezone.utc), + ), + ( + "2021-01-01T00:00:00.000000+0000", + datetime(2021, 1, 1, tzinfo=timezone.utc), + ), + ( + "2021-01-01T00:00:00.000000-0000", + datetime(2021, 1, 1, tzinfo=timezone.utc), + ), + ( + "2020-12-31T00:00:00.000000+02:00", + datetime(2020, 12, 31, tzinfo=timezone(timedelta(hours=2))), + ), # UTC+2 time + ( + "2020-12-31T00:00:00.000000-0200", + datetime(2020, 12, 31, tzinfo=timezone(timedelta(hours=-2))), + ), # UTC-2 time + ( + "2020-12-31T00:00:00-0200", + datetime(2020, 12, 31, tzinfo=timezone(timedelta(hours=-2))), + ), # UTC-2 time - no milliseconds + ), +) +def test_datetime_from_isoformat(input_str, expected_output): + assert datetime_from_isoformat(input_str) == expected_output, input_str + + @pytest.mark.parametrize( "env_var_value,strict,expected", [ diff --git a/tests/tracing/test_decorator.py b/tests/tracing/test_decorator.py index 584268fbdd..18a66bd43e 100644 --- a/tests/tracing/test_decorator.py +++ b/tests/tracing/test_decorator.py @@ -26,7 +26,7 @@ def test_trace_decorator(): result2 = start_child_span_decorator(my_example_function)() fake_start_child.assert_called_once_with( - op="function", description="test_decorator.my_example_function" + op="function", name="test_decorator.my_example_function" ) assert result2 == "return_of_sync_function" @@ -58,7 +58,7 @@ async def test_trace_decorator_async(): result2 = await start_child_span_decorator(my_async_example_function)() fake_start_child.assert_called_once_with( op="function", - description="test_decorator.my_async_example_function", + name="test_decorator.my_async_example_function", ) assert result2 == "return_of_async_function" diff --git a/tests/tracing/test_integration_tests.py b/tests/tracing/test_integration_tests.py index 47170af97b..e27dbea901 100644 --- a/tests/tracing/test_integration_tests.py +++ b/tests/tracing/test_integration_tests.py @@ -23,10 +23,10 @@ def test_basic(sentry_init, capture_events, sample_rate): with start_transaction(name="hi") as transaction: transaction.set_status(SPANSTATUS.OK) with pytest.raises(ZeroDivisionError): - with start_span(op="foo", description="foodesc"): + with start_span(op="foo", name="foodesc"): 1 / 0 - with start_span(op="bar", description="bardesc"): + with start_span(op="bar", name="bardesc"): pass if sample_rate: @@ -158,7 +158,7 @@ def test_dynamic_sampling_head_sdk_creates_dsc( assert baggage.third_party_items == "" with start_transaction(transaction): - with start_span(op="foo", description="foodesc"): + with start_span(op="foo", name="foodesc"): pass # finish will create a new baggage entry @@ -211,7 +211,7 @@ def test_memory_usage(sentry_init, capture_events, args, expected_refcount): with start_transaction(name="hi"): for i in range(100): - with start_span(op="helloworld", description="hi {}".format(i)) as span: + with start_span(op="helloworld", name="hi {}".format(i)) as span: def foo(): pass @@ -248,14 +248,14 @@ def capture_envelope(self, envelope): pass def capture_event(self, event): - start_span(op="toolate", description="justdont") + start_span(op="toolate", name="justdont") pass sentry_init(traces_sample_rate=1, transport=CustomTransport()) events = capture_events() with start_transaction(name="hi"): - with start_span(op="bar", description="bardesc"): + with start_span(op="bar", name="bardesc"): pass assert len(events) == 1 @@ -269,7 +269,7 @@ def test_trace_propagation_meta_head_sdk(sentry_init): span = None with start_transaction(transaction): - with start_span(op="foo", description="foodesc") as current_span: + with start_span(op="foo", name="foodesc") as current_span: span = current_span meta = sentry_sdk.get_current_scope().trace_propagation_meta() diff --git a/tests/tracing/test_misc.py b/tests/tracing/test_misc.py index 02966642fd..de2f782538 100644 --- a/tests/tracing/test_misc.py +++ b/tests/tracing/test_misc.py @@ -36,11 +36,6 @@ def test_transaction_naming(sentry_init, capture_events): sentry_init(traces_sample_rate=1.0) events = capture_events() - # only transactions have names - spans don't - with pytest.raises(TypeError): - start_span(name="foo") - assert len(events) == 0 - # default name in event if no name is passed with start_transaction() as transaction: pass diff --git a/tests/tracing/test_noop_span.py b/tests/tracing/test_noop_span.py index ec2c7782f3..36778cd485 100644 --- a/tests/tracing/test_noop_span.py +++ b/tests/tracing/test_noop_span.py @@ -23,7 +23,7 @@ def test_noop_start_transaction(sentry_init): def test_noop_start_span(sentry_init): sentry_init(instrumenter="otel") - with sentry_sdk.start_span(op="http", description="GET /") as span: + with sentry_sdk.start_span(op="http", name="GET /") as span: assert isinstance(span, NoOpSpan) assert sentry_sdk.get_current_scope().span is span diff --git a/tests/tracing/test_span_name.py b/tests/tracing/test_span_name.py new file mode 100644 index 0000000000..9c1768990a --- /dev/null +++ b/tests/tracing/test_span_name.py @@ -0,0 +1,59 @@ +import pytest + +import sentry_sdk + + +def test_start_span_description(sentry_init, capture_events): + sentry_init(traces_sample_rate=1.0) + events = capture_events() + + with sentry_sdk.start_transaction(name="hi"): + with pytest.deprecated_call(): + with sentry_sdk.start_span(op="foo", description="span-desc"): + ... + + (event,) = events + + assert event["spans"][0]["description"] == "span-desc" + + +def test_start_span_name(sentry_init, capture_events): + sentry_init(traces_sample_rate=1.0) + events = capture_events() + + with sentry_sdk.start_transaction(name="hi"): + with sentry_sdk.start_span(op="foo", name="span-name"): + ... + + (event,) = events + + assert event["spans"][0]["description"] == "span-name" + + +def test_start_child_description(sentry_init, capture_events): + sentry_init(traces_sample_rate=1.0) + events = capture_events() + + with sentry_sdk.start_transaction(name="hi"): + with pytest.deprecated_call(): + with sentry_sdk.start_span(op="foo", description="span-desc") as span: + with span.start_child(op="bar", description="child-desc"): + ... + + (event,) = events + + assert event["spans"][-1]["description"] == "child-desc" + + +def test_start_child_name(sentry_init, capture_events): + sentry_init(traces_sample_rate=1.0) + events = capture_events() + + with sentry_sdk.start_transaction(name="hi"): + with sentry_sdk.start_span(op="foo", name="span-name") as span: + with span.start_child(op="bar", name="child-name"): + ... + + (event,) = events + + assert event["spans"][-1]["description"] == "child-name" diff --git a/tests/tracing/test_span_origin.py b/tests/tracing/test_span_origin.py index f880279f08..16635871b3 100644 --- a/tests/tracing/test_span_origin.py +++ b/tests/tracing/test_span_origin.py @@ -6,7 +6,7 @@ def test_span_origin_manual(sentry_init, capture_events): events = capture_events() with start_transaction(name="hi"): - with start_span(op="foo", description="bar"): + with start_span(op="foo", name="bar"): pass (event,) = events @@ -21,11 +21,11 @@ def test_span_origin_custom(sentry_init, capture_events): events = capture_events() with start_transaction(name="hi"): - with start_span(op="foo", description="bar", origin="foo.foo2.foo3"): + with start_span(op="foo", name="bar", origin="foo.foo2.foo3"): pass with start_transaction(name="ho", origin="ho.ho2.ho3"): - with start_span(op="baz", description="qux", origin="baz.baz2.baz3"): + with start_span(op="baz", name="qux", origin="baz.baz2.baz3"): pass (first_transaction, second_transaction) = events diff --git a/tox.ini b/tox.ini index 9c0092d7ba..2f351d7e5a 100644 --- a/tox.ini +++ b/tox.ini @@ -30,7 +30,7 @@ envlist = # AIOHTTP {py3.7}-aiohttp-v{3.4} {py3.7,py3.9,py3.11}-aiohttp-v{3.8} - {py3.8,py3.11,py3.12}-aiohttp-latest + {py3.8,py3.12,py3.13}-aiohttp-latest # Anthropic {py3.7,py3.11,py3.12}-anthropic-v{0.16,0.25} @@ -38,14 +38,14 @@ envlist = # Ariadne {py3.8,py3.11}-ariadne-v{0.20} - {py3.8,py3.11,py3.12}-ariadne-latest + {py3.8,py3.12,py3.13}-ariadne-latest # Arq {py3.7,py3.11}-arq-v{0.23} - {py3.7,py3.11,py3.12}-arq-latest + {py3.7,py3.12,py3.13}-arq-latest # Asgi - {py3.7,py3.11,py3.12}-asgi + {py3.7,py3.12,py3.13}-asgi # asyncpg {py3.7,py3.10}-asyncpg-v{0.23} @@ -65,29 +65,29 @@ envlist = {py3.6,py3.7}-boto3-v{1.12} {py3.7,py3.11,py3.12}-boto3-v{1.23} {py3.11,py3.12}-boto3-v{1.34} - {py3.11,py3.12}-boto3-latest + {py3.11,py3.12,py3.13}-boto3-latest # Bottle {py3.6,py3.9}-bottle-v{0.12} - {py3.6,py3.11,py3.12}-bottle-latest + {py3.6,py3.12,py3.13}-bottle-latest # Celery {py3.6,py3.8}-celery-v{4} {py3.6,py3.8}-celery-v{5.0} {py3.7,py3.10}-celery-v{5.1,5.2} {py3.8,py3.11,py3.12}-celery-v{5.3,5.4} - {py3.8,py3.11,py3.12}-celery-latest + {py3.8,py3.12,py3.13}-celery-latest # Chalice {py3.6,py3.9}-chalice-v{1.16} - {py3.8,py3.12}-chalice-latest + {py3.8,py3.12,py3.13}-chalice-latest # Clickhouse Driver {py3.8,py3.11}-clickhouse_driver-v{0.2.0} - {py3.8,py3.11,py3.12}-clickhouse_driver-latest + {py3.8,py3.12,py3.13}-clickhouse_driver-latest # Cloud Resource Context - {py3.6,py3.11,py3.12}-cloud_resource_context + {py3.6,py3.12,py3.13}-cloud_resource_context # Cohere {py3.9,py3.11,py3.12}-cohere-v5 @@ -106,7 +106,7 @@ envlist = {py3.8,py3.11,py3.12}-django-v{4.0,4.1,4.2} # - Django 5.x {py3.10,py3.11,py3.12}-django-v{5.0,5.1} - {py3.10,py3.11,py3.12}-django-latest + {py3.10,py3.12,py3.13}-django-latest # dramatiq {py3.6,py3.9}-dramatiq-v{1.13} @@ -121,24 +121,24 @@ envlist = # FastAPI {py3.7,py3.10}-fastapi-v{0.79} - {py3.8,py3.11,py3.12}-fastapi-latest + {py3.8,py3.12,py3.13}-fastapi-latest # Flask {py3.6,py3.8}-flask-v{1} {py3.8,py3.11,py3.12}-flask-v{2} {py3.10,py3.11,py3.12}-flask-v{3} - {py3.10,py3.11,py3.12}-flask-latest + {py3.10,py3.12,py3.13}-flask-latest # GCP {py3.7}-gcp # GQL {py3.7,py3.11}-gql-v{3.4} - {py3.7,py3.11,py3.12}-gql-latest + {py3.7,py3.12,py3.13}-gql-latest # Graphene {py3.7,py3.11}-graphene-v{3.3} - {py3.7,py3.11,py3.12}-graphene-latest + {py3.7,py3.12,py3.13}-graphene-latest # gRPC {py3.7,py3.9}-grpc-v{1.39} @@ -151,14 +151,15 @@ envlist = {py3.6,py3.10}-httpx-v{0.20,0.22} {py3.7,py3.11,py3.12}-httpx-v{0.23,0.24} {py3.9,py3.11,py3.12}-httpx-v{0.25,0.27} - {py3.9,py3.11,py3.12}-httpx-latest + {py3.9,py3.12,py3.13}-httpx-latest # Huey {py3.6,py3.11,py3.12}-huey-v{2.0} - {py3.6,py3.11,py3.12}-huey-latest + {py3.6,py3.12,py3.13}-huey-latest # Huggingface Hub - {py3.9,py3.11,py3.12}-huggingface_hub-{v0.22,latest} + {py3.9,py3.12,py3.13}-huggingface_hub-{v0.22} + {py3.9,py3.12,py3.13}-huggingface_hub-latest # Langchain {py3.9,py3.11,py3.12}-langchain-v0.1 @@ -175,7 +176,7 @@ envlist = # Loguru {py3.6,py3.11,py3.12}-loguru-v{0.5} - {py3.6,py3.11,py3.12}-loguru-latest + {py3.6,py3.12,py3.13}-loguru-latest # OpenAI {py3.9,py3.11,py3.12}-openai-v1 @@ -183,21 +184,20 @@ envlist = {py3.9,py3.11,py3.12}-openai-notiktoken # OpenTelemetry (OTel) - {py3.7,py3.9,py3.11,py3.12}-opentelemetry + {py3.7,py3.9,py3.12,py3.13}-opentelemetry # OpenTelemetry Experimental (POTel) - # XXX add 3.12 when officially supported - {py3.8,py3.9,py3.10,py3.11}-potel + {py3.8,py3.9,py3.10,py3.11,py3.12,py3.13}-potel # pure_eval - {py3.6,py3.11,py3.12}-pure_eval + {py3.6,py3.12,py3.13}-pure_eval # PyMongo (Mongo DB) {py3.6}-pymongo-v{3.1} {py3.6,py3.9}-pymongo-v{3.12} {py3.6,py3.11}-pymongo-v{4.0} {py3.7,py3.11,py3.12}-pymongo-v{4.3,4.7} - {py3.7,py3.11,py3.12}-pymongo-latest + {py3.7,py3.12,py3.13}-pymongo-latest # Pyramid {py3.6,py3.11}-pyramid-v{1.6} @@ -208,7 +208,7 @@ envlist = # Quart {py3.7,py3.11}-quart-v{0.16} {py3.8,py3.11,py3.12}-quart-v{0.19} - {py3.8,py3.11,py3.12}-quart-latest + {py3.8,py3.12,py3.13}-quart-latest # Ray {py3.10,py3.11}-ray-v{2.34} @@ -218,28 +218,28 @@ envlist = {py3.6,py3.8}-redis-v{3} {py3.7,py3.8,py3.11}-redis-v{4} {py3.7,py3.11,py3.12}-redis-v{5} - {py3.7,py3.11,py3.12}-redis-latest + {py3.7,py3.12,py3.13}-redis-latest # Redis Cluster {py3.6,py3.8}-redis_py_cluster_legacy-v{1,2} # no -latest, not developed anymore # Requests - {py3.6,py3.8,py3.11,py3.12}-requests + {py3.6,py3.8,py3.12,py3.13}-requests # RQ (Redis Queue) {py3.6}-rq-v{0.6} {py3.6,py3.9}-rq-v{0.13,1.0} {py3.6,py3.11}-rq-v{1.5,1.10} {py3.7,py3.11,py3.12}-rq-v{1.15,1.16} - {py3.7,py3.11,py3.12}-rq-latest + {py3.7,py3.12,py3.13}-rq-latest # Sanic {py3.6,py3.7}-sanic-v{0.8} {py3.6,py3.8}-sanic-v{20} {py3.7,py3.11}-sanic-v{22} {py3.7,py3.11}-sanic-v{23} - {py3.8,py3.11}-sanic-latest + {py3.8,py3.11,py3.12}-sanic-latest # Spark {py3.8,py3.10,py3.11}-spark-v{3.1,3.3,3.5} @@ -249,7 +249,7 @@ envlist = {py3.7,py3.10}-starlette-v{0.19} {py3.7,py3.11}-starlette-v{0.20,0.24,0.28} {py3.8,py3.11,py3.12}-starlette-v{0.32,0.36} - {py3.8,py3.11,py3.12}-starlette-latest + {py3.8,py3.12,py3.13}-starlette-latest # Starlite {py3.8,py3.11}-starlite-v{1.48,1.51} @@ -258,12 +258,12 @@ envlist = # SQL Alchemy {py3.6,py3.9}-sqlalchemy-v{1.2,1.4} {py3.7,py3.11}-sqlalchemy-v{2.0} - {py3.7,py3.11,py3.12}-sqlalchemy-latest + {py3.7,py3.12,py3.13}-sqlalchemy-latest # Strawberry {py3.8,py3.11}-strawberry-v{0.209} {py3.8,py3.11,py3.12}-strawberry-v{0.222} - {py3.8,py3.11,py3.12}-strawberry-latest + {py3.8,py3.12,py3.13}-strawberry-latest # Tornado {py3.8,py3.11,py3.12}-tornado-v{6.0} @@ -275,7 +275,7 @@ envlist = {py3.6,py3.8}-trytond-v{5} {py3.6,py3.11}-trytond-v{6} {py3.8,py3.11,py3.12}-trytond-v{7} - {py3.8,py3.11,py3.12}-trytond-latest + {py3.8,py3.12,py3.13}-trytond-latest [testenv] deps = @@ -371,7 +371,7 @@ deps = celery-v5.4: Celery~=5.4.0 celery-latest: Celery - {py3.6,py3.7,py3.8,py3.9,py3.10,py3.11,py3.12}-celery: newrelic + celery: newrelic celery: pytest<7 {py3.7}-celery: importlib-metadata<5.0 @@ -560,10 +560,6 @@ deps = pyramid-v2.0: pyramid~=2.0.0 pyramid-latest: pyramid - # Ray - ray-v2.34: ray~=2.34.0 - ray-latest: ray - # Quart quart: quart-auth quart: pytest-asyncio @@ -576,6 +572,10 @@ deps = quart-v0.19: quart~=0.19.0 quart-latest: quart + # Ray + ray-v2.34: ray~=2.34.0 + ray-latest: ray + # Redis redis: fakeredis!=1.7.4 redis: pytest<8.0.0