JuliaPluto/Pluto.jl

Logging: use the JULIA_DEBUG ENV value

Open

#2509 opened on Mar 14, 2023

View on GitHub
 (1 comment) (3 reactions) (0 assignees)Julia (5,295 stars) (329 forks)batch import
good first issuehelp welcomelogging

Description

With the default logger (in the REPL), you can use the JULIA_DEBUG ENV variable to control the display of @debug logs: https://docs.julialang.org/en/v1/stdlib/Logging/#Environment-variables We should also support this feature in our custom PlutoLogger.

The default implementation is here: https://github.com/JuliaLang/julia/blob/6c2410361a6e413652ed89fb206d4dc6c2af89c9/base/logging.jl#L542 This looks pretty complicated, but maybe there is a way to call this mechanism directly from our code. It might be worth investigating how https://github.com/JuliaLogging/TerminalLoggers.jl did it.

Contributor guide

Tech stack
None
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic Juliafamiliarity with Julia's Logging module
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the default implementation of JULIA DEBUG handling in Julia's base/logging.jl (line 542). Look at how TerminalLoggers.jl implements similar functionality. Then implement support for the JULIA DEBUG environment variable in PlutoLogger by adapting the existing mechanism.