6 ms·
Show HN: Httpdbg – A tool to trace the HTTP requests sent by your Python code
Hi,
I created httpdbg, a tool for Python developers to easily debug HTTP(S) client requests in Python programs.
I developed it because I needed a tool that could help me trace the HTTP requests sent by my tests back to the corresponding methods in our API client.
The goal of this tool is to simplify the debugging process, so I designed it to be as simple as possible. It requires no external dependencies, no setup, no superuser privileges, and no code modifications.
I'm sharing it with you today because I use it regularly, and it seems like others have found it useful too—so it might be helpful for you as well.
Hope you will like it.
cle
Source: https://github.com/cle-b/httpdbg https://github.com/cle-b/httpdbg
Documentation: https://httpdbg.readthedocs.io/ https://httpdbg.readthedocs.io/
A blog post on a use case: https://medium.com/@cle-b/trace-all-your-http-requests-in-python-using-httpdbg-9db9110db981/ https://medium.com/@cle-b/trace-all-your-http-requests-in-py...
- billconan 2y agothis is very useful, but why can it only work with python code? At which level does it intercept the http traffic? do I have to use specific http library?
- tredre3 2y agoIt seems to intercept calls for some popular http client libs: https://github.com/cle-b/httpdbg/tree/main/httpdbg/hooks https://github.com/cle-b/httpdbg/tree/main/httpdbg/hooks
- cle-b 2y agoIt works only with Python code because it intercepts HTTP requests by hooking into certain Python functions. It supports any HTTP library based on Python’s standard socket library. Specifically, it works with libraries like requests, httpx, aiohttp, and urllib3, as well as pytest, providing more detailed information about the initiator of the requests.
- cdfuller 2y agoIs there a way to use it with jupyter notebooks? `pyhttpdbg -m jupyter notebook` didn't work for me
- cle-b 2y agoIf you want to trace the HTTP requests in a notebook, you must install the package notebook-httpdbg. This is documented here: https://httpdbg.readthedocs.io/en/latest/notebook/ https://httpdbg.readthedocs.io/en/latest/notebook/
- nfgrars 2y agoAlternatively use man (1) ngrep for http or man (1) openssl for https.
- stuaxo 2y agoThis is great - It would be good to be be able to have django debug toolbar integration, that way I could see which requests were made to backend APIs without leaving Django. Having tried MITMProxy something like httpdbg is definitely needed.
- diegoallen 2y agoYou can do that with django debug toolbar. If you have an endpoint that doesn't return HTML, and hence wouldn't render debug toolbar, you can go to django admin (or any other endpoint that would render ddt) and go to the history pane, check other requests and switch to them.
- ricardo81 2y agoI could be lost here (C/PHP/Node coder mainly in code I've used) Why is it a special case to track HTTP/s requests, that otherwise couldn't be logged like any other process/function? I'd guess most people use libcurl and you can wrap something around that. I guess I'm lost on why this is HTTP or Python specific, or if it is, fine.
- robertlagrant 2y agoI think the nice thing about HTTP for this is different parts of the stack can introduce default headers etc and it's helpful to be able to see the actual request after all that processing's been done.
- ricardo81 2y agoWith curl there's always CURLOPT_VERBOSE as per the library.
- seanc 2y agoIn the old days we'd use tcpdump and wireshark for this, but nowadays everything is encrypted up in the application layer so you need this kind of thing. Or tricky key dumping hacks.
- toomuchtodo 2y agohttps://www.charlesproxy.com/ https://www.charlesproxy.com/ ?
- cle-b 2y agoUnlike other tools such as proxies that allow you to trace HTTP requests, httpdbg makes it possible to link the HTTP request to the Python code that initiated it. This is why it is specific to Python and does not work with other languages.
- ricardo81 2y agoI'm still not understanding. If you're coding something up, why wouldn't you know that piece of code does a HTTP/s request? Based on what you said, it sounds like a scenario where a programmer doesn't know how a request was made. Are there examples of scenarios where that's the case? Sounds like a bit of a security nightmare where there's code doing arbitrary requests.
- judofyr 2y agoLooks neat! A similar tool for this would be VCR (originally built in Ruby, but ported to other languages since): https://vcrpy.readthedocs.io/en/latest/ https://vcrpy.readthedocs.io/en/latest/. This injects itself into the request pipeline, records the result in a local file which can then also be replayed later in tests. It's a quite nice approach when you want to write tests (or just explore) a highly complicated HTTP API without actually hitting it all the time.
- seanc 2y agoThe inspection and debugging features this offers are great additions though. I've stared at VCR yaml enough times to not want to ever do it again.
- cle-b 2y agoI really like vrcpy. I used it a lot with pytest in my previous job. httpdbg isn’t exactly the same; the idea is more about seeing HTTP requests in real-time and being able to easily study them.
- deleted 2y ago[deleted]
- zug_zug 2y agoI've always used a proxy, like charles proxy, for this exact purpose. A neutral middle-man that gives exact timing/response data.
- actionfromafar 2y agoThat’s fine if you can, but say you want to trace deployed on stage, or shudders even production. Or you code tests against some CI and can only add Python.
- zug_zug 2y agoWell I would never use a script like this at a real job outside of local testing. What you'd want on stage is probably using opentelemetry, which I believe has auto-instrumentation for all network calls. Then you have the data forever and it's in a public, shared platform that is permissioned and everybody knows, and will still exist in 10 years.
- cjbprime 2y agoI'm really surprised this was downvoted. Running e.g. mitmproxy and pointing your Python process at it is absolutely the way to do this.
- sureglymop 2y agoThis is how I do it. But I use it for everything I even want to proxy yo inspect the traffic really.
- nghiatran_uit 2y agoIt's not as simple as it sounds, it requires a lot of code to capture Python traffic with charles-proxy. For example, you might modify your python code to use a Proxy and accept a self-signed Charles's certificate. If you need a 1-click solution, no dependencies, and no code's required, check out Proxyman with Auto-Setup: https://docs.proxyman.io/automatic-setup/automatic-setup https://docs.proxyman.io/automatic-setup/automatic-setup Works with all popular Python libs: request, aiohttp, http.client, urllib3, etc * Disclaimer: I'm Noah, creator of Proxyman. I know a pain point when using Charles, and decided to build a new one, to make life easier. Hope it helps you.
- hartator 2y agoI wonder if the same exists for Ruby?
- Jugurtha 2y agoThat's pretty cool! I was playing last night and implemented resumable downloads[0] for pip so that it could pick up where it stopped upon a network disconnect or a user interruption. It sucks when large packages, especially ML related, fail at the last second and pip has to download from scratch. This tool would have been nice to have. Thanks a bunch, - [0]: https://asciinema.org/a/1r8HmOLCfHm40nSvEZBqwm89k https://asciinema.org/a/1r8HmOLCfHm40nSvEZBqwm89k
- westurner 2y agoIt is important to check checksums (and signatures, if there are any) of downloaded packages prior to installing them; especially when resuming interrupted downloads. Pip has a hash-checking mode, but it only works if the hashes are listed in the requirements.txt file, and they're the hashes for the target platform. Pipfile.lock supports storeing hashes for multiple platforms, but requirements.txt does not. If the package hashes are retrieved over the same channel as the package, they can be MITM'd too. You can store PyPi package hashes in sigstore. There should be a way for package uploaders to sign their package before uploading. (This is what .asc signatures on PyPi were for. But if they are retrieved over the same channel, cryptographic signatures can also be MITM'd). IMHO (1) twine should prompt to sign the package (with a DID) before uploading the package to PyPi, and (2) after uploading packages, twine should download the package(s) it has uploaded to verify the signature. ; TCP RESET and Content-Range doesn't hash resources.
- Jugurtha 2y agoThanks for the pointers. The diff is tiny and deals only with resuming downloads. i.e: everything else is left as is.
- accounter8or 2y agoI've always wanted this. You get so spoiled with the Chrome Dev Tools when using Javascript that you miss it when you don't have it.
- hv42 2y agoHave a look at https://httptoolkit.com/ https://httptoolkit.com/ which works with a lot tools (even cli)
- dmurray 2y agoThis looks great. I have a use case for something similar: detecting calls to the file system. Lots of code I've inherited has a habit of loading configuration from some random network share, then failing when that config got moved or the production host doesn't have the same access. I usually use strace(1) to track these down, but it's nowhere near as ergonomic as this tool. I'm wondering now if I could patch the `open` built-in instead.
- zerocool2750 2y agoWent spelunking through the source. I think you absolutely could! There's actually not a whole lot I found that's really http-library specific. It uses the traceback module in a decorator that ends up being manually wrapped around all of the functions of the specific libraries the author cared about. https://github.com/cle-b/httpdbg/blob/main/httpdbg/hooks https://github.com/cle-b/httpdbg/blob/main/httpdbg/hooks Should be easy enough to extend this to other libraries. Super cool tool thanks for sharing @dmurray!
- mcoliver 2y agoIf on Linux or windows you can use Procmon or Instruments on macos. https://github.com/Sysinternals/ProcMon-for-Linux https://github.com/Sysinternals/ProcMon-for-Linux
- sYnfo 2y agoYou might find the syscall tracing functionality of Cirron useful: https://github.com/s7nfo/Cirron https://github.com/s7nfo/Cirron
- oefrha 2y agoCPython since 3.8 already has built-in audit events, including open, so you don't need to patch anything or use anything external. Just add an audit hook with sys.addaudithook(). Quick example: import inspect import pathlib import sys def callsite(): try: pathlib.Path("/tmp/file").open() except: pass def audit_hook(event, args): if event == "open": path, mode, flags = args print(f"audit: open({path!r}, {mode!r}, 0o{flags:o})") # Not using traceback here because traceback will attempt to read the # source file, causing an infinite recursion of audit events. f = inspect.currentframe() while f := f.f_back: print( f'File "{f.f_code.co_filename}", line {f.f_lineno}, in {f.f_code.co_name}' ) def main(): sys.addaudithook(audit_hook) callsite() if __name__ == "__main__": main() Prints: audit: open('/tmp/file', 'r', 0o100000000) File "/path/to/python/lib/python3.12/pathlib.py", line 1013, in open File "/tmp/audit.py", line 10, in callsite File "/tmp/audit.py", line 26, in main File "/tmp/audit.py", line 30, in <module> https://docs.python.org/3/library/audit_events.html https://docs.python.org/3/library/audit_events.html
- 10000truths 2y agoIs there a way to write the trace to a file, instead of spinning up a local web server?
- Too 2y agoCan recommend Opentelemetry if you need a more comprehensive tool like this. There is a whole library of so called instrumentation that can monkeypatch standard functions and produce traces of them. Traces can also propagate across process and rpc, giving you a complete picture, even in a microservice architecture.
- abhishekjha 2y agoIs there an example?
- linuxdude314 2y agoTons; have you actually looked? https://opentelemetry.io/docs/kubernetes/operator/automatic/ https://opentelemetry.io/docs/kubernetes/operator/automatic/ https://github.com/open-telemetry/opentelemetry-demo https://github.com/open-telemetry/opentelemetry-demo
- deleted 2y ago[deleted]
- linuxdude314 2y agoJust use OpenTelemetry. No need to keep reinventing wheels.