Git extension is too verbose when JupyterLab is running in debug mode

[lresende]

Description

Git extension is too verbose when JupyterLab is running in debug mode

Reproduce

Run jupyterlab --debug with git extensions

[D 09:33:04.259 LabApp.jupyterlab_git] Execute ['git', 'for-each-ref', '--format=%(refname:short)%09%(objectname)%09%(upstream:short)%09%(HEAD)', 'refs/heads/'] in /Users/lresende/opensource/jupyter-notebooks/sample-python.
[D 09:33:04.276 LabApp.jupyterlab_git] Code: 0
    Output: master	c0aeb11d2149fc9829c4a233dd71db64427da398	origin/master	*
    
    Error: 
[D 09:33:04.276 LabApp.jupyterlab_git] Execute ['git', 'for-each-ref', '--format=%(refname:short)%09%(objectname)', 'refs/remotes/'] in /Users/lresende/opensource/jupyter-notebooks/sample-python.
[D 09:33:04.292 LabApp.jupyterlab_git] Code: 0
    Output: origin/HEAD	c0aeb11d2149fc9829c4a233dd71db64427da398
    origin/master	c0aeb11d2149fc9829c4a233dd71db64427da398
    
    Error: 
[D 09:33:04.293 LabApp] 200 POST /git/branch?1604424784253 (::1) 35.22ms
[D 09:33:04.301 LabApp] Accepting token-authenticated connection from ::1
[D 09:33:04.302 LabApp.jupyterlab_git] Execute ['git', 'status', '--porcelain', '-u', '-z'] in /Users/lresende/opensource/jupyter-notebooks/sample-python.
[D 09:33:04.302 LabApp] Accepting token-authenticated connection from ::1
[D 09:33:04.318 LabApp.jupyterlab_git] Code: 0
    Output: 
    Error: 
[D 09:33:04.319 LabApp.jupyterlab_git] Execute ['git', 'status', '--porcelain', '-u', '-z'] in /Users/lresende/opensource/jupyter-notebooks/sample-python.
[D 09:33:04.336 LabApp.jupyterlab_git] Code: 0
    Output: 
    Error: 
[D 09:33:04.336 LabApp.jupyterlab_git] Execute ['git', 'diff', '--numstat', '-z', '--cached', '4b825dc642cb6eb9a060e54bf8d69288fbee4904'] in /Users/lresende/opensource/jupyter-notebooks/sample-python.
[D 09:33:04.351 LabApp.jupyterlab_git] Code: 0
    Output: 3	0	.gitignore201	0	LICENSE986	0	data/Sacramento-RealEstate-Transactions.csv7	0	numpy.py26	0	panda.py
    Error: 
[D 09:33:04.352 LabApp] 200 POST /git/status?1604424784297 (::1) 51.34ms
[D 09:33:04.352 LabApp.jupyterlab_git] Execute ['git', 'diff', '--numstat', '-z', '--cached', '4b825dc642cb6eb9a060e54bf8d69288fbee4904'] in /Users/lresende/opensource/jupyter-notebooks/sample-python.
[D 09:33:04.368 LabApp.jupyterlab_git] Code: 0
    Output: 3	0	.gitignore201	0	LICENSE986	0	data/Sacramento-RealEstate-Transactions.csv7	0	numpy.py26	0	panda.py
    Error: 

[fcollonval]

Although I can only acknowledge that the extension is verbose in debug mode, I don't agree on this one being an issue.

As the name says, debug should provide information for debugging. And turn off if not in production. And this has been extremely valuable to understand reported issue.

In comparison, if you turn on debug logging on a proxy server, you will get tons of information on what is coming, how the information is transformed by each middlewares,... .

But fortunately you have a solution, when rewriting the logger, I did it so that the logger name contains the extension name (aka LabApp.jupyterlab_git):

jupyterlab-git/jupyterlab_git/log.py

Line 13 in b5dc2d5

cls._LOGGER = logging.getLogger("{!s}.jupyterlab_git".format(app.log.name))

So instead of using the log flag, you can use python logging configuration to set a different log configuration for jupyterlab_git extension: https://docs.python.org/3/howto/logging.html#configuring-logging

Note: it could be interesting to open a feature request on Jupyter server to accept directly a logging config file or dictionary similar to django feature: https://docs.djangoproject.com/en/3.1/topics/logging/#configuring-logging

[lresende]

@fcollonval ok, I would tend to agree in general, maybe a couple of things we could do:

• Reduce the poll frequency (I believe this has been addressed in Reduce polling #812)
• Remove unused content of the message if not in use (e.g. if code is 0 and there is no output and no error message, just don't print those additional lines)

[fcollonval]

• Reduce the poll frequency (I believe this has been addressed in Reduce polling #812)

Happy it helps you. I want to point out that a user can increase the polling by turning it on even if the Git panel is hidden - but at least it won't poll if not in a Git repository.

• Remove unused content of the message if not in use (e.g. if code is 0 and there is no output and no error message, just don't print those additional lines)

👍 This would be a good improvement