sapience 2.8 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 024b1f87a65b6939586988761c7efb9cddb9a283
-  data.tar.gz: 5e5e3643ce29f0d069a21b74ffd498c1524f02df
+  metadata.gz: a5e40be4c3c23734786e06c3be620bab6a2c1a9a
+  data.tar.gz: 3397ec7107fc0ac63f23809262c7cd793cd43e91
 SHA512:
-  metadata.gz: d9b3871d833007b403e53d8ff2fb8e60d55b3f00ac9b6e9f1c1f1bd64a3c26710253e3c95341faf41921990d964103797f13fb453ae0ae30f899f217c53708ae
-  data.tar.gz: 565af71953174f4528a4c30f4177e7c691eb95116ccedc0ea27ffd8b4ff459fe4243d1b7ac01912db279b0a2b94d4b70bde8b989048298eb5db517590b1e5b2b
+  metadata.gz: 5def20affb7f31b2ef491d458d1e8095cc54ab2db62ff6ca12016e200f20d91f7104b494702c45084431cc93006f60ef753314817f94ed34e1805a42dfcd677b
+  data.tar.gz: 15a71d7c1491305fda7a7157bbcd82caf01f6bdc7ca6fa409aa2cca4e2192629f128e223054db957ccb73afddc6a0139233e39e2e8c3485c193706d95b031373

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.1

data/.travis.yml

@@ -27,6 +27,7 @@ script:
   - docker-compose run rails42
   - docker-compose run rails50
   - docker-compose run grape
+  - docker-compose run sinatra
 
 after_success:
   - chown -R $(whoami) coverage

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v2.9.0
+- Sapience will return more parameters in logs created by Rails::Rack::Logger
+
 ## v2.8.0
 - Silence rails rack logger for rails 3 by setting `silent_rack: true` in sapience.yml
 

data/README.md

@@ -22,6 +22,33 @@ Add the gem:
 gem "sapience", require: "sapience/rails"
 ```
 
+### Sinatra
+Add the gem:
+
+```ruby
+gem "sapience", require: "sapience/sinatra"
+```
+
+In your Base API class
+
+```ruby
+require "sapience/grape"
+
+module Aslan
+  module API
+    class Base < Sinatra::Base
+      use Sapience::Extensions::Sinatra::Middleware::Logging, logger: Sapience[self]
+
+      get "/ping" do
+        { ping: "PONG" }
+      end
+    end
+  end
+end
+
+```
+
+
 ### Grape
 Add the gem:
 
@@ -49,11 +76,11 @@ end
 
 ```
 
-Also make sure you only use "rescue_from" when you want to return a 500 status. For any other status "dont" use 
+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 
+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:
 
 
@@ -67,10 +94,10 @@ before do
 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 
+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
@@ -79,7 +106,7 @@ rescue_from :all do |e|
 end
 ```
 
-**Note**: if you already have got your grape applications sprinkled with calls to API.logger, and you do 
+**Note**: if you already have got your grape applications sprinkled with calls to API.logger, and you do
 not want to have to replace all those calls to Sapience.logger manually, then just re-assign your logger
 after including the Sapience middleware, like below:
 
@@ -89,7 +116,7 @@ API.logger = Sapience.logger
 ```
 
 
-**Note**: If you're using the rackup command to run your server in development, pass the -q flag to silence the default 
+**Note**: If you're using the rackup command to run your server in development, pass the -q flag to silence the default
 rack logger so you don't get double logging.
 
 ### Standalone
@@ -149,7 +176,7 @@ development:
     - stream:
         file_name: log/development.log
         formatter: color
-        
+
 staging:
   log_level: info
   error_handler:
@@ -162,7 +189,7 @@ staging:
     - stream:
         io: STDOUT
         formatter: json
-        
+
 production:
   log_level: info
   silent_rails: true # make rails logging less noisy

data/docker-compose.yml

@@ -108,3 +108,13 @@ services:
     environment:
       APP_NAME: grape_app
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+
+  sinatra:
+    extends:
+      service: base
+    working_dir: /usr/src/app/test_apps/sinatra
+    entrypoint: /usr/src/app/dev-entrypoint.sh
+    command: bundle exec rspec
+    environment:
+      APP_NAME: sinatra_app
+      PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

data/lib/sapience/extensions/rails/rack/logger.rb

@@ -1,13 +1,23 @@
 # frozen_string_literal: true
 # Replace rack started message with a semantic equivalent
+# request attributes taken from:
+# https://github.com/rails/rails/blob/3-2-stable/actionpack/lib/action_dispatch/http/request.rb
+
 class Rails::Rack::Logger # rubocop:disable ClassAndModuleChildren
   alias started_request_message_original started_request_message
-  def started_request_message(request)
+  def started_request_message(request) # rubocop:disable AbcSize
     {
-      message: "Started",
+      message: "Started #{request.request_method} #{request.filtered_path}",
       method:  request.request_method,
       path:    request.filtered_path,
-      ip:      request.ip,
+      fullpath: request.fullpath,
+      original_fullpath: request.original_fullpath,
+      ip:      request.env["HTTP_X_FORWARDED_FOR"] || request.remote_addr,
+      client_ip: request.ip,
+      remote_ip: request.remote_ip,
+      remote_host: request.env["HTTP_X_FORWARDED_HOST"] || request.remote_host,
+      content_type: request.media_type,
+      request_id: request.uuid,
     }
   end
 end

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Sapience
+  module Extensions
+    module Sinatra
+      module Middleware
+        class Logging
+
+          if defined?(ActiveRecord)
+            ActiveSupport::Notifications.subscribe("sql.active_record") do |*args|
+              event = ActiveSupport::Notifications::Event.new(*args)
+              Sinatra::Timings.append_db_runtime(event)
+            end
+          end
+
+          def initialize(app, options = {})
+            @app = app
+            @logger = options[:logger]
+          end
+
+          def call(env)
+            call!(env)
+          end
+
+          protected
+
+          def call!(env)
+            @env = env
+            before
+            error = catch(:error) do
+              begin
+                @app_response = @app.call(@env)
+              rescue StandardError => 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
+          end
+
+          def after
+            stop_time
+            @logger.info(parameters)
+          end
+
+          def after_exception(exc) # rubocop:disable Lint/UnusedMethodArgument
+            @status = 500
+            after
+          end
+
+          def after_failure(error)
+            @status = error[:status]
+            after
+          end
+
+          def parameters # rubocop:disable AbcSize
+            {
+              method: request.request_method,
+              request_path: @env["REQUEST_URI"] || @env["PATH_INFO"],
+              status: @status,
+              route: @env["sinatra.route"].to_s,
+              host: request.host,
+              ip: (request.env["HTTP_X_FORWARDED_FOR"] || request.env["REMOTE_ADDR"]),
+              ua: request.env["HTTP_USER_AGENT"],
+              tags: Sapience.tags,
+              params: request.params,
+              runtimes: {
+                total: total_runtime,
+                view: view_runtime,
+                db: db_runtime,
+              },
+            }
+          end
+
+          private
+
+          def request
+            @request ||= ::Rack::Request.new(@env)
+          end
+
+          def total_runtime
+            ((stop_time - start_time) * 1000).round(3)
+          end
+
+          def view_runtime
+            total_runtime - db_runtime
+          end
+
+          def db_runtime
+            Sinatra::Timings.db_runtime.round(3)
+          end
+
+          def reset_db_runtime
+            Sinatra::Timings.reset_db_runtime
+          end
+
+          def start_time
+            @start_time ||= Time.now
+          end
+
+          def stop_time
+            @stop_time ||= Time.now
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/sapience/extensions/sinatra/timings.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Sapience
+  module Extensions
+    module Sinatra
+      module Timings
+        extend self
+
+        def db_runtime=(value)
+          Thread.current[:grape_db_runtime] = value
+        end
+
+        def db_runtime
+          Thread.current[:grape_db_runtime] ||= 0
+        end
+
+        def reset_db_runtime
+          self.db_runtime = 0
+        end
+
+        def append_db_runtime(event)
+          self.db_runtime += event.duration
+        end
+      end
+    end
+  end
+end

data/lib/sapience/sinatra.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require "sapience"
+require "sapience/extensions/sinatra/timings"
+require "sapience/extensions/sinatra/middleware/logging"
+
+module Sinatra
+  class Base
+    extend Sapience::Descendants
+  end
+end
+
+module Sapience
+  class Sinatra
+    Sapience.configure
+    ::Sinatra::Base.send(:include, Sapience::Loggable)
+  end
+end

data/lib/sapience/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sapience
-  VERSION = "2.8"
+  VERSION = "2.9.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: '2.8'
+  version: 2.9.1
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -358,6 +358,8 @@ files:
 - lib/sapience/extensions/notifications.rb
 - lib/sapience/extensions/rails/rack/logger.rb
 - lib/sapience/extensions/rails/rack/logger_info_as_debug.rb
+- lib/sapience/extensions/sinatra/middleware/logging.rb
+- lib/sapience/extensions/sinatra/timings.rb
 - lib/sapience/formatters/base.rb
 - lib/sapience/formatters/color.rb
 - lib/sapience/formatters/default.rb
@@ -376,6 +378,7 @@ files:
 - lib/sapience/rails/railtie.rb
 - lib/sapience/rails/silencer.rb
 - lib/sapience/sapience.rb
+- lib/sapience/sinatra.rb
 - lib/sapience/sneakers.rb
 - lib/sapience/subscriber.rb
 - lib/sapience/version.rb
@@ -402,7 +405,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Hasslefree autoconfiguration for logging, metrics and exception collection.