Cannot dump log for ActionDispatch::Http::UploadedFile in JSON format

[roidrage]

Cannot dump log for ActionDispatch::Http::UploadedFile in JSON format

[myriky]

i've solved. the problem is ActionDispatch::Http::UploadedFile dump is too verbose.
just pick want you to see. i just picked "Header" cuz which contains whole information uploaded file.

here is ActionDispatch::Http::UploadedFile model

{"file"=>#<ActionDispatch::Http::UploadedFile:0x007f7f7abf8050 @tempfile=#<Tempfile:/var/folders/ml/s691k8ls7f3568nh2yw_nm9c0000gn/T/RackMultipart20170913-64272-11xee7s.png>, @original_filename="스크린샷 2017-09-08 오후 3.11.12.png", @content_type="image/png", @headers="Content-Disposition: form-data; name=\"file\"; filename=\"\xE1\x84\x89\xE1\x85\xB3\xE1\x84\x8F\xE1\x85\xB3\xE1\x84\x85\xE1\x85\xB5\xE1\x86\xAB\xE1\x84\x89\xE1\x85\xA3\xE1\x86\xBA 2017-09-08 \xE1\x84\x8B\xE1\x85\xA9\xE1\x84\x92\xE1\x85\xAE 3.11.12.png\"\r\nContent-Type: image/png\r\n">, "format"=>:json, "controller"=>"api/v1/uploads", "action"=>"create"}

it's too verbose to logging.
it might be fine to pick @headers value.

monkey patch for UploadedFile

class ActionDispatch::Http::UploadedFile
  def as_json(options = nil)
    %w(headers).inject({}) do |hash, attr|
      hash[attr] = send(attr).force_encoding('utf-8')
      hash
    end
  end
end

config/application.rb

config.lograge.custom_options = lambda do |event|
      exceptions = %w(controller action format)
      {params: event.payload[:params].as_json(except: exceptions)}
end

before uploadedFile dump

{"file"=>#<ActionDispatch::Http::UploadedFile:0x007f7f7abf8050 @tempfile=#<Tempfile:/var/folders/ml/s691k8ls7f3568nh2yw_nm9c0000gn/T/RackMultipart20170913-64272-11xee7s.png>, @original_filename="스크린샷 2017-09-08 오후 3.11.12.png", @content_type="image/png", @headers="Content-Disposition: form-data; name=\"file\"; filename=\"\xE1\x84\x89\xE1\x85\xB3\xE1\x84\x8F\xE1\x85\xB3\xE1\x84\x85\xE1\x85\xB5\xE1\x86\xAB\xE1\x84\x89\xE1\x85\xA3\xE1\x86\xBA 2017-09-08 \xE1\x84\x8B\xE1\x85\xA9\xE1\x84\x92\xE1\x85\xAE 3.11.12.png\"\r\nContent-Type: image/png\r\n">, "format"=>:json, "controller"=>"api/v1/uploads", "action"=>"create"}

lodrage doesn't work

Could not log "process_action.action_controller" event. Encoding::UndefinedConversionError: "\x89" from ASCII-8BIT to UTF-8 

after uploadedFile dump

{"files"=>[{"headers"=>"Content-Disposition: form-data; name=\"files[]\"; filename=\"스크린샷 2017-09-08 오후 3.11.12.png\"\r\nContent-Type: image/png\r\n"}], "format"=>"json", "controller"=>"api/v1/uploads", "action"=>"create"}

lodrage it works!

"params":{"file":{"content_type":"image/png","headers":"Content-Disposition: form-data; name=\"file\"; filename=\"스크린샷 2017-09-08 오후 3.11.12.png\"\r\nContent-Type: image/png\r\n"

[sparksp]

I just solved this myself by calling as_json(except: ["tempfile"]) on the params.

config.lograge.custom_options = lambda do |event|
  {
    params: event.payload[:params].as_json(except: ["tempfile"])
  }
end

[benlovell]

Certainly looks likely to me. The ActionDispatch::Http::UploadedFile is not something you want instrumented in your logs I would assume. You should reject those particular params from the payload. You could do that by rejecting the named parameter(s) or you could potentially walk the parameters and check for ActionDispatch::Http::UploadedFile but that feels slightly dirty to me.

[kidlab]

The problem is because JSON.dump was trying to dump the file content. Here is my monkey patch:

lib/lograge_patch.rb

# Patch ActionDispatch::Http::UploadedFile
class ActionDispatch::Http::UploadedFile
  def as_json(options = nil)
    %w(content_type headers original_filename size).inject({}) do |hash, attr|
      hash[attr] = send(attr)
      hash
    end
  end
end

module Lograge
  module Formatters
    class JsonExt < Lograge::Formatters::Json
      def call(data)
        data.respond_to?(:to_json) ? data.to_json : super
      end
    end
  end
end

config/application.rb

require 'lograge_patch'
config.lograge.formatter = Lograge::Formatters::JsonExt.new