sapience 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eacddd2a363dd27232188e0576430593a3ea71de
-  data.tar.gz: 06160fc823fa373fa7a0367541c23a1d825e8e9c
+  metadata.gz: a496d597a7e40d5578684eb7c6cb8dcd95f52e7e
+  data.tar.gz: 0f040171526449771d60df6b210bcefb0872a1db
 SHA512:
-  metadata.gz: c7a9eb74f28e568bd0646410098bbea506b438e0db276c959e37ec1eec753c4303f748a76a9119fbb1628c3a16a9cc7f0593f383108b757ddcbf17a69f80efe5
-  data.tar.gz: e44f3a521a0cff771a7f5598eee99f2f131dcbe7929e463f953787d78cbd629d532148202e4555f604dc3f82fd0e3ee4dd4e0a860f7c4f15f11eace2b17b6ce6
+  metadata.gz: b9a04aedb193c4a03b77e137c26c866b14961448c376a602301ce96cf5f30e70ef0d551f75aec3eef82c43a262b05529c79d4f2d3e42d04059d79467be334a1a
+  data.tar.gz: 0f3e82c77af85a5a2acd9554811ddd833c6cdbe38939ddc643637a28305eb7491057e0c8448401eab68fbb80f8cc689b08375aa5c2be883d73451a67090bcfed

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v2.0.3
+
+- Ability to configure ActiveRecord log level independently
+- Fix issue where the Grape extension was incorrectly logging 500 response codes as 404's
+
 ## v2.0.2
 
 - Fix metrics collection for 2.0.1

data/README.md

@@ -38,7 +38,7 @@ module Aslan
     class Base < Grape::API
       use Sapience::Extensions::Grape::Middleware::Logging, logger: Sapience[self]
 
-      # To log all requests even when no route was found try the following:
+      # To log all requests even when no route was found add the following:
       route :any, "*path" do
         error!({ error: "No route found" }, 404)
       end
@@ -48,6 +48,38 @@ end
 
 ```
 
+Also make sure you only use "rescue_from" when you want to return a 500 status. For any other status "dont" use 
+"rescue_from".
+
+For example if you have some authentication code that raises an exception when the user is not authenticated, 
+dont use "rescue_from" to catch this exception and change the status to 403 within the rescue_from, handle this 
+exception instead on the "before" block, or alternatively within your endpoint, like below:
+
+
+```ruby
+before do
+  begin
+    current_user
+  rescue ClientPortalApiClient::Unauthorized
+    error!("User is forbidden from accessing this endpoin", 403)
+  end
+end
+```
+
+Likewise, for capturing any other exception for which you want to return a code other than 500, capture your 
+exception in the "before" block or within your endpoint, but make sure "rescue_from" is "only" used for 500 
+status, as grape will call rescue_from once is gone through all the middleware, so if you change the status 
+in a rescue_from, Sapience would not be able to log it correctly. So the below is ok because the rescue_from 
+is using status 500:
+
+```ruby
+rescue_from :all do |e|
+  error!(message: e.message, status: 500)
+end
+```
+
+
+
 ### Configuration
 
 The sapience configuration can be controlled by a `config/sapience.yml` file or if you like us have many projects that use the same configuration you can create your own gem with a shared config. Have a look at [reevoo/reevoo_sapience-rb](https://github.com/reevoo/reevoo_sapience-rb)
@@ -57,6 +89,7 @@ The `app_name` is required to be configured. Sapience will fail on startup if ap
 ```ruby
 Sapience.configure do |config|
   config.default_level   = :info
+  config.log_level_active_record = :debug
   config.backtrace_level = :error
   config.appenders       = [
     { stream: { io: STDOUT, formatter: :color } },
@@ -91,6 +124,7 @@ test:
 
 development:
   log_executor: single_thread_executor
+  log_level_active_record: debug
   log_level: debug
   appenders:
     - stream:
@@ -275,6 +309,10 @@ Formatters can be specified by using the key `formatter: :camelized_formatter_na
 
 ## Running the tests
 
+You need to create the test postgres db, by running the command below:
+
+`createdb rails_app_test`
+
 `bin/tests`
 
 ## Environment variables

data/lib/sapience/configuration.rb

@@ -4,13 +4,14 @@ module Sapience
 
   # rubocop:disable ClassVars
   class Configuration
-    attr_reader :default_level, :backtrace_level, :backtrace_level_index
+    attr_reader :default_level, :log_level_active_record, :backtrace_level, :backtrace_level_index
     attr_writer :host
     attr_accessor :app_name, :ap_options, :appenders, :log_executor, :filter_parameters, :metrics, :error_handler
 
     SUPPORTED_EXECUTORS = %i(single_thread_executor immediate_executor).freeze
     DEFAULT = {
-      log_level:         :info,
+      log_level:               :info,
+      log_level_active_record: :info,
       host:              nil,
       ap_options:        { multiline: false },
       appenders:         [{ stream: { io: STDOUT, formatter: :color } }],
@@ -26,7 +27,8 @@ module Sapience
       @options             = DEFAULT.merge(options.dup.deep_symbolize_keyz!)
       @options[:log_executor] &&= @options[:log_executor].to_sym
       validate_log_executor!(@options[:log_executor])
-      self.default_level     = @options[:log_level].to_sym
+      self.default_level           = @options[:log_level].to_sym
+      self.log_level_active_record = @options[:log_level_active_record].to_sym
       self.backtrace_level   = @options[:log_level].to_sym
       self.host              = @options[:host]
       self.app_name          = @options[:app_name]
@@ -45,6 +47,13 @@ module Sapience
       @default_level_index = level_to_index(level)
     end
 
+    # Sets the active record log level
+    def log_level_active_record=(level)
+      @log_level_active_record = level
+      # For performance reasons pre-calculate the level index
+      @log_level_active_record_index = level_to_index(level)
+    end
+
     # Returns the symbolic level for the supplied level index
     def index_to_level(level_index)
       LEVELS[level_index]

data/lib/sapience/extensions/grape/middleware/logging.rb

@@ -18,6 +18,30 @@ module Sapience
             @logger = @options[:logger]
           end
 
+          protected
+
+          def call!(env)
+            @env = env
+            before
+            error = catch(:error) do
+              begin
+                @app_response = @app.call(@env)
+              rescue => e
+                after_exception(e)
+                raise e
+              end
+              nil
+            end
+            if error
+              after_failure(error)
+              throw(:error, error)
+            else
+              @status, _, _ = *@app_response
+              after
+            end
+            @app_response
+          end
+
           def before
             reset_db_runtime
             start_time
@@ -26,16 +50,18 @@ module Sapience
           def after
             stop_time
             @logger.info(parameters)
-            nil
           end
 
-          protected
+          def after_exception(e)
+            Sapience.push_tags(e.class.name, e.message)
+            @status = 500
+            after
+          end
 
-          # TODO: Is NoMethodError :[] equal to `404`?
-          def response
-            super
-          rescue
-            nil
+          def after_failure(error)
+            Sapience.push_tags(error[:message])
+            @status = error[:status]
+            after
           end
 
           def parameters # rubocop:disable AbcSize
@@ -43,7 +69,7 @@ module Sapience
               method: request.request_method,
               request_path: request.path,
               format: request_format(request.env),
-              status: response.try(:status) || 404,
+              status: @status,
               class_name: env["api.endpoint"].options[:for].to_s,
               action: "index",
               host: request.host,
@@ -90,6 +116,7 @@ module Sapience
           def stop_time
             @stop_time ||= Time.now
           end
+
         end
       end
     end

data/lib/sapience/rails/engine.rb

@@ -73,8 +73,9 @@ module Sapience
         Sapience::Extensions::ActionController::LogSubscriber.attach_to :action_controller
         # Sapience::Extensions::ActiveSupport::MailerLogSubscriber.attach_to :action_mailer
         if defined?(ActiveRecord)
-          Sapience::Extensions::ActiveRecord::LogSubscriber.attach_to :active_record
           Sapience::Extensions::ActiveRecord::Notifications.use
+          ActiveRecord::Base.logger.level =
+              Sapience.config.log_level_active_record if defined?(ActiveRecord::Base.logger.level)
         end
 
         Sapience::Extensions::ActionView::LogSubscriber.attach_to :action_view

data/lib/sapience/version.rb

@@ -1,3 +1,3 @@
 module Sapience
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-31 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -378,7 +378,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Hasslefree autoconfiguration for logging, metrics and exception collection.