JuliaPluto/Pluto.jl

Sticky log messages

Open

#2,971 opened on Jul 29, 2024

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Julia (329 forks)batch import
frontendgood first issuelogging

Repository metrics

Stars
 (5,295 stars)
PR merge metrics
 (Avg merge 3d 17h) (16 merged PRs in 30d)

Description

I sometimes wish I could use @info to update an existing log message. Imagine the following, with each invocation of @info "..." sticky=true updating the same log card instead of adding a new one:

let
    keepgoing(i) = (i < rand(51:100))
    i = 1
    while keepgoing(i)
        @info "i = $i" sticky=true
        sleep(0.1)
        i += 1
    end
end

This is an example where it's impossible to calculate a % complete, so ProgressLogging is unsuitable, but I'd still like to see an indicator of forward progress. The sticky=true keyword seems to have some precedence from the old days of Juno, see https://github.com/JuliaLogging/ProgressLogging.jl/issues/23#issuecomment-594218835.

Contributor guide

Research direction
Investigate Pluto's logging internals in the Pluto source code, particularly the @info macro. Review the linked issue in ProgressLogging.jl for prior art. Implement a sticky=true keyword that updates the most recent log card instead of creating a new one. Ensure backward compatibility.
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.
Clear
Prerequisites
Julia basicsPluto.jl familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70