HTTPX
Learn about the HTTPX integration and how it adds support for the HTTPX HTTP client.
The HTTPX integration instruments outgoing HTTP requests using either the sync or the async HTTPX clients.
Use this integration to create spans for outgoing requests and ensure traces are properly propagated to downstream services.
Install
Install sentry-sdk from PyPI with the httpx extra.
Copied
pip install "sentry-sdk[httpx]"
Configure
The HTTPX integration is enabled automatically if you have the httpx package installed.
Copied
import sentry_sdk
sentry_sdk.init(
dsn="___PUBLIC_DSN___",
# Add data like request headers and IP for users, if applicable;
# see https://docs.sentry.io/platforms/python/data-management/data-collected/ for more info
send_default_pii=True,
# ___PRODUCT_OPTION_START___ performance
# Set traces_sample_rate to 1.0 to capture 100%
# of transactions for tracing.
traces_sample_rate=1.0,
# ___PRODUCT_OPTION_END___ performance
# ___PRODUCT_OPTION_START___ profiling
# To collect profiles for all profile sessions,
# set `profile_session_sample_rate` to 1.0.
profile_session_sample_rate=1.0,
# Profiles will be automatically collected while
# there is an active span.
profile_lifecycle="trace",
# ___PRODUCT_OPTION_END___ profiling
# ___PRODUCT_OPTION_START___ logs
# Enable logs to be sent to Sentry
enable_logs=True,
# ___PRODUCT_OPTION_END___ logs
)
Verify
Copied
import httpx
def main():
sentry_init(...) # same as above
with sentry_sdk.start_transaction(name="testing_sentry"):
r1 = httpx.get("https://sentry.io/")
r2 = httpx.post("http://httpbin.org/post")
main()
This will create a transaction called testing_sentry in the Performance section of sentry.io, and create spans for the outgoing HTTP requests.
It takes a couple of moments for the data to appear in sentry.io.
Supported Versions
- HTTPX: 0.16+
- Python: 3.6+
Was this helpful?
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").