Setting Jekyll.logger log_level in Tag Plugin

Help
1

I can send a message to the Jekyll.logger from a tag plugin like this:

Jekyll.logger.info "Hello, world"

But I cannot seem to adjust or set the logging level. The following causes no error and has no effect (when invoked prior to generating log output):

Jekyll.logger.adjust_verbosity(:quiet => true)

I also tried adding the following to _config.yml to no effect:

quiet: true

Suggestions? I would be happy if I could globally adjust a singleton log_level, even better if I could configure a log_level for my plugin separately from other aspects of Jekyll.

2

Technically, plugins cannot change log levels continuously or separately.
To set levels globally, use --verbose / -V and --quiet / -q at the time of invocation:

bundle exec jekyll build --verbose

bundle exec jekyll build --quiet
3 Likes
4

Thanks, @ashmaroli. Actually, I just realized that the reason some log lines always appeared is because I used puts to generate output (oops!). After I replaced them with proper log statements I was able to adjust the log level in my plugin with:

Jekyll.logger.adjust_verbosity(:quiet => true)

If this is unexpected, then please do not consider it a bug :slight_smile:

I then tried the following, but it did not do anything:

Jekyll.logger.adjust_verbosity(:warn => true)

Looks like I will have to set up my own logger in my plugin, instead of using Jekyll’s logger.

module SubEntities
  # See https://ruby-doc.org/stdlib-2.7.1/libdoc/logger/rdoc/Logger.html
  @@log = Logger.new(STDOUT)
  @@log.level = Logger::WARN
  @@log.progname = 'subentities_menu'
  @@log.formatter = proc { |severity, datetime, progname, msg| "#{severity} #{progname}: #{msg}\n" }

  def self.log
    @@log
  end

  # Used like this:
   SubEntities.log.info "msg"
   SubEntities.log.warn "msg".yellow
end
5

When you say, did not do anything, how did you come to that conclusion? what did you expect to see? Were you specifically monitoring the STDOUT or the STDERR channels?

If all you want is to output yellow text from your plugin, you could write wrapper method instead:

def log_warning(msg)
  Jekyll.logger.warn "[My Plugin]:", msg
end

However, the warning is output into the STDERR channel.
To output warnings into STDOUT, you’ll have to fashion a custom logger like you contemplated.

6

Just published a blog post about this and provided an acknowledgement to you.

Thanks for your help!

7

Thanks for the acknowledgement, though I would not say it is impossible to adjust log levels even supposedly. The presence of a public method that allows you to do so contradicts the statement.

What I meant to say in the earlier comment was regarding switching log levels continuously
i.e. output part of the build with :debug level, then switch to :warn level and then switch to :info level and then back to :debug level.
(This is my understanding of the core logger implementation. You’re welcome to correct me if I misunderstood the code.)

8

Good point re. “supposedly”. Will rephrase. :slight_smile:

1 Like
9

I wrote a LogFactory class and added a section to the article telling readers how to download and use it in Jekyll plugins.