Inspecting jupyter server logs from within a container

Anton_Akhmerov · October 26, 2021, 12:37pm

Hi all,

I’m hosting a small jupyterhub instance on a single node, which uses a DockerSpawner for single user containers, and also gives users sudo. Our image is based on jupyter/docker-stacks. I would like to know if it’s possible for users to view their server logs. The documentation mentions getting server logs via docker logs user-container, but that is obviously not an option for a regular user.

I have tried tail -f /proc/<server_pid>/fd/1, but I’ve gotten a permission denied even though it should be the same user.

manics · October 26, 2021, 2:24pm

The easiest way is probably to build your image with a custom entrypoint that runs Jupyter but duplicates stdout/stderr to also go to a log file inside the container that the user can read.

manics · October 26, 2021, 4:05pm

In case it’s useful this is how it’s done in repo2docker:

github.com

jupyterhub/repo2docker/blob/c73321cfda8e48146c3d54069321652829d1871d/repo2docker/buildpacks/repo2docker-entrypoint

#!/usr/local/bin/python3-login
# note: must run on Python >= 3.5, which mainly means no f-strings

# goals:
# - load environment variables from a login shell (bash -l)
# - preserve signal handling of subprocess (kill -TERM and friends)
# - tee output to a log file

import fcntl
import os
import select
import signal
import subprocess
import sys

# output chunk size to read
CHUNK_SIZE = 1024

# signals to be forwarded to the child
# everything catchable, excluding SIGCHLD

This file has been truncated. show original

Be aware it’s specific to the repo2docker environment, and you may find just using shell redirection with tee works fine!

consideRatio · February 1, 2022, 5:15pm

I’ve opened a feature request in jupyter_server related to this: Enable users to access the jupyter server logs · Issue #684 · jupyter-server/jupyter_server · GitHub

Topic		Replies	Views
Logging information from hub-spawned lab servers JupyterHub	2	567	November 21, 2019
Log Monitoring for JupyterLab on DockerSpawner JupyterHub jupyterhub , how-to , help-wanted	2	394	March 12, 2024
Acccess Jupyter Server Logs Notebook jupyterlab , how-to	7	10342	September 23, 2021
dockerspawner.SystemUserSpawner requries --allow-root in TLJH JupyterHub jupyterhub	1	1715	December 2, 2020
Dockerized JupyterHub runs, login works from console, but not in front end JupyterHub	4	782	April 12, 2023

Inspecting jupyter server logs from within a container

Related topics