jupyter / jupyter/notebook

Option to log Terminal and Notebooks

Open
#4,136 10 comments 10 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
13.3k
Forks
5.8k
Avg merge
6d 11h
Merged PRs (30d)
7

Description

Hi,

I need to implement Terminal and Notebook logging.

How I see it:

1. Add options in `jupyter_notebook_config.py` such as:
* log_terminal: bool (weither we log the terminals)
* log_notebook: bool (weither we log the notebooks)
* log_terminal_file: Unicode string (if log_terminal is true, specify where to write logs)
* log_notebook_file: Unicode string (if log_notebook is true, specify where to write logs)

2. Log messages in "on_message" and "write_message" in https://github.com/jupyter/notebook/blob/master/notebook/terminal/handlers.py
3. Log messages in "on_message" and "write_message" in https://github.com/jupyter/notebook/blob/master/notebook/services/kernels/handlers.py

I would like to do a Pull/Request for that, could you please tell me if what I suggest is fine.
How can I specify new options for jupyter_notebook_config.py?

Thank you,
Julien

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 jupyter_notebook_config.py and the on_message and write_message entry points in notebook/terminal/handlers.py and notebook/services/kernels/handlers.py. Confirm how new configuration options are defined and determine the expected log destinations and message coverage. Done means terminal and notebook logging can each be enabled and directed to their configured files.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.