Skip to content

Instantly share code, notes, and snippets.

@dblock

dblock/api_logger.rb

Created December 10, 2012 01:43
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save dblock/4247912 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save dblock/4247912 to your computer and use it in GitHub Desktop.
Download ZIP
API logger with Grape under Rails
Raw
api_logger.rb
class ApiLogger < Grape::Middleware::Base
def before
Rails.logger.info "[api] Requested: #{request_log_data.to_json}\n" +
"[api] #{response_log_data[:description]} #{response_log_data[:source_file]}:#{response_log_data[:source_line]}"
end
private
def request_log_data
request_data = {
method: env['REQUEST_METHOD'],
path: env['PATH_INFO'],
query: env['QUERY_STRING']
}
request_data[:user_id] = current_user.id if current_user
request_data
end
def response_log_data
{
description: env['api.endpoint'].options[:route_options][:description],
source_file: env['api.endpoint'].block.source_location[0][(Rails.root.to_s.length+1)..-1],
source_line: env['api.endpoint'].block.source_location[1]
}
end
end
@kushkella
Copy link
Copy Markdown

kushkella commented Dec 30, 2013

Are the helper methods such as current_user available in the middleware? I have been trying to call those methods but I always get method not found exception.

@pboling
Copy link
Copy Markdown

pboling commented Jan 14, 2015

@hamin - howdy padner! Do you have any updates to the logger? I am just stumbling onto this now. I've been manually logging params where needed, but I want to implement a global solution now.

Update: I went ahead and kicked its ass. Also @dblock

ruby-grape/grape#894

@aserafin
Copy link
Copy Markdown

aserafin commented Apr 16, 2015

Just recently created gem that accomplish something very similar. Just few lines of code in your app and you will get one log line per request with: status code, path, request time, db time and parameters.

Check it out: https://rubygems.org/gems/grape_logging

@mxvanzant
Copy link
Copy Markdown

mxvanzant commented May 11, 2015

@aserafin -- can you specify where to put those two lines of code -- Ruby beginner here.

@rubyconvict
Copy link
Copy Markdown

rubyconvict commented Nov 17, 2015

@hamin Yes, dirty... I found a nasty bug in this code:

        # Rack::Utils.parse_query('♥')
        # /.../vendor/bundle/ruby/2.2.0/gems/rack-1.6.4/lib/rack/utils.rb:92: warning: regexp match /.../n against to UTF-8 string
        # => {"♥"=>nil}
        # [2] pry(#<Backbone::ApiLogger>)> Rack::Utils.parse_query('%')
        # ArgumentError: invalid %-encoding (%)
        # from /home/xxx/.rvm/rubies/ruby-2.2.0/lib/ruby/2.2.0/uri/common.rb:382:in `decode_www_form_component'

so the percent sign has to be escaped too, in case somebody wants to use it

rack_input = rack_input.gsub("&", "%26").gsub("%", "%25")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment