Avoid using group arg for verbosity and just use more fine-grained log levels

Author: quinnj

README.md

@@ -390,7 +390,7 @@ The `LevelOverrideLogger` lets you *lower* (or *raise*) the level of the wrapped
 # Utilities
 
 ## Verbosity macros
-Sometimes when logging, it is desirable to be able to specify a verbosity level in addition to
+Sometimes when logging, it is desirable to be able to specify a verbosity level along with
 the log level, and to be able to filter on verbosity levels. For example, you may want multiple levels
 of verbosity for `Debug` log statements. LoggingExtras.jl exports verbosity macros that act like their
 non-verbose counterparts, but allow specifying a verbosity level as well:

src/verbosity.jl

@@ -15,49 +15,46 @@ vlogmacrodocs = """
 
 "Verbose" logging macros. Drop in replacements of standard logging macros, but an
 additional verbosity level `N` is passed to indicate differing verbosity levels
-for a given log level. The verbosity argument is passed as the `group` argument
-to the core logging logic, so care should be taken if other loggers are being used
-that also use the group argument.
-Note: by default group is passed as the source file, however it is poor practice to rely on this in the first place.
-Instead use the file argument for that.
+for a given log level. The verbosity argument is subtracted from the base log level when passed down
+to the core logging logic, so `@debugv 1 msg` will essentially call `@logmsg Debug-1 msg`.
 
-An `LoggingExtras.EarlyFilteredLogger`can then be used to filter on the `group` argument.
+An `LoggingExtras.LevelOverrideLogger`can then be used to filter on the `level` argument.
 For convenience, the
 [`LoggintExtras.with(f; level, verbosity)`](@ref) function is provided to temporarily
-wrap the current logger with a level/verbosity filter while `f` is executed.
+wrap the current logger with a log level and verbosity subtracted to filter while `f` is executed.
 """
 
 macro debugv(verbosity::Int, msg, exs...)
     return restore_callsite_source_position!(
-        esc(:($Base.@debug $msg _group=$verbosity $(exs...))),
+        esc(:($Base.@logmsg (Logging.Debug - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
 
 macro infov(verbosity::Int, msg, exs...)
     return restore_callsite_source_position!(
-        esc(:($Base.@info $msg _group=$verbosity $(exs...))),
+        esc(:($Base.@logmsg (Logging.Info - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
 
 macro warnv(verbosity::Int, msg, exs...)
     return restore_callsite_source_position!(
-        esc(:($Base.@warn $msg _group=$verbosity $(exs...))),
+        esc(:($Base.@logmsg (Logging.Warn - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
 
 macro errorv(verbosity::Int, msg, exs...)
     return restore_callsite_source_position!(
-        esc(:($Base.@error $msg _group=$verbosity $(exs...))),
+        esc(:($Base.@logmsg (Logging.Error - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
 
 macro logmsgv(verbosity::Int, level, msg, exs...)
     return restore_callsite_source_position!(
-        esc(:($Base.@logmsg $level $msg _group=$verbosity $(exs...))),
+        esc(:($Base.@logmsg ($level - $verbosity) $msg $(exs...))),
         __source__,
     )
 end
@@ -69,19 +66,24 @@ end
 @eval @doc $vlogmacrodocs :(@errorv)
 
 """
-    LoggingExtras.with(f; level=Info, verbosity=0)
+    LoggingExtras.with(f; level=Info)
 
 Convenience function like `Logging.with_logger` to temporarily wrap
-the current logger with a level/verbosity filter while `f` is executed.
+the current logger with a level filter while `f` is executed.
 That is, the current logger will still be used for actual logging, but
-log messages will first be checked that they meet the `level` and
-`verbosity` levels before being passed on to be logged.
+log messages will first be checked that they meet the `level`
+log level before being passed on to be logged.
 """
-function with(f; level::Union{Int, LogLevel}=Info, verbosity::Int=0)
-    with_logger(EarlyFilteredLogger(
-        args -> !(args.group isa Int) || verbosity >= args.group,
-        LevelOverrideLogger(level, current_logger()))
-    ) do
-        f()
+function with(f; level::Union{Int, LogLevel}=Info, verbosity::Integer=0)
+    lvl = Base.CoreLogging._min_enabled_level[]
+    try
+        # by default, this global filter is Debug, but for debug logging
+        # we want to enable sub-Debug levels
+        Base.CoreLogging._min_enabled_level[] = BelowMinLevel
+        with_logger(LevelOverrideLogger(level - verbosity, current_logger())) do
+            f()
+        end
+    finally
+        Base.CoreLogging._min_enabled_level[] = lvl
     end
 end

test/runtests.jl

@@ -239,7 +239,7 @@ end
     with_logger(logger) do
         @infov 1 "info 1 message"
     end
-    @test logger.logs[1].group == 1
+    @test isempty(logger.logs)
 
     logger = TestLogger(min_level=Info)
     with_logger(logger) do
@@ -258,8 +258,7 @@ end
         end
     end
     @test length(logger.logs) == 2
-    @test all(x -> x.level == Debug, logger.logs)
-    @test map(x -> x.group, logger.logs) == [0, 1]
+    @test map(x -> x.level, logger.logs) == [Debug, Debug-1]
 end
 
 @testset "Deprecations" begin