sapience 2.9.1 → 2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5e40be4c3c23734786e06c3be620bab6a2c1a9a
-  data.tar.gz: 3397ec7107fc0ac63f23809262c7cd793cd43e91
+  metadata.gz: 5ef38812e94717d5c17cbc973d7aef79deb1905a
+  data.tar.gz: c95f1ae7e46b15e7e9bbbac99ed2bad8705cfc9b
 SHA512:
-  metadata.gz: 5def20affb7f31b2ef491d458d1e8095cc54ab2db62ff6ca12016e200f20d91f7104b494702c45084431cc93006f60ef753314817f94ed34e1805a42dfcd677b
-  data.tar.gz: 15a71d7c1491305fda7a7157bbcd82caf01f6bdc7ca6fa409aa2cca4e2192629f128e223054db957ccb73afddc6a0139233e39e2e8c3485c193706d95b031373
+  metadata.gz: 7d4106483c8d8f01f3b8e869b4930f0a7a702702060d84052513a0b3ea8d481ce7df9d4eb4a352c9b9389e5306234726e2ad4ddbac5593cd19f385f9c696c993
+  data.tar.gz: ff0ad620ddb060381b8ce51f0579b9dcb8230920fe3bd27b594a83507584f0a74938119f1b344dbbfcd0eeb452f6399ac8ec1c8f0d54ea92be7a9004627ef107

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.4.10

data/.travis.yml

@@ -1,27 +1,15 @@
 sudo: required
 dist: trusty
-language: ruby
+language: minimal
 cache:
-  bundler: true
   directories:
     - $HOME/docker
-    - $BUNDLE_PATH
-    - ./vendor/bundle
 
 services:
   - docker
 
-before_install:
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v '< 2'
-
-install: bundle install --jobs 8 --retry 5
-
-before_script:
-  - mkdir -p coverage/rails coverage/grape coverage/sapience
-
 script:
-  - bundle exec rake reevoocop
+  - docker-compose run reevoocop
   - docker-compose run rspec
   - docker-compose run rails32
   - docker-compose run rails42
@@ -29,13 +17,3 @@ script:
   - docker-compose run grape
   - docker-compose run sinatra
 
-after_success:
-  - chown -R $(whoami) coverage
-  - bundle exec rake coverage:merge coverage:send
-
-notifications:
-  slack:
-    on_success: change
-    on_failure: change
-    on_pull_requests: false
-    secure: apFwkfBQ+3NDJgcLNCHQori9qtr6ePaN3Xx7Sy7NVWwYm9BHNxoX/FN8/hxR63JjXrf1C0hK0FLQ0TiA0BN9PgEEIecg78BvWUwMClDDiwhyYN3H0Bbg35PUFtgDIrOGpu/TYlxNmdHEDYEAxaWsl9wSds8pAJsN6m7VTjGfBwJUDcOiM4L1eRpbp7smPqOjmuQFuOJnO8YkPb+6nUfz53cJrMRUdha89Vgmvnw6cP4/Ms1TsL3vKmMSVbGGh/6WNKPjU6IbuUjwlsh6a9xWxQOk6Wnis/Z+kA+T0XbLMuTLLmzRDuql1tjJeMPi+wukmK1a7GjpPkpkzAgwLQ/CkjTBfIRbMyaBYSuAciuOY8PDtCcT4WLwEvdZbkFmhAdSr1RYxIBpONVfZ/5DT3bpk71+O74OIBqxG6NmkiZ0B6u9/KxbnIINLVAcVaqsN8sdSqWlWKzPm45BfGPXGjmGGgIVFU31rs+W5Zs7IYMNUjZxabYKIv9TsBONbogfbcoGZA+rWWUnQdjypNWJS9wyQDvJ4btxqy8YhDfaV6gF30Un5JcAggMutzKJiYi+qAeh0uN3/9XoXV2N6XBnh58h8ny1NY+0vklWhtFGR1wfFAqkDskvCIZabSeJ5bFM6FtNbNKq9tYciS+eAO1vEYQVDFt9eY2uZF2mFDKRnEegHMU=

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## v2.13
+- Add config option to enable/disable metrics from grape
+
+## v2.12
+- feature: 'log hooks', a mechanism for modifying the log event just before it is added to the appender
+
+## v2.11
+- Add config option to enable/disable metrics from ActionController
+
+## v2.10
+- Fix spec for Ruby 2.4.1
+- Bump version to 2.10 in order to properly highlight more significant change
+- Add missing Changelog entry
+
+## v2.9.1
+- Add support for sinatra applications by including `Sapience::Extensions::Sinatra::Middleware::Logging` middleware
+- Bump Ruby version to 2.4.1
+
 ## v2.9.0
 - Sapience will return more parameters in logs created by Rails::Rack::Logger
 
@@ -14,7 +32,7 @@
 - Include current environment in log entries
 
 ## v2.6.2
-- Bugfix: clear tags after pushing log to processing queue 
+- Bugfix: clear tags after pushing log to processing queue
 
 ## v2.6.1
 - Bugfix: Fix sentry logging when payload is nil

data/README.md

@@ -22,6 +22,15 @@ Add the gem:
 gem "sapience", require: "sapience/rails"
 ```
 
+The rails integration has the following configuration options:
+
+| Option                | Description | Values    | Default |
+| --------------------- | ---------- | ------     | ----- |
+| silent_rails          | less noisy rails logs       | `boolean`  | `true` |
+| silent_rack           | suppress "Request Started..." log message from rack | `boolean`  | `true` |
+| silent_active_record  | emit metrics from ActiveRecord    | `boolean`  | `true` |
+| rails_ac_metrics      | emit metrics from ActionController | `boolean`  | `true` |
+
 ### Sinatra
 Add the gem:
 
@@ -119,6 +128,13 @@ 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
 rack logger so you don't get double logging.
 
+
+The grape integration has the following configuration options:
+
+| Option                | Description | Values    | Default |
+| --------------------- | ---------- | ------     | ----- |
+| grape_metrics         | emit metrics from grape | `boolean`  | `true` |
+
 ### Standalone
 Add the gem:
 
@@ -156,6 +172,10 @@ Or if you, like us, have many projects that use the same configuration you can c
 default:
   app_name: My Application
   log_level: debug
+  silent_active_record: true
+  silent_rails: true
+  silent_rack: true
+  rails_ac_metrics: true
   appenders:
     - stream:
         io: STDOUT
@@ -236,6 +256,34 @@ For further details about "app_name", "filter_parameters", "appenders", "metrics
 - [logger](docs/logger.md)
 
 
+### Log hooks
+*Log hooks* allow us to modify the log object **Sapience::Log** just before it is added to the appender. A 'log hook' can be an object that responds to #call. Multiple hooks can be used.
+The following examples show how to use hooks to:
+
+  * inject Datadog APM tracing data in every log event.
+  * modify the logs event's **message** field.
+
+```ruby
+my_logger = Sapience.logger
+
+# inject Datadog tracing info in payload hash
+my_logger.log_hooks << ->(log) do
+  trace_data = { 
+    dd: { 
+      span_id:  ::Datadog.tracer.active_correlation.span_id.to_s, 
+      trace_id: ::Datadog.tracer.active_correlation.trace_id.to_s 
+    }
+  }
+  log.payload? ? log.payload.merge!(trace_data) : log.payload = trace_data
+end
+
+# append number of times a GC occurred since process started in field 'message'
+my_logger.log_hooks << ->(log) do
+  log.message = "#{log.message} = GC count: #{GC.count}"
+end
+```
+
+
 ## Running the tests
 
 You need to create the test postgres db, by running the command below:

data/docker-compose.yml

@@ -8,13 +8,13 @@ services:
       RABBITMQ_DEFAULT_PASS: tests
 
   postgres:
-    image: postgres:latest
+    image: postgres:9
     environment:
       POSTGRES_USER: sapience
       POSTGRES_PASSWORD: tests
 
   base:
-    image: ruby:2.3
+    image: ruby:2.4
     cpu_shares: 4
     # Specify the directory from where all commands sent to the container will be
     # issued to where the code is mounted:
@@ -32,7 +32,13 @@ services:
       # "/usr/src/app" folder:
       - .:/usr/src/app
 
-
+  reevoocop:
+    extends:
+      service: base
+    entrypoint: /usr/src/app/dev-entrypoint.sh
+    command: bundle exec rake reevoocop
+    environment:
+      PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 
   rspec:
     extends:
@@ -46,11 +52,10 @@ services:
       PATH: /usr/src/app/bin:/usr/local/bundle/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
 
 
-
   rails32:
     extends:
       service: base
-    image: ruby:2.1
+    image: ruby:2.3
     working_dir: /usr/src/app/test_apps/rails_3_2
     entrypoint: /usr/src/app/dev-entrypoint.sh
     command: bundle exec rspec

data/lib/sapience/base.rb

@@ -3,7 +3,7 @@ module Sapience
   # rubocop:disable ClassLength
   class Base
     # Class name to be logged
-    attr_accessor :name, :filter
+    attr_accessor :name, :filter, :log_hooks
     include Sapience::LogMethods
 
     # Set the logging level for this logger
@@ -174,7 +174,7 @@ module Sapience
     #    Proc: Only include log messages where the supplied Proc returns true
     #          The Proc must return true or false
     # rubocop:disable AbcSize, PerceivedComplexity, CyclomaticComplexity, LineLength
-    def initialize(klass, level = nil, filter = nil)
+    def initialize(klass, level = nil, filter = nil, log_hooks = [])
       # Support filtering all messages to this logger using a Regular Expression
       # or Proc
       fail ArgumentError, ":filter must be a Regexp or Proc" unless filter.nil? || filter.is_a?(Regexp) || filter.is_a?(Proc)
@@ -183,6 +183,7 @@ module Sapience
       @name   = klass if klass.is_a?(String)
       @name ||= klass.name if klass.respond_to?(:name)
       @name ||= klass.class.name
+      @log_hooks = log_hooks
 
       if level.nil?
         # Allow the global default level to determine this loggers log level
@@ -271,6 +272,9 @@ module Sapience
         end
         log.payload = payload unless payload.empty?
       end
+
+      log_hooks.each { |h| h.call(log) }
+
       self.log(log) if include_message?(log)
     end
     # rubocop:enable AbcSize, PerceivedComplexity, CyclomaticComplexity, LineLength

data/lib/sapience/configuration.rb

@@ -8,7 +8,8 @@ module Sapience
     attr_reader :default_level, :backtrace_level, :backtrace_level_index
     attr_writer :host
     attr_accessor :app_name, :ap_options, :appenders, :log_executor, :filter_parameters,
-      :metrics, :error_handler, :silent_active_record, :silent_rails, :silent_rack
+      :metrics, :error_handler, :silent_active_record, :silent_rails, :silent_rack,
+      :rails_ac_metrics, :grape_metrics
 
     SUPPORTED_EXECUTORS = %i(single_thread_executor immediate_executor).freeze
     DEFAULT = {
@@ -23,6 +24,8 @@ module Sapience
       silent_active_record: false,
       silent_rails:      false,
       silent_rack:       false,
+      rails_ac_metrics:  true,
+      grape_metrics:     true,
     }.freeze
 
     # Initial default Level for all new instances of Sapience::Logger
@@ -44,6 +47,8 @@ module Sapience
       self.silent_active_record = @options[:silent_active_record]
       self.silent_rails      = @options[:silent_rails]
       self.silent_rack       = @options[:silent_rack]
+      self.rails_ac_metrics  = @options[:rails_ac_metrics]
+      self.grape_metrics     = @options[:grape_metrics]
     end
 
     # Sets the global default log level

data/lib/sapience/grape.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require "sapience"
 require "sapience/extensions/grape/timings"
+require "grape"
 require "sapience/extensions/grape/middleware/logging"
 require "sapience/extensions/grape/notifications"
 
@@ -18,6 +19,6 @@ module Sapience
     end
     Sapience.configure
     ::Grape::API.send(:include, Sapience::Loggable)
-    Sapience::Extensions::Grape::Notifications.use
+    Sapience::Extensions::Grape::Notifications.use if Sapience.config.grape_metrics
   end
 end

data/lib/sapience/rails/engine.rb

@@ -42,12 +42,14 @@ module Sapience
         # Replace the Sidekiq logger
         Sidekiq::Logging.logger     = Sapience[Sidekiq] if defined?(Sidekiq)
 
-        # Replace the Sequel logger
-        Sequel::Database.logger     = Sapience[Sequel] if defined?(Sequel::Database)
-
         # Replace the Sidetiq logger
         Sidetiq.logger              = Sapience[Sidetiq] if defined?(Sidetiq)
 
+        # Replace the Sequel logger
+        if defined?(Sequel::Database) && Sequel::Database.respond_to?(:logger=)
+          Sequel::Database.logger = Sapience[Sequel]
+        end
+
         # Replace the Raven logger
         # Raven::Configuration.logger = Sapience[Raven::Configuration] if defined?(Raven::Configuration)
         Raven.send(:include, Sapience::Loggable)
@@ -83,7 +85,7 @@ module Sapience
         end
         Sapience::Extensions::ActionView::LogSubscriber.attach_to :action_view
         # Sapience::Extensions::ActiveJob::LogSubscriber.attach_to :active_job
-        Sapience::Extensions::ActionController::Notifications.use
+        Sapience::Extensions::ActionController::Notifications.use if Sapience.config.rails_ac_metrics
         Sapience::Extensions::ActiveJob::Notifications.use if defined?(ActiveJob)
       end
     end

data/lib/sapience/version.rb

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

data/sapience.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby", "~> 1.0"
   spec.add_development_dependency "active_model_serializers", "~> 0.10.0"
   spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "dogstatsd-ruby", "~> 2.0"
   spec.add_development_dependency "fuubar"
@@ -36,8 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "grape"
   spec.add_development_dependency "memory_profiler"
   spec.add_development_dependency "pry-nav"
-  spec.add_development_dependency "rails", "~> 5.0.0.1"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails", "~> 5.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "reevoocop"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-its"

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: 2.9.1
+  version: '2.14'
 platform: ruby
 authors:
 - Mikael Henriksson
 - Alex Malkov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -57,16 +57,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -171,28 +171,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: reevoocop
   requirement: !ruby/object:Gem::Requirement
@@ -389,7 +389,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -404,9 +404,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14.4
+signing_key:
 specification_version: 4
 summary: Hasslefree autoconfiguration for logging, metrics and exception collection.
 test_files: []