You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Matt Riedemann 1929fb53b8 Add support for JSON formatted logs ... This adds a new extra package dependency on `json-logging` and an environment variable, which when set to "true" regardless of case, will try to use the json-logging non-web app log formatter. If the `json-logging` package is not installed but the environment variable is True, something like this will be logged but it will not crash the application: ``` $ ENABLE_JSON_LOGGING=true jupyter notebook Unable to use json logging due to missing packages. Run "pip install notebook[json-logging]" to fix. Traceback (most recent call last): File "/home/osboxes/jupyter/notebook/notebook/notebookapp.py", line 144, in <module> import json_logging ModuleNotFoundError: No module named 'json_logging' ``` Initially I tried to add a new Bool config option to toggle this but the problem is (from my limited understanding of traitlets and tornado) is that `_log_formatter_cls` needs to be set early and trying to se the log formatter later in `init_logging` is too late - or at least I couldn't figure out a way to reset the log formatter dynamically (I tried calling `_log_format_changed` [1] but that didn't work). With this working you get logs like this: ``` {"written_at": "2020-10-07T21:10:51.606Z", "written_ts": 1602105051606265000, "msg": "404 GET /nbextensions/widgets/notebook/js/extension.js (127.0.0.1) 9.26ms referer=http://localhost:8888/notebooks/Untitled.ipynb", "type": "log", "logger": "NotebookApp", "thread": "MainThread", "level": "WARNING", "module": "log", "line_no": 49} {"written_at": "2020-10-07T21:10:54.443Z", "written_ts": 1602105054443309000, "msg": "Starting buffering for f260ddd7-938c-42d0-ac3b-455bea76694f:49f30b53fc4b4ec6a8f2fb748a171613", "type": "log", "logger": "NotebookApp", "thread": "MainThread", "level": "INFO", "module": "kernelmanager", "line_no": 222} {"written_at": "2020-10-07T21:10:54.446Z", "written_ts": 1602105054446264000, "msg": "Kernel shutdown: f260ddd7-938c-42d0-ac3b-455bea76694f", "type": "log", "logger": "NotebookApp", "thread": "MainThread", "level": "INFO", "module": "multikernelmanager", "line_no": 201} ``` An obvious improvement here would to be able to split the `msg` fields apart so that we can log things like response status code, request method, request URL, response_time_ms etc. That should be possible with the `JSONLogWebFormatter` from `json-logging` but when I tried using that I was getting errors from the library about a correlation id (which is based on a request header we don't use). The `json-logging` library supports several web frameworks like Flask but unfortunately does not have built in support for Tornado, but it does support custom formatters so that might be a follow up option to improve on this. [1] https://github.com/ipython/traitlets/blob/4.3.3/traitlets/config/application.py#L195 Closes #5798		5 years ago
..
auth	Implement password hashing with bcrypt (#3793)	6 years ago
base	Fix exception causes in handlers.py	6 years ago
bundler	Fix exception causes all over the codebase	6 years ago
edit	s/jupyter_notebook/notebook	11 years ago
files	Import `gen`	6 years ago
gateway	Fix exception causes all over the codebase	6 years ago
i18n	Update translation for zh_CN	5 years ago
kernelspecs	Fix exception causes all over the codebase	6 years ago
nbconvert	Fix exception causes all over the codebase	6 years ago
notebook	Allow contents manager get to return future	6 years ago
prometheus	Added metrics for number of kernels running labeled by type	7 years ago
services	Fix exception causes all over the codebase	6 years ago
static	Merge pull request #5488 from toonijn/refactor-markdown	5 years ago
templates	refactor code duplication of markdown renderers	6 years ago
terminal	Improve login shell heuristics	6 years ago
tests	Merge pull request #5488 from toonijn/refactor-markdown	5 years ago
tree	refactor code duplication of markdown renderers	6 years ago
view	URL escape file path in iframe view handler	9 years ago
__init__.py	Add UNIX socket support to notebook server.	6 years ago
__main__.py	s/jupyter_notebook/notebook	11 years ago
_sysinfo.py	Catch errors calling git for commit ID	9 years ago
_tz.py	move tz utils to top-level private module ._tz	9 years ago
_version.py	Back to dev version	5 years ago
config_manager.py	rm dependences of py2 in base path.	6 years ago
extensions.py	Fix typos (#4760)	7 years ago
jstest.py	rm dependences of py2 in base path.	6 years ago
log.py	Move license information from COPYING.md	6 years ago
nbextensions.py	rm dependences of py2 in base path.	6 years ago
notebookapp.py	Add support for JSON formatted logs	5 years ago
serverextensions.py	basic __version__ reporting for extensions	8 years ago
transutils.py	Don't install gettext into builtins	8 years ago
utils.py	Prevent leaking of handle in _check_pid_win32	5 years ago