1.8 KiB
1.8 KiB
RailsBigBrother
RailsBigBrother lets you log every create, update and destroy on any of your models.
Installation
Add this line to your application's Gemfile:
gem 'rails_big_brother'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rails_big_brother
Configuration
RailsBigBrother.config do |config|
config.format = "big_brother;%<user>s;%<controller_info>s;%<class>s;%<id>s;%<action>s;%<args>s"
config.logger = Rails.logger
end
Usage
Simply add this line in the model you want to log :
big_brother_watch
User and controller info
To fill user and controller info, you need to define two methods in your ApplicationController
def big_brother_user
''
end
def big_brother_infos
{}
end
big_brother_user
must return a string.
big_brother_infos
can return a string, an array or a hash.
Choose events to log
You can choose which events to log with the on
option. For example :
class Example < ActiveRecord::Base
big_brother_watch on: [:create, :destroy]
end
Select attributes to log
You can specify attributes to monitor with only
:
class Example < ActiveRecord::Base
big_brother_watch only: [:first, :second]
end
You can also ignore some attributes with ignore
:
class Example < ActiveRecord::Base
big_brother_watch ignore: :third
end
Log attributes new value on update
You can choose to log the new value of an updated field with verbose
:
class Example < ActiveRecord::Base
big_brother_watch verbose: :third
end
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request