Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the log formatter that is easy to override and safe to inherit
- Loading branch information
Showing
4 changed files
with
166 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'pp' | ||
module Faraday | ||
module Logging | ||
# Serves as an integration point to customize logging | ||
class Formatter | ||
extend Forwardable | ||
|
||
DEFAULT_OPTIONS = { headers: true, bodies: false }.freeze | ||
|
||
def initialize(logger:, options:) | ||
@logger = logger | ||
@filter = [] | ||
@options = DEFAULT_OPTIONS.merge(options) | ||
end | ||
|
||
def_delegators :@logger, :debug, :info, :warn, :error, :fatal | ||
|
||
def request(env) | ||
info('request') { "#{env.method.upcase} #{apply_filters(env.url.to_s)}" } | ||
debug('request') { apply_filters(dump_headers(env.request_headers)) } if log_headers?(:request) | ||
debug('request') { apply_filters(dump_body(env[:body])) } if env[:body] && log_body?(:request) | ||
end | ||
|
||
def response(env) | ||
info('response') { "Status #{env.status}" } | ||
debug('response') { apply_filters(dump_headers(env.response_headers)) } if log_headers?(:response) | ||
debug('response') { apply_filters(dump_body(env[:body])) } if env[:body] && log_body?(:response) | ||
end | ||
|
||
def filter(filter_word, filter_replacement) | ||
@filter.push([filter_word, filter_replacement]) | ||
end | ||
|
||
private | ||
|
||
def dump_headers(headers) | ||
headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n") | ||
end | ||
|
||
def dump_body(body) | ||
if body.respond_to?(:to_str) | ||
body.to_str | ||
else | ||
pretty_inspect(body) | ||
end | ||
end | ||
|
||
def pretty_inspect(body) | ||
body.pretty_inspect | ||
end | ||
|
||
def log_headers?(type) | ||
case @options[:headers] | ||
when Hash then @options[:headers][type] | ||
else @options[:headers] | ||
end | ||
end | ||
|
||
def log_body?(type) | ||
case @options[:bodies] | ||
when Hash then @options[:bodies][type] | ||
else @options[:bodies] | ||
end | ||
end | ||
|
||
def apply_filters(output) | ||
@filter.each do |pattern, replacement| | ||
output = output.to_s.gsub(pattern, replacement) | ||
end | ||
output | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,83 +1,28 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'forwardable' | ||
require 'faraday/logging/formatter' | ||
|
||
module Faraday | ||
class Response | ||
class Logger < Middleware | ||
extend Forwardable | ||
|
||
DEFAULT_OPTIONS = { headers: true, bodies: false }.freeze | ||
|
||
def initialize(app, logger = nil, options = {}) | ||
super(app) | ||
@logger = logger || begin | ||
require 'logger' | ||
::Logger.new($stdout) | ||
end | ||
@filter = [] | ||
@options = DEFAULT_OPTIONS.merge(options) | ||
yield self if block_given? | ||
end | ||
|
||
def_delegators :@logger, :debug, :info, :warn, :error, :fatal | ||
|
||
def call(env) | ||
info('request') { "#{env.method.upcase} #{apply_filters(env.url.to_s)}" } | ||
debug('request') { apply_filters(dump_headers(env.request_headers)) } if log_headers?(:request) | ||
debug('request') { apply_filters(dump_body(env[:body])) } if env[:body] && log_body?(:request) | ||
super | ||
end | ||
|
||
def on_complete(env) | ||
info('response') { "Status #{env.status}" } | ||
debug('response') { apply_filters(dump_headers(env.response_headers)) } if log_headers?(:response) | ||
debug('response') { apply_filters(dump_body(env[:body])) } if env[:body] && log_body?(:response) | ||
end | ||
|
||
def filter(filter_word, filter_replacement) | ||
@filter.push([filter_word, filter_replacement]) | ||
end | ||
|
||
private | ||
|
||
def dump_headers(headers) | ||
headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n") | ||
end | ||
|
||
def dump_body(body) | ||
if body.respond_to?(:to_str) | ||
body.to_str | ||
else | ||
pretty_inspect(body) | ||
end | ||
end | ||
|
||
def pretty_inspect(body) | ||
require 'pp' unless body.respond_to?(:pretty_inspect) | ||
body.pretty_inspect | ||
end | ||
|
||
def log_headers?(type) | ||
case @options[:headers] | ||
when Hash then @options[:headers][type] | ||
else @options[:headers] | ||
end | ||
end | ||
class Response::Logger < Response::Middleware | ||
def initialize(app, logger = nil, options = {}) | ||
super(app) | ||
logger ||= begin | ||
require 'logger' | ||
::Logger.new($stdout) | ||
end | ||
formatter_class = options.delete(:formatter) || Logging::Formatter | ||
@formatter = formatter_class.new(logger: logger, options: options) | ||
yield @formatter if block_given? | ||
end | ||
|
||
def log_body?(type) | ||
case @options[:bodies] | ||
when Hash then @options[:bodies][type] | ||
else @options[:bodies] | ||
end | ||
end | ||
def call(env) | ||
@formatter.request(env) | ||
super | ||
end | ||
|
||
def apply_filters(output) | ||
@filter.each do |pattern, replacement| | ||
output = output.to_s.gsub(pattern, replacement) | ||
end | ||
output | ||
end | ||
def on_complete(env) | ||
@formatter.response(env) | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters