Class: MCollective::Logger::Base

A base class for logging providers.

Logging providers should provide the following:

   * start - all you need to do to setup your logging
   * set_logging_level - set your logging to :info, :warn, etc
   * valid_levels - a hash of maps from :info to your internal level name
   * log - what needs to be done to log a specific message

Methods

cycle_level new set_level should_log?

Attributes

active_level [R]

Public Class methods

new()

[Source]

    # File lib/mcollective/logger/base.rb, line 14
14:       def initialize
15:         @known_levels = [:debug, :info, :warn, :error, :fatal]
16: 
17:         # Sanity check the class that impliments the logging
18:         @known_levels.each do |lvl|
19:           raise "Logger class did not specify a map for #{lvl}" unless valid_levels.include?(lvl)
20:         end
21:       end

Public Instance methods

cycle_level()

Figures out the next level and sets it

[Source]

    # File lib/mcollective/logger/base.rb, line 28
28:       def cycle_level
29:         lvl = get_next_level
30:         set_level(lvl)
31: 
32:         log(lvl, "", "Logging level is now #{lvl.to_s.upcase}")
33:       end

set_level(level)

Sets a new level and record it in @active_level

[Source]

    # File lib/mcollective/logger/base.rb, line 36
36:       def set_level(level)
37:         set_logging_level(level)
38:         @active_level = level.to_sym
39:       end

should_log?(level)

[Source]

    # File lib/mcollective/logger/base.rb, line 23
23:       def should_log?(level)
24:         @known_levels.index(level) >= @known_levels.index(@active_level)
25:       end