mirror of
https://github.com/vee1e/mitmproxy.git
synced 2026-09-01 10:18:26 +00:00
c69239bb90
mitmproxy previously used a homegrown logging mechanism based around
`mitmproxy.ctx.log` and the `add_log` hook. This worked well for everything
we control, but does not work outside the mitmproxy universe.
For now we have simply ignored logging in e.g. tornado or h2, but with the
upcoming introduction of mitmproxy_wireguard we now have a dependency
on some Rust/PyO3 code for which we definitely want logs, but which also
cannot easily be changed to use our homegrown logging (PyO3 does the heavy
lifting to add interoperability with stdlib logging). Long story short,
we want to introduce a log handler for stdlib logging.
Now there are two ways how such a handler could operate:
1. We could build a handler that forwards all stdlib log events
into our homegrown mechanism.
2. We embrace stdlib's logging as the correct way to do things,
and get rid of our homegrown stuff.
This PR follows the second approach by removing the `add_log` hook and
rewriting the `TermLog` and `EventStore` addons to listen for stdlib log records.
This means that all `mitmproxy.ctx.log.info` events are now simply `logging.info` etc.
One upside of this approach is that many parts of the codebase now don't depend
on the existence of `mitmproxy.ctx` and we can use off-the-shelf things like pytest's
`caplog`. We can also now better colorize log output and/or add timestamps.
|
||
|---|---|---|
| .. | ||
| bucketassets | ||
| raw | ||
| scripts | ||
| src | ||
| .gitignore | ||
| build.py | ||
| modd.conf | ||
| README.md | ||
| setup.sh | ||
| upload-archive.sh | ||
| upload-stable.sh | ||
Mitmproxy Documentation
This directory houses the mitmproxy documentation available at https://docs.mitmproxy.org/.
Prerequisites
- Install hugo "extended".
- Windows users: Depending on your git settings, you may need to manually create a symlink from
/docs/src/examplesto/examples.
Editing docs locally
- Make sure the mitmproxy Python package is installed and the virtual python environment was activated. See CONTRIBUTING.md for details.
- Run
./build.pyto generate additional documentation source files. - Now you can change your working directory to
./srcand runhugo server -D.