Skip to content
Unintrusive logging for ruby applications
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.ruby-version
.simplecov
.travis.yml
.yardopts
Gemfile
Guardfile
LICENSE
README.md
Rakefile
log_syringe.gemspec

README.md

LogSyringe

Build Status Code Climate Test Coverage Gem Version

Add logging to your application without cluttering your code with logger calls.

Installation

Add this line to your application's Gemfile:

gem 'log_syringe'

And then execute:

$ bundle

Or install it yourself as:

$ gem install log_syringe

Usage

Write your code:

class MyClass
  def some_method(an_argument)
    do_something
  end
end

Set up a logger for LogSyringe:

LogSyringe.logger = Logger.new(STDOUT)

Inject logging with LogSyringe:

LogSyringe.define(MyClass) do
  log_method(:some_method) do |logger, instance, stats|
    logger.info(
      "some_method was called in #{instance} with params #{stats[:params]}"
    )
  end
end

For full documentation see http://www.rubydoc.info/github/meso-unimpressed/log_syringe/master

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/meso-unimpressed/log_syringe.

You can’t perform that action at this time.