README.md in rv-logstasher-1.3.2 vs README.md in rv-logstasher-1.4.0
- old
+ new
@@ -74,46 +74,60 @@
fields[:user] = current_user && current_user.mail
fields[:site] = request.path =~ /^\/api/ ? 'api' : 'user'
end
end
+### Filtering out controller params
+
+You may not want to log certain parameters which have sensitive information in
+them, e.g. `password`. This can be set using the `filter_parameters` option:
+
+ # Filter out some field you don't want to show
+ config.logstasher.filter_parameters << 'foo'
+
+Note that by default this is set to `['password', 'password_confirmation']`, so
+be careful when explicitly setting, as you may lose this filtering:
+
+ # NOTE: password and password_confirmation will no longer be filtered
+ config.logstasher.filter_parameters = ['foo']
+
+Any filtered parameter will still show in the `params` field, but it's value
+will be `[FILTERED]`.
+
## Installation for Grape Application
-### In your Gemfile:
+### In your Gemfile:
gem "rv-logstasher"
gem "grape_logging"
-
-
+
### Init logger:
-
+
module TestApp
def self.logger
@logger ||= LogStasher.logger_for_app('app_name', Rack::Directory.new("").root, STDOUT)
end
end
### Setup Grape request/exception logging
-
+
module TestApp
class API < Grape::API
logger TestApp.logger
use GrapeLogging::Middleware::RequestLogger, logger: TestApp.logger
-
+
rescue_from TestApp::NotFound do |err|
- # Tag your exception
+ # Tag your exception
API.logger.info(exception: err, tags: "rescued_exception", status: 404)
error_response(message: "Not found", status: 404)
end
rescue_from :all do |e|
API.logger.error(e)
error_response(message: e.message, status: 500)
end
end
end
-
-
## Copyright
Copyright (c) 2016 Reevoo Ltd, released under the MIT license