+
+
+## Removed
+
+- Removed support for Python 2 and Python 3.5. The SDK now requires at least Python 3.6.
+- Removed support for Celery 3.\*.
+- Removed support for Django 1.8, 1.9, 1.10.
+- Removed support for Flask 0.\*.
+- Removed support for gRPC < 1.39.
+- Removed support for Tornado < 6.
+- Removed support for sending events to the `/store` endpoint. Everything is now sent to the `/envelope` endpoint. If you're on SaaS you don't have to worry about this, but if you're running Sentry yourself you'll need version `20.6.0` or higher of self-hosted Sentry.
+- The deprecated `with_locals` configuration option was removed. Use `include_local_variables` instead. See https://docs.sentry.io/platforms/python/configuration/options/#include-local-variables.
+- The deprecated `request_bodies` configuration option was removed. Use `max_request_body_size`. See https://docs.sentry.io/platforms/python/configuration/options/#max-request-body-size.
+- Removed support for `user.segment`. It was also removed from the trace header as well as from the dynamic sampling context.
+- Removed support for the `install` method for custom integrations. Please use `setup_once` instead.
+- Removed `sentry_sdk.tracing.Span.new_span`. Use `sentry_sdk.tracing.Span.start_child` instead.
+- Removed `sentry_sdk.tracing.Transaction.new_span`. Use `sentry_sdk.tracing.Transaction.start_child` instead.
+- Removed support for creating transactions via `sentry_sdk.tracing.Span(transaction=...)`. To create a transaction, please use `sentry_sdk.tracing.Transaction(name=...)`.
+- Removed `sentry_sdk.utils.Auth.store_api_url`.
+- `sentry_sdk.utils.Auth.get_api_url`'s now accepts a `sentry_sdk.consts.EndpointType` enum instead of a string as its only parameter. We recommend omitting this argument when calling the function, since the parameter's default value is the only possible `sentry_sdk.consts.EndpointType` value. The parameter exists for future compatibility.
+- Removed `tracing_utils_py2.py`. The `start_child_span_decorator` is now in `sentry_sdk.tracing_utils`.
+- Removed the `sentry_sdk.profiler.Scheduler.stop_profiling` method. Any calls to this method can simply be removed, since this was a no-op method.
+- Removed the experimental `metrics_summary_sample_rate` config option.
+- Removed the experimental `should_summarize_metric` config option.
+
+## Deprecated
+
+- Using the `Hub` directly as well as using hub-based APIs has been deprecated. Where available, use [the top-level API instead](sentry_sdk/api.py); otherwise use the [scope API](sentry_sdk/scope.py) or the [client API](sentry_sdk/client.py).
+
+ Before:
+
+ ```python
+ with hub.start_span(...):
+ # do something
+ ```
+
+ After:
+
+ ```python
+ import sentry_sdk
+
+ with sentry_sdk.start_span(...):
+ # do something
+ ```
+
+- Hub cloning is deprecated.
+
+ Before:
+
+ ```python
+ with Hub(Hub.current) as hub:
+ # do something with the cloned hub
+ ```
+
+ After:
+
+ ```python
+ import sentry_sdk
+
+ with sentry_sdk.isolation_scope() as scope:
+ # do something with the forked scope
+ ```
+
+- `configure_scope` is deprecated. Modify the current or isolation scope directly instead.
+
+ Before:
+
+ ```python
+ with configure_scope() as scope:
+ # do something with `scope`
+ ```
+
+ After:
+
+ ```python
+ from sentry_sdk import get_current_scope
+
+ scope = get_current_scope()
+ # do something with `scope`
+ ```
+
+ Or:
+
+ ```python
+ from sentry_sdk import get_isolation_scope
+
+ scope = get_isolation_scope()
+ # do something with `scope`
+ ```
+
+ When to use `get_current_scope()` and `get_isolation_scope()` depends on how long the change to the scope should be in effect. If you want the changed scope to affect the whole request-response cycle or the whole execution of task, use the isolation scope. If it's more localized, use the current scope.
+
+- `push_scope` is deprecated. Fork the current or the isolation scope instead.
+
+ Before:
+
+ ```python
+ with push_scope() as scope:
+ # do something with `scope`
+ ```
+
+ After:
+
+ ```python
+ import sentry_sdk
+
+ with sentry_sdk.new_scope() as scope:
+ # do something with `scope`
+ ```
+
+ Or:
+
+ ```python
+ import sentry_sdk
+
+ with sentry_sdk.isolation_scope() as scope:
+ # do something with `scope`
+ ```
+
+ `new_scope()` will fork the current scope, while `isolation_scope()` will fork the isolation scope. The lifecycle of a single isolation scope roughly translates to the lifecycle of a transaction in most cases, so if you're looking to create a new separated scope for a whole request-response cycle or task execution, go for `isolation_scope()`. If you want to wrap a smaller unit code, fork the current scope instead with `new_scope()`.
+
+- Accessing the client via the hub has been deprecated. Use the top-level `sentry_sdk.get_client()` to get the current client.
+- `profiler_mode` and `profiles_sample_rate` have been deprecated as `_experiments` options. Use them as top level options instead:
+ ```python
+ sentry_sdk.init(
+ ...,
+ profiler_mode="thread",
+ profiles_sample_rate=1.0,
+ )
+ ```
+- Deprecated `sentry_sdk.transport.Transport.capture_event`. Please use `sentry_sdk.transport.Transport.capture_envelope`, instead.
+- Passing a function to `sentry_sdk.init`'s `transport` keyword argument has been deprecated. If you wish to provide a custom transport, please pass a `sentry_sdk.transport.Transport` instance or a subclass.
+- The parameter `propagate_hub` in `ThreadingIntegration()` was deprecated and renamed to `propagate_scope`.
diff --git a/Makefile b/Makefile
index 32cdbb1fff..fb5900e5ea 100644
--- a/Makefile
+++ b/Makefile
@@ -5,17 +5,15 @@ VENV_PATH = .venv
help:
@echo "Thanks for your interest in the Sentry Python SDK!"
@echo
- @echo "make lint: Run linters"
- @echo "make test: Run basic tests (not testing most integrations)"
- @echo "make test-all: Run ALL tests (slow, closest to CI)"
- @echo "make format: Run code formatters (destructive)"
+ @echo "make apidocs: Build the API documentation"
@echo "make aws-lambda-layer: Build AWS Lambda layer directory for serverless integration"
@echo
@echo "Also make sure to read ./CONTRIBUTING.md"
+ @echo
@false
.venv:
- virtualenv -ppython3 $(VENV_PATH)
+ python -m venv $(VENV_PATH)
$(VENV_PATH)/bin/pip install tox
dist: .venv
@@ -24,42 +22,14 @@ dist: .venv
$(VENV_PATH)/bin/python setup.py sdist bdist_wheel
.PHONY: dist
-format: .venv
- $(VENV_PATH)/bin/tox -e linters --notest
- .tox/linters/bin/black .
-.PHONY: format
-
-test: .venv
- @$(VENV_PATH)/bin/tox -e py3.9
-.PHONY: test
-
-test-all: .venv
- @TOXPATH=$(VENV_PATH)/bin/tox sh ./scripts/runtox.sh
-.PHONY: test-all
-
-check: lint test
-.PHONY: check
-
-lint: .venv
- @set -e && $(VENV_PATH)/bin/tox -e linters || ( \
- echo "================================"; \
- echo "Bad formatting? Run: make format"; \
- echo "================================"; \
- false)
-.PHONY: lint
-
apidocs: .venv
@$(VENV_PATH)/bin/pip install --editable .
- @$(VENV_PATH)/bin/pip install -U -r ./docs-requirements.txt
+ @$(VENV_PATH)/bin/pip install -U -r ./requirements-docs.txt
+ rm -rf docs/_build
@$(VENV_PATH)/bin/sphinx-build -vv -W -b html docs/ docs/_build
.PHONY: apidocs
-apidocs-hotfix: apidocs
- @$(VENV_PATH)/bin/pip install ghp-import
- @$(VENV_PATH)/bin/ghp-import -pf docs/_build
-.PHONY: apidocs-hotfix
-
aws-lambda-layer: dist
- $(VENV_PATH)/bin/pip install -r aws-lambda-layer-requirements.txt
+ $(VENV_PATH)/bin/pip install -r requirements-aws-lambda-layer.txt
$(VENV_PATH)/bin/python -m scripts.build_aws_lambda_layer
.PHONY: aws-lambda-layer
diff --git a/README.md b/README.md
index e9d661eee8..a3afdc6e72 100644
--- a/README.md
+++ b/README.md
@@ -1,103 +1,125 @@
-Show table
+ + | Class | Abstract methods | + | ------------------------------------- | -------------------------------------- | + | `sentry_sdk.integrations.Integration` | `setup_once` | + | `sentry_sdk.metrics.Metric` | `add`, `serialize_value`, and `weight` | + | `sentry_sdk.profiler.Scheduler` | `setup` and `teardown` | + | `sentry_sdk.transport.Transport` | `capture_envelope` | + +
-
- 
-
-
+
+
+
+_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us
+[**Check out our open positions**](https://sentry.io/careers/)_.
+
+[](https://discord.com/invite/Ww9hbqr)
+[](https://twitter.com/intent/follow?screen_name=getsentry)
+[](https://pypi.python.org/pypi/sentry-sdk)
+
+[](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml)
+
+
+ +
-_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [**Check out our open positions**](https://sentry.io/careers/)_
# Official Sentry SDK for Python
-[](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml)
-[](https://pypi.python.org/pypi/sentry-sdk)
-[](https://discord.gg/cWnMQeA)
+Welcome to the official Python SDK for **[Sentry](http://sentry.io/)**.
+
-This is the official Python SDK for [Sentry](http://sentry.io/)
+## 📦 Getting Started
----
+### Prerequisites
-## Getting Started
+You need a Sentry [account](https://sentry.io/signup/) and [project](https://docs.sentry.io/product/projects/).
-### Install
+### Installation
+
+Getting Sentry into your project is straightforward. Just run this command in your terminal:
```bash
pip install --upgrade sentry-sdk
```
-### Configuration
+### Basic Configuration
+
+Here's a quick configuration example to get Sentry up and running:
```python
import sentry_sdk
sentry_sdk.init(
- "https://12927b5f211046b575ee51fd8b1ac34f@o1.ingest.sentry.io/1",
+ "https://12927b5f211046b575ee51fd8b1ac34f@o1.ingest.sentry.io/1", # Your DSN here
# Set traces_sample_rate to 1.0 to capture 100%
- # of transactions for performance monitoring.
+ # of traces for performance monitoring.
traces_sample_rate=1.0,
)
```
-### Usage
+With this configuration, Sentry will monitor for exceptions and performance issues.
+
+### Quick Usage Example
+
+To generate some events that will show up in Sentry, you can log messages or capture errors:
```python
-from sentry_sdk import capture_message
-capture_message("Hello World") # Will create an event in Sentry.
+import sentry_sdk
+sentry_sdk.init(...) # same as above
-raise ValueError() # Will also create an event in Sentry.
+sentry_sdk.capture_message("Hello Sentry!") # You'll see this in your Sentry dashboard.
+
+raise ValueError("Oops, something went wrong!") # This will create an error event in Sentry.
```
-- To learn more about how to use the SDK [refer to our docs](https://docs.sentry.io/platforms/python/).
-- Are you coming from `raven-python`? [Use this migration guide](https://docs.sentry.io/platforms/python/migration/).
-- To learn about internals use the [API Reference](https://getsentry.github.io/sentry-python/).
-## Integrations
+## 📚 Documentation
+
+For more details on advanced usage, integrations, and customization, check out the full documentation on [https://docs.sentry.io](https://docs.sentry.io/).
+
+
+## 🧩 Integrations
+
+Sentry integrates with a ton of popular Python libraries and frameworks, including [FastAPI](https://docs.sentry.io/platforms/python/integrations/fastapi/), [Django](https://docs.sentry.io/platforms/python/integrations/django/), [Celery](https://docs.sentry.io/platforms/python/integrations/celery/), [OpenAI](https://docs.sentry.io/platforms/python/integrations/openai/) and many, many more. Check out the [full list of integrations](https://docs.sentry.io/platforms/python/integrations/) to get the full picture.
+
+
+## 🚧 Migrating Between Versions?
+
+### From `1.x` to `2.x`
+
+If you're using the older `1.x` version of the SDK, now's the time to upgrade to `2.x`. It includes significant upgrades and new features. Check our [migration guide](https://docs.sentry.io/platforms/python/migration/1.x-to-2.x) for assistance.
+
+### From `raven-python`
+
+Using the legacy `raven-python` client? It's now in maintenance mode, and we recommend migrating to the new SDK for an improved experience. Get all the details in our [migration guide](https://docs.sentry.io/platforms/python/migration/raven-to-sentry-sdk/).
+
+
+## 🙌 Want to Contribute?
-(If you want to create a new integration, have a look at the [Adding a new integration checklist](https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md#adding-a-new-integration).)
+We'd love your help in improving the Sentry SDK! Whether it's fixing bugs, adding features, writing new integrations, or enhancing documentation, every contribution is valuable.
-See [the documentation](https://docs.sentry.io/platforms/python/integrations/) for an up-to-date list of libraries and frameworks we support. Here are some examples:
+For details on how to contribute, please read our [contribution guide](CONTRIBUTING.md) and explore the [open issues](https://github.com/getsentry/sentry-python/issues).
-- [Django](https://docs.sentry.io/platforms/python/integrations/django/)
-- [Flask](https://docs.sentry.io/platforms/python/integrations/flask/)
-- [FastAPI](https://docs.sentry.io/platforms/python/integrations/fastapi/)
-- [AIOHTTP](https://docs.sentry.io/platforms/python/integrations/aiohttp/)
-- [SQLAlchemy](https://docs.sentry.io/platforms/python/integrations/sqlalchemy/)
-- [asyncpg](https://docs.sentry.io/platforms/python/integrations/asyncpg/)
-- [Redis](https://docs.sentry.io/platforms/python/integrations/redis/)
-- [Celery](https://docs.sentry.io/platforms/python/integrations/celery/)
-- [Apache Airflow](https://docs.sentry.io/platforms/python/integrations/airflow/)
-- [Apache Spark](https://docs.sentry.io/platforms/python/integrations/pyspark/)
-- [asyncio](https://docs.sentry.io/platforms/python/integrations/asyncio/)
-- [Graphene](https://docs.sentry.io/platforms/python/integrations/graphene/)
-- [Logging](https://docs.sentry.io/platforms/python/integrations/logging/)
-- [Loguru](https://docs.sentry.io/platforms/python/integrations/loguru/)
-- [HTTPX](https://docs.sentry.io/platforms/python/integrations/httpx/)
-- [AWS Lambda](https://docs.sentry.io/platforms/python/integrations/aws-lambda/)
-- [Google Cloud Functions](https://docs.sentry.io/platforms/python/integrations/gcp-functions/)
+## 🛟 Need Help?
-## Migrating From `raven-python`
+If you encounter issues or need help setting up or configuring the SDK, don't hesitate to reach out to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people there ready to help!
-The old `raven-python` client has entered maintenance mode and was moved [here](https://github.com/getsentry/raven-python).
-If you're using `raven-python`, we recommend you to migrate to this new SDK. You can find the benefits of migrating and how to do it in our [migration guide](https://docs.sentry.io/platforms/python/migration/).
+## 🔗 Resources
-## Contributing to the SDK
+Here are all resources to help you make the most of Sentry:
-Please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
+- [Documentation](https://docs.sentry.io/platforms/python/) - Official documentation to get started.
+- [Discord](https://discord.com/invite/Ww9hbqr) - Join our Discord community.
+- [X/Twitter](https://twitter.com/intent/follow?screen_name=getsentry) - Follow us on X (Twitter) for updates.
+- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry) - Questions and answers related to Sentry.
-## Getting Help/Support
+
+## 📃 License
-If you need help setting up or configuring the Python SDK (or anything else in the Sentry universe) please head over to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!
+The SDK is open-source and available under the MIT license. Check out the [LICENSE](LICENSE) file for more information.
-## Resources
-- [](https://docs.sentry.io/quickstart/)
-- [](https://forum.sentry.io/c/sdks)
-- [](https://discord.gg/Ww9hbqr)
-- [](http://stackoverflow.com/questions/tagged/sentry)
-- [](https://twitter.com/intent/follow?screen_name=getsentry)
+## 😘 Contributors
-## License
+Thanks to everyone who has helped improve the SDK!
-Licensed under the MIT license, see [`LICENSE`](LICENSE)
+
+
+[](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml)
+
++ +