psf / psf/requests

Support for logging is abysmal, and documentation is missing

Open
#5,725 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
54.3k
Forks
10.5k
Avg merge
16h 43m
Merged PRs (30d)
3

Description

Attempting to change logging for requests is very complicated, can only be done application-wide (I think), and the documentation is missing.

Google finds many incorrect suggestions (mainly pointing to readthedocs documentation of requests version 0.x), the only workable information I found was at this stack overflow thread: https://stackoverflow.com/questions/10588644/how-can-i-see-the-entire-http-request-thats-being-sent-by-my-python-application

As a first step it would be good if the information from this thread (insofar as it is still correct) was included in the documentation somewhere.

But it would be a lot nicer if there was easier support for logging, possibly through a toolbelt module or something. Controlling logging on a fine-grained scale is vital, especially when you are trying to debug things like SSL-related errors (which are rather unintelligible in their own right) in a large scale application.

I understand that part of the problem is with urllib3, but I guess I have to start somewhere.

And I'm willing to help, if personpower is an issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked Stack Overflow thread and the current Requests and urllib3 logging behavior. Determine which guidance remains correct and where the documentation should explain request logging, including its application-wide and fine-grained limits. Done means the supported logging workflow and relevant SSL-debugging considerations are documented accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.