Railsアプリケーションがあり、開発中に不便になるほど頻繁に呼び出されるアクションがあるため、不要なログ出力が大量に発生するため、どうすればよいですか。私はRailsこの1つのアクションだけでは何も(コントローラ、アクション、パラメータ、コンパイル時間など)ログに記録しません)取得しますか?Rails_ENVでも条件付けしたいので、ログインします生産完了です。
ありがとう!
Railsには実際にはこれを行うためのフックがありません。代わりに、ActionController :: Baseのいくつかの根性をラップする必要があります。私のコントローラーの共通基本クラス、私はします
def silent?(action)
false
end
# this knows more than I'd like about the internals of process, but
# the other options require knowing even more. It would have been
# Nice to be able to use logger.silence, but there isn't a good
# method to hook that around, due to the way benchmarking logs.
def log_processing_with_silence_logs
if logger && silent?(action_name) then
@old_logger_level, logger.level = logger.level, Logger::ERROR
end
log_processing_without_silence_logs
end
def process_with_silence_logs(request, response, method = :perform_action, *arguments)
ret = process_without_silence_logs(request, response, method, *arguments)
if logger && silent?(action_name) then
logger.level = @old_logger_level
end
ret
end
alias_method_chain :log_processing, :silence_logs
alias_method_chain :process, :silence_logs
次に、ログオンを抑制したいメソッドを持つコントローラーで:
def silent?(action)
Rails_ENV == "development" && ['my_noisy_action'].include?(action)
end
Rails logger object:
def action
Rails.logger.silence do
# Things within this block will not be logged...
end
end
以下は少なくともRails 3.1.0で動作します:
沈黙させることができるカスタムロガーを作成します。
# selective_logger.rb
class SelectiveLogger < Rails::Rack::Logger
def initialize app, opts = {}
@app = app
@opts = opts
@opts[:silenced] ||= []
end
def call env
if @opts[:silenced].include?(env['PATH_INFO']) || @opts[:silenced].any? {|silencer| silencer.is_a?( Regexp) && silencer.match( env['PATH_INFO']) }
Rails.logger.silence do
@app.call env
end
else
super env
end
end
end
Railsそれを使用するには:
# application.rb
config.middleware.swap Rails::Rack::Logger, SelectiveLogger, :silenced => ["/remote/every_minute", %r"^/assets/"]
上記の例は、リクエストに対応するアセットのサイレンシングを示しています。これは、開発環境では、実際のリクエストを表示するために必要なスクロールバックが少ない(場合によってはない)ことを意味します。
lograge
gemを使用します。
Gemfile:
gem 'lograge'
config/application.rb:
config.lograge.enabled = true
config.lograge.ignore_actions = ['StatusController#nginx', ...]
宝石をGemfile silencer に追加できます。
gem 'silencer', '>= 1.0.1'
そして、あなたのconfig/initializers/silencer.rbで:
require 'silencer/logger'
Rails.application.configure do
config.middleware.swap Rails::Rack::Logger, Silencer::Logger, silence: ['/api/notifications']
end
以下はRails 2.3.14で動作します:
沈黙させることができるカスタムロガーを作成します。
#selective_logger.rb
require "active_support"
class SelectiveLogger < ActiveSupport::BufferedLogger
attr_accessor :silent
def initialize path_to_log_file
super path_to_log_file
end
def add severity, message = nil, progname = nil, &block
super unless @silent
end
end
Railsそれを使用するには:
#environment.rb
config.logger = SelectiveLogger.new config.log_path
各アクションの開始時にログ出力をインターセプトし、アクションをサイレントにするかどうかに応じてロガーを(再)構成します。
#application_controller.rb
# This method is invoked in order to log the lines that begin "Processing..."
# for each new request.
def log_processing
logger.silent = %w"ping time_zone_table".include? params[:action]
super
end
Rails 5を使用すると、要求処理がいくつかのクラスでログに記録されます。最初にLogger
クラスのcall_app
をオーバーライドする必要があります。このファイルをlib/logger.rb
:
# original class:
# https://github.com/Rails/rails/blob/master/railties/lib/Rails/rack/logger.rb
require 'Rails/rack/logger'
module Rails
module Rack
class Logger < ActiveSupport::LogSubscriber
def call_app(request, env) # :doc:
unless Rails.configuration.logger_exclude.call(request.filtered_path)
instrumenter = ActiveSupport::Notifications.instrumenter
instrumenter.start "request.action_dispatch", request: request
logger.info { started_request_message(request) }
end
status, headers, body = @app.call(env)
body = ::Rack::BodyProxy.new(body) { finish(request) }
[status, headers, body]
rescue Exception
finish(request)
raise
ensure
ActiveSupport::LogSubscriber.flush_all!
end
end
end
end
次にlib/silent_log_subscriber.rb
をフォローします。
require 'active_support/log_subscriber'
require 'action_view/log_subscriber'
require 'action_controller/log_subscriber'
# original class:
# https://github.com/Rails/rails/blob/master/actionpack/lib/action_controller/log_subscriber.rb
class SilentLogSubscriber < ActiveSupport::LogSubscriber
def start_processing(event)
return unless logger.info?
payload = event.payload
return if Rails.configuration.logger_exclude.call(payload[:path])
params = payload[:params].except(*ActionController::LogSubscriber::INTERNAL_PARAMS)
format = payload[:format]
format = format.to_s.upcase if format.is_a?(Symbol)
info "Processing by #{payload[:controller]}##{payload[:action]} as #{format}"
info " Parameters: #{params.inspect}" unless params.empty?
end
def process_action(event)
return if Rails.configuration.logger_exclude.call(event.payload[:path])
info do
payload = event.payload
additions = ActionController::Base.log_process_action(payload)
status = payload[:status]
if status.nil? && payload[:exception].present?
exception_class_name = payload[:exception].first
status = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
end
additions << "Allocations: #{event.allocations}" if event.respond_to? :allocations
message = +"Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]} in #{event.duration.round}ms"
message << " (#{additions.join(" | ")})" unless additions.empty?
message << "\n\n" if defined?(Rails.env) && Rails.env.development?
message
end
end
def self.setup
# unsubscribe default processors
ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
case subscriber
when ActionView::LogSubscriber
self.unsubscribe(:action_view, subscriber)
when ActionController::LogSubscriber
self.unsubscribe(:action_controller, subscriber)
end
end
end
def self.unsubscribe(component, subscriber)
events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
events.each do |event|
ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
if listener.instance_variable_get('@delegate') == subscriber
ActiveSupport::Notifications.unsubscribe listener
end
end
end
end
end
# subscribe this class
SilentLogSubscriber.attach_to :action_controller
SilentLogSubscriber.setup
変更されたモジュールを必ずロードしてください。 Rails
をロードした後のconfig/application.rb
:
require_relative '../lib/logger'
require_relative '../lib/silent_log_subscriber'
最後に、除外されたパスを構成します。
Rails.application.configure do
config.logger_exclude = ->(path) { path == "/health" }
end
Railsのコアコードを変更しているため、使用しているRailsバージョンの元のクラスを確認することは常に良い考えです。
これがあまりにも多くの変更のように見える場合は、単純に lograge
gemを使用できます。これは、他のいくつかの変更でほとんど同じです。 Rack::Loggger
コードはRails 以降変更されているため、一部の機能が失われている可能性があります。
Sprockets-Rails3.1.0
から始まるgemは 静かなアセット の実装を導入しています。残念ながら現時点では柔軟ではありませんが、簡単に拡張できます。
config/initializers/custom_quiet_assets.rb
ファイルを作成します。
class CustomQuietAssets < ::Sprockets::Rails::QuietAssets
def initialize(app)
super
@assets_regex = %r(\A/{0,2}#{quiet_paths})
end
def quiet_paths
[
::Rails.application.config.assets.prefix, # remove if you don't need to quiet assets
'/ping',
].join('|')
end
end
config/application.rb
のミドルウェアに追加します。
# NOTE: that config.assets.quiet must be set to false (its default value).
initializer :quiet_assets do |app|
app.middleware.insert_before ::Rails::Rack::Logger, CustomQuietAssets
end
Rails 4.2でテスト済み