Skip to content

Commit

Permalink
Merge pull request #27 from pwnall/patch-1
Browse files Browse the repository at this point in the history
Copy/paste-friendly config lines
  • Loading branch information
noahd1 committed Sep 22, 2013
2 parents 0520e53 + 8cf3d3c commit 55930f9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.rdoc
Expand Up @@ -44,25 +44,25 @@ the middleware.

The middleware class to include into your stack is "Oink::Middleware". For rails using an initializer is recommended:

YourApplication::Application.middleware.use Oink::Middleware
Rails.application.middleware.use Oink::Middleware

Oink::Middleware writes log entries to log/oink.log in your application root directory by default.

You can also initialize it with an optional logger instance enabling your application to write Oink log entries to your application's default log file:

YourApplication::Application.middleware.use( Oink::Middleware, :logger => Rails.logger )
Rails.application.middleware.use( Oink::Middleware, :logger => Rails.logger )

(This setup enables Oink to work with Request Log Analyzer (https://github.com/wvanbergen/request-log-analyzer), which currently parses rails logs)

Oink::Middleware logs memory and activerecord usage by default.

You can configure which using the :instruments option. For memory only:

YourApplication::Application.middleware.use( Oink::Middleware, :instruments => :memory )
Rails.application.middleware.use( Oink::Middleware, :instruments => :memory )

For activerecord instantiation counts only:

YourApplication::Application.middleware.use( Oink::Middleware, :instruments => :activerecord )
Rails.application.middleware.use( Oink::Middleware, :instruments => :activerecord )

Note that the previous way of configuring oink, as a set of modules to include into rails controllers, is deprecated.

Expand Down

0 comments on commit 55930f9

Please sign in to comment.