MongodbLogger is a alternative logger for Rails 3, which log all requests of you application into MongoDB database. It:
- simple to integrate into existing Rails 3 application;
- allow to store all logs from web cluster into one scalable storage - MongoDB;
- flexible schema of MongoDB allow to store and search any information from logs;
- web panel allow filter logs, build graphs using MapReduce by information from logs;
-
Add the following to your Gemfile then refresh your dependencies by executing "bundle install" (or just simple "bundle"):
gem "mongodb_logger" -
Add the following line to your ApplicationController:
include MongodbLogger::Base -
Add MongodbLogger settings to database.yml for each environment in which you want to use the MongodbLogger. The MongodbLogger will also look for a separate mongodb_logger.yml or mongoid.yml (if you are using mongoid) before looking in database.yml. In the mongodb_logger.yml and mongoid.yml case, the settings should be defined without the 'mongodb_logger' subkey.
File: database.yml:
development: adapter: postgresql database: my_app_development username: postgres mongodb_logger: database: my_app # required (the only required setting) capsize: <%= 10.megabytes %> # default: 250MB host: localhost # default: localhost port: 27017 # default: 27017 replica_set: true # default: false - Adds retries for ConnectionFailure during voting for replica set master safe_insert: false # default: false - Enable/Disable safe inserts (wait for insert to propagate to all nodes) application_name: my_app # default: Rails.application disable_file_logging: false # default: false - disable logging into filesystem (only in MongoDB) collection: some_name # default: Rails.env + "_log" - name of MongoDB collection
File: mongodb_logger.yml:
development: database: my_app capsize: <%= 10.megabytes %> host: localhost port: 27017 replica_set: true
After success instalation of gem, a new MongoDB document (record) will be created for each request on your application, by default will record the following information: Runtime, IP Address, Request Time, Controller, Method, Action, Params, Application Name and All messages sent to the logger. The structure of the MongoDB document looks like this:
{
'action' : action_name,
'application_name' : application_name (rails root),
'controller' : controller_name,
'ip' : ip_address,
'messages' : {
'info' : [ ],
'debug' : [ ],
'error' : [ ],
'warn' : [ ],
'fatal' : [ ]
},
'params' : { },
'path' : path,
'request_time' : date_of_request,
'runtime' : elapsed_execution_time_in_milliseconds,
'url' : full_url,
'method' : request method (GET, POST, PUT, DELETE, OPTIONS)
}
Beyond that, if you want to add extra information to the base of the document (let's say something like user_id on every request that it's available), you can just call the Rails.logger.add_metadata method on your logger like so (for example from a before_filter):
# make sure we're using the MongodbLogger in this environment
if Rails.logger.respond_to?(:add_metadata)
Rails.logger.add_metadata(:user_id => @current_user.id)
end
To setup web interface in you Rails application, first of all create autoload file in you Rails application
File: you_rails_app/config/initializers/mongodb_logger.rb (example)
require 'mongodb_logger/server' # required
# this secure you web interface by basic auth, but you can skip this, if you no need this
MongodbLogger::Server.use Rack::Auth::Basic do |username, password|
[username, password] == ['admin', 'password']
end
and just mount MongodbLogger::Server in rails routes:
File: you_rails_app/config/routes.rb
mount MongodbLogger::Server.new, :at => "/mongodb"
Now you can see web interface by url "http://localhost:3000/mongodb"
If you've installed MongodbLogger as a gem and want running the front end without Rails application, you can do it by this command:
mongodb_logger_web config.yml
where config.yml is config, similar to config of Rails apps, but without Rails.env. Example:
database: app_logs_dev
host: localhost
port: 27017
collection: development_log # set for see development logs
parameter "collection" should be set, if your set custom for your Rails application or start this front end not for production enviroment (by default taken "production_log" collection, in Rails application gem generate "#{Rails.env}_log" collection, if it is not defined in config).
It's a thin layer around rackup so it's configurable as well:
mongodb_logger_web config.yml -p 8282
Using Passenger, Unicorn, Thin, etc? MongodbLogger ships with a config.ru you can use. See guide:
- Passenger Apache: http://www.modrails.com/documentation/Users%20guide%20Apache.html#_deploying_a_rack_based_ruby_application
- Passenger Nginx: http://www.modrails.com/documentation/Users%20guide%20Nginx.html#deploying_a_rack_app
- Unicorn: http://unicorn.bogomips.org
- Thin: http://code.macournoyer.com/thin/usage
Don't forget setup MONGODBLOGGERCONFIG env variable, which provide information about MongodbLogger config. Example starting with unicorn:
MONGODBLOGGERCONFIG=examples/server_config.yml unicorn
And now, for a couple quick examples on getting ahold of this log data... First, here's how to get a handle on the MongoDB from within a Rails console:
>> db = Rails.logger.mongo_connection
=> #<Mongo::DB:0x007fdc7c65adc8 @name="monkey_logs_dev" ... >
>> collection = db[Rails.logger.mongo_collection_name]
=> #<Mongo::Collection:0x007fdc7a4d12b0 @name="development_log" .. >
Once you've got the collection, you can find all requests for a specific user (with id):
>> cursor = collection.find(:user_id => '12355')
=> #<Mongo::Cursor:0x1031a3e30 ... >
>> cursor.count
=> 5
Find all requests that took more that one second to complete:
>> collection.find({:runtime => {'$gt' => 1000}}).count
=> 3
Find all order#show requests with a particular order id (id=order_id):
>> collection.find({"controller" => "order", "action"=> "show", "params.id" => order_id})
Find all requests with an exception that contains "RoutingError" in the message or stack trace:
>> collection.find({"messages.error" => /RoutingError/})
Find all requests with errors:
>> collection.find({"is_exception" => true})
Find all requests with a request_date greater than '11/18/2010 22:59:52 GMT'
>> collection.find({:request_time => {'$gt' => Time.utc(2010, 11, 18, 22, 59, 52)}})
Copyright (c) 2009-2011 Phil Burrows, CustomInk and Leopard released under the MIT license