TeeLogger

Sorry. In from version 2 to version 3, changed usage. see also CHANGELOG.md.

• Rubygems.org
• GitHub
• RubyDoc.info

logging to file and standard output. require standard library only.

• 1. Characteristic
• 2. Installation
• 3. Usage
  • 3.1. let's logging
  • 3.2. enable only when specified
  • 3.3. log meassage indent
  • 3.4. enabling and indent
  • 3.5. disable console output
  • 3.6. enable console output
  • 3.7. disable logfile output
  • 3.8. enable logfile output
  • 3.9. disable in block
  • 3.10. and others like Logger's
• 4. include or extend TeeLogger
  • 4.1. for casual use
  • 4.2. configuration logfile name, progname, level, formatter, and datetime_format
• 5. Development
• 6. Contributing
• 7. License

---

1. Characteristic

• use standard lib only.
• like Logger: see usage.
• enabled or disabled by switching the output of the console and the logfile.

---

2. Installation

Add this line to your application's Gemfile:

gem 'tee_logger'

And then execute:

bundle

Or install it yourself as:

gem install tee_logger

---

3. Usage

3.1. let's logging

require 'tee_logger'

# Logger.new like options(logdev, shift_age, shift_size)
# options default value is
#   logdev     = './tee_logger.log'
#   shift_age  = 0
#   shift_size = 1_048_576
tl = TeeLogger.new

tl.debug 'hello'
tl.debug(:progname) { 'hello world' }
tl.progname = 'App'
tl.debug 'hello tee_logger'

3.2. enable only when specified

tl.info 'this message is console and logfile'
tl.info 'this message is console only', :console
tl.info 'this message is logfile only', :logfile

3.3. log meassage indent

tl.info 'hello'    # => 'hello'
tl.info 'hello', 0 # => 'hello'
tl.info 'hello', 2 # => '  hello'

3.4. enabling and indent

tl.info 'this message is console only', 2, :console
tl.info 'this message is console only', :console, 2

3.5. disable console output

tl.disable(:console)
tl.info 'this message is logfile only'

3.6. enable console output

tl.enable(:console)
tl.info 'this message is logfile and console'

3.7. disable logfile output

tl.disable(:logfile)
tl.info 'this message is consle only'

3.8. enable logfile output

tl.enable(:logfile)
tl.info 'this message is logfile and console'

3.9. disable in block

tl.disable(:console) do
  tl.info 'this message is logfile only'
end
tl.info 'this message is logfile and console'

3.10. and others like Logger's

# log_level
tl.debug? # => true
tl.info?  # => true
tl.warn?  # => true
tl.error? # => true
tl.fatal? # => true

tl.level # => 0
tl.level = Logger::INFO
tl.debug 'this message is not logging'

# formatter
tl.formatter # => nil or Proc
tl.formatter =
  proc { |severity, datetime, progname, message| "#{severity}:#{message}" }

# datetime_formatter
tl.datetime_format # => nil or Proc
tl.datetime_format = '%Y%m%d %H%M%S '

---

4. include or extend TeeLogger

the log file will be in default of ./tee_logger.log

4.1. for casual use

require 'tee_logger'

class YourAwesomeClass
  # define method #logger for your class.
  # log file will be in default of `./tee_logger.log`
  include TeeLogger

  def awesome_method
    logger.info 'this is message is logging and disp console'
  end
end

module YourAwesomeModule
  # define singleton method .logger for your module.
  # log file will be in default of `./tee_logger.log`
  extend TeeLogger

  def self.awesome_method
    logger.info 'this is message is logging and disp console'
  end
end

4.2. configuration logfile name, progname, level, formatter, and datetime_format

require 'tee_logger'

# Before extend or include the module, allow the configuration.
# TeeLogger.logdev = 'log1.log'
TeeLogger.configure do |config|
  config.logdev = 'log1.log'
  config.level = Logger::Severity::INFO
  config.progname = 'AwesomeApp'
  config.formatter = proc { |s, t, p, m| "#{s} #{t} #{p} #{m}\n" }
  # config.datetime_format = '%Y%m%d %H%M%S '
end

class YourAwesomeClass
  include TeeLogger

  def awesome_method
    logger.info 'this message is output `log1.log`'
  end
end

# reset configuration
TeeLogger.configuration_reset

# NOTE: sorry, `TeeLogger.logev` is deprecate.
TeeLogger.logdev = 'log2.log'
module YourAwesomeModule
  extend TeeLogger

  def self.awesome_method
    logger.info 'this message is output `log2.log`'
  end
end

---

5. Development

After checking out the repo, run bundle install to install dependencies. Then, run rake rspec to run the tests. You can also run budle exec pry -r ./lib/tee_logger for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

---

6. Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/k-ta-yamada/tee_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

---

7. License

The gem is available as open source under the terms of the MIT License.

---

eof