Skip to content

Auto-enable Starlette and FastAPI#1533

Merged
antonpirker merged 31 commits intomasterfrom
antonpirker/1531-auto-enable-starlette-fastapi
Aug 31, 2022
Merged

Auto-enable Starlette and FastAPI#1533
antonpirker merged 31 commits intomasterfrom
antonpirker/1531-auto-enable-starlette-fastapi

Conversation

@antonpirker
Copy link
Copy Markdown
Contributor

@antonpirker antonpirker commented Aug 2, 2022

The integrations for Starlette and FastAPI should be auto enabled.
This is for easier installation of the Sentry SDK. The SDK will detect if Starlette and/or FastAPI is installed and then the integrations are enabled automatically.

Fixes #1531

antonpirker added 22 commits July 28, 2022 10:17
@antonpirker
Fixed patching of middlewares to fix the 'coroutine' error for non ex…
36844d6 
…istent routes.

refs #1514
@antonpirker
Only capture server errors
9b8c99e
@antonpirker
Fixed form POST in FastApiIntegration.
f1ea0e0
@antonpirker
Fixed form uploads on starlette projects
c8f2466
@antonpirker
Fixed typing
30fb5da
@antonpirker
Enable patching of middlewares again.
91f8dc5
@antonpirker
Fixed typing
2997550
@antonpirker
Merge branch 'master' into antonpirker/1514-fastapi-bugs
773cf5c
@antonpirker
Auto enable Starlette/FastAPI
ed10d5e
@antonpirker
Merge branch 'master' into antonpirker/1514-fastapi-bugs
e4600fc
@antonpirker
Merge branch 'master' into antonpirker/1514-fastapi-bugs
8b85080
@antonpirker
Cleanup useless code
b11f20b
@antonpirker
Fixed error while handling 404 errors.
7eebd53
@antonpirker
Fix error during handling of form validation error.
423a221
@antonpirker
Find the correct handler (for classes with parent classes
36ea140
@antonpirker
Merge branch 'antonpirker/1514-fastapi-bugs' of github.com:getsentry/…
1b6eb7a 
…sentry-python into antonpirker/1514-fastapi-bugs
@antonpirker
Merge branch 'master' into antonpirker/1514-fastapi-bugs
0709979
@antonpirker
Fixed linting
8176cb2
@antonpirker
Do not call starlette integration, because it needs to be set in the …
2552a61 
…init()
@antonpirker
Auto enable Starlette/FastAPI
35d4035
@antonpirker
Merge branch 'antonpirker/1531-auto-enable-starlette-fastapi' of gith…
73394b0 
…ub.com:getsentry/sentry-python into antonpirker/1531-auto-enable-starlette-fastapi
@antonpirker
Fail with a nice error message when ASGI middleware is used and Starl…
cc4b9fc 
…ette or FastAPI was auto enabled.
@sl0thentr0py
Copy link
Copy Markdown
Member

sl0thentr0py commented Aug 5, 2022

making this a draft since we should wait with shipping this

@sl0thentr0py sl0thentr0py marked this pull request as draft August 5, 2022 12:31
@antonpirker
Copy link
Copy Markdown
Contributor Author

antonpirker commented Aug 5, 2022

In case that the ASGIMiddleware is used when also the integrations are auto enabled I now output an error message during startup: The Python SDK can now automatically support ASGI frameworks like Starlette and FastAPI. Please remove 'SentryAsgiMiddleware' from your project. See https://docs.sentry.io/platforms/python/guides/asgi/ for more information.

There is also a PR to improve the linked documentation: getsentry/sentry-docs#5390

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 27, 2022

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@antonpirker antonpirker marked this pull request as ready for review August 30, 2022 13:27
@antonpirker
Better check for using asgi middleware and starlette/fastapi integrat…
a41b1b4 
…ion at the same time.
@antonpirker
Merge branch 'antonpirker/1531-auto-enable-starlette-fastapi' of gith…
33f9083 
…ub.com:getsentry/sentry-python into antonpirker/1531-auto-enable-starlette-fastapi
sl0thentr0py
sl0thentr0py approved these changes Aug 30, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@sl0thentr0py sl0thentr0py left a comment

Choose a reason for hiding this comment

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

:shipit:

@antonpirker antonpirker merged commit 1f9f999 into master Aug 31, 2022
@antonpirker antonpirker deleted the antonpirker/1531-auto-enable-starlette-fastapi branch August 31, 2022 12:58
@antonpirker antonpirker restored the antonpirker/1531-auto-enable-starlette-fastapi branch August 31, 2022 13:05
@ps-george
Copy link
Copy Markdown

ps-george commented Nov 1, 2022

This integration is causing us issues and we'd like to turn off the starlette/fastapi sentry integration, is there a way to disable this auto-enable behaviour?

@antonpirker
Copy link
Copy Markdown
Contributor Author

antonpirker commented Nov 7, 2022

Hey @ps-george !

First: What kind of issues are the auto-enabling starlette/fastapi integrations causing you, can you elaborate?

About your question: There is a option for sentry_sdk.init() that is called auto_enabling_integrations. If you set this to "False" the auto enabling integrations will NOT be loaded.
See here in the code what auto enabling integrations exist:
https://github.com/getsentry/sentry-python/blob/master/sentry_sdk/integrations/__init__.py#L54-L86

You can then add some of those auto enabling integrations with the integrations option: https://docs.sentry.io/platforms/python/configuration/options/#integrations (in case you just want to enable some of them but not all)

hth

@ckcr4lyf
Copy link
Copy Markdown

ckcr4lyf commented Nov 30, 2022

This integration is causing us issues and we'd like to turn off the starlette/fastapi sentry integration, is there a way to disable this auto-enable behaviour?

RE @ps-george , we are seeing something similar:

Traceback (most recent call last):
  File "/poetry/lib/python3.10/site-packages/google/cloud/pubsub_v1/subscriber/_protocol/streaming_pull_manager.py", line 126, in _wrap_callback_errors
    callback(message)
  File "/app/main.py", line 200, in callbackWithTracer
    return callback(message)
  File "/app/main.py", line 35, in callback
    sentry_sdk.init(config["SENTRY_DSN"])
  File "/poetry/lib/python3.10/site-packages/sentry_sdk/hub.py", line 119, in _init
    client = Client(*args, **kwargs)  # type: ignore
  File "/poetry/lib/python3.10/site-packages/sentry_sdk/client.py", line 102, in __init__
    self._init_impl()
  File "/poetry/lib/python3.10/site-packages/sentry_sdk/client.py", line 136, in _init_impl
    self.integrations = setup_integrations(
  File "/poetry/lib/python3.10/site-packages/sentry_sdk/integrations/__init__.py", line 109, in setup_integrations
    for integration_cls in iter_default_integrations(
  File "/poetry/lib/python3.10/site-packages/sentry_sdk/integrations/__init__.py", line 41, in iter_default_integrations
    yield getattr(import_module(module), cls)
  File "/usr/lib/python3.10/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 883, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/poetry/lib/python3.10/site-packages/sentry_sdk/integrations/fastapi.py", line 4, in <module>
    from sentry_sdk.integrations.starlette import (
ImportError: cannot import name 'StarletteIntegration' from 'sentry_sdk.integrations.starlette' (/poetry/lib/python3.10/site-packages/sentry_sdk/integrations/starlette.py)

Seems related to #1603 and the order of imporing perhaps? Since the errir seems to come from the fastapi "detection", rather than starlette detection.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sl0thentr0py sl0thentr0py sl0thentr0py approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Auto-enable Starlette and FastAPI integrations

4 participants

@antonpirker @sl0thentr0py @ps-george @ckcr4lyf