sapience 2.11 → 3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4dea67688e4da16e54b354ef95c3307c40b4c48a7a9c731b036a759301993bad
-  data.tar.gz: e95f42b7e1b564b96436119394c5cf36bfe764e151edc27f3bdd71571d373ff3
+SHA1:
+  metadata.gz: c23794042cc619577603ac314507edf82fe9c668
+  data.tar.gz: 5d1908e88b61c429f295cb59d64620039c5737b1
 SHA512:
-  metadata.gz: 9d44242c65762e0696ff3b34256d2ee67cee441c1a957efb988ecebaa6abd340ba2e02e1fbd5168973262e689333b7bbc4e4fd5835bc9a5472b22fbb2990c15d
-  data.tar.gz: b803898eee7e30eedfcf704d9befc942e518e53da773fe699888d6c4cdfe79402ce4bdb7f9bbfdb5f1a14b2b78cc0d7101e658c32fe1da01c181c50a80f24fc0
+  metadata.gz: 48b75236add0e85e523e0695b6b1639f483cf5a68e3b4123f0b9e9ff6481ff8aa3460659764d3cd517b5a93b5e25cb7ea2819601eee04c5408037cb1e266349b
+  data.tar.gz: 06a282085bdc1f8b6af10db16ec081e0272cd126700d6ffb5374b28bcad6089d3a34016d8fc8e8dd066daf954428275ea097cf8e738f24600a3056516b8bb02d

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## v3.0
+- Updating gem dependencies:
+  - bundler -> 1.17.3
+  - dogstatsd -> 5.2.0
+  - rspec -> 3.10.0
+  - sentry-raven -> 3.1.2
+
+## v2.15
+- The Formatter can now be configured to exclude selected log fields.
+  Currently only the Json formatter implements this.
+
+## 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
 

data/README.md

@@ -128,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:
 
@@ -249,15 +256,62 @@ 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:
+You can run all of them with the following command:
+
+`docker-compose up`
+
+To run particular tests use the following commands:
+
+Reevoocop:
+`docker-compose up reevoocop`
+
+Rspec:
+`docker-compose up rspec`
+
+Rspec with Rails 3.2:
+`docker-compose up rails32`
+
+Rspec with Rails 4.2:
+`docker-compose up rails42`
 
-`createdb rails_app_test`
+Rspec with Rails 5.0:
+`docker-compose up rails50`
 
-Then you can run them with the following command:
+Rspec with Grape:
+`docker-compose up grape`
 
-`bin/tests`
+Rspec with Sinatra:
+`docker-compose up sinatra`
 
 ## Environment variables
 

data/docs/appenders/formatters.md

@@ -13,6 +13,58 @@ Formatters can be specified by using the key `formatter: :camelized_formatter_na
 ### JSON
 
 `formatter: :json` - logs are saved as a single line json. Useful for production like environments.
+The json formatter can be configured to filter out select log fields. The following configuration demonstrates this:
+
+```yaml
+json_formatter: &json_slim
+  json:
+    exclude_fields:
+      - "name"
+      - "request_id"
+      - "thread"
+      - "pid"
+      - "level_index"
+      - "host"
+      - "app_name"
+      - "request_id"
+      - "action"
+      - "controller"
+      - "route"
+      - "file"
+      - "line"
+      - "format"
+      - "tags"
+
+ci:
+  log_level: warn
+  appenders:
+    - stream:
+        io: STDOUT
+        formatter: color
+
+production:
+  log_level: info
+  appenders:
+    - stream:
+        io: STDOUT
+        formatter:
+          <<: *json_slim
+
+staging:
+  log_level: info
+  appenders:
+    - stream:
+        io: STDOUT
+        formatter:
+          <<: *json_slim
+
+development:
+  log_level: debug
+  appenders:
+    - stream:
+        io: STDOUT
+        formatter: json
+```
 
 ### RAW
 

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/config_loader.rb

@@ -70,12 +70,13 @@ module Sapience
         if YAML.respond_to?(:safe_load) # Ruby 2.1+
           if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
             SafeYAML.load(yaml_code, filename,
-              whitelisted_tags: %w(!ruby/regexp))
+              whitelisted_tags: %w(!ruby/regexp),
+              aliases: true)
           else
-            YAML.safe_load(yaml_code, [Regexp], [], false, filename)
+            YAML.safe_load(yaml_code, [Regexp], [], true, filename)
           end
         else
-          YAML.safe_load(yaml_code, filename)
+          YAML.safe_load(yaml_code, filename, aliases: true)
         end
       end
     end

data/lib/sapience/configuration.rb

@@ -9,7 +9,7 @@ module Sapience
     attr_writer :host
     attr_accessor :app_name, :ap_options, :appenders, :log_executor, :filter_parameters,
       :metrics, :error_handler, :silent_active_record, :silent_rails, :silent_rack,
-      :rails_ac_metrics
+      :rails_ac_metrics, :grape_metrics
 
     SUPPORTED_EXECUTORS = %i(single_thread_executor immediate_executor).freeze
     DEFAULT = {
@@ -25,6 +25,7 @@ module Sapience
       silent_rails:      false,
       silent_rack:       false,
       rails_ac_metrics:  true,
+      grape_metrics:     true,
     }.freeze
 
     # Initial default Level for all new instances of Sapience::Logger
@@ -46,7 +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.rails_ac_metrics  = @options[:rails_ac_metrics]
+      self.grape_metrics     = @options[:grape_metrics]
     end
 
     # Sets the global default log level

data/lib/sapience/formatters/base.rb

@@ -2,7 +2,7 @@
 module Sapience
   module Formatters
     class Base
-      attr_accessor :time_format, :precision, :log_host, :log_application
+      attr_accessor :time_format, :default_time_format, :precision, :log_host, :log_application, :exclude_fields
 
       # Parameters
       #   time_format: [String|Symbol|nil]
@@ -11,13 +11,9 @@ module Sapience
       #     nil:      Returns Empty string for time ( no time is output ).
       #     Default: '%Y-%m-%d %H:%M:%S.%6N'
       def initialize(options = {})
-        options          = options.dup
-        @precision       = 6
-        default_format   = "%Y-%m-%d %H:%M:%S.%#{precision}N"
-        @time_format     = options.key?(:time_format) ? options.delete(:time_format) : default_format
-        @log_host        = options.key?(:log_host) ? options.delete(:log_host) : true
-        @log_application = options.key?(:log_application) ? options.delete(:log_application) : true
-        fail(ArgumentError, "Unknown options: #{options.inspect}") unless options.empty?
+        @precision           = 6
+        @default_time_format = "%Y-%m-%d %H:%M:%S.%#{precision}N"
+        parse_options(options.dup)
       end
 
       # Return the Time as a formatted string
@@ -32,6 +28,15 @@ module Sapience
         end
       end
 
+      private
+
+      def parse_options(options)
+        @time_format     = options.key?(:time_format) ? options.delete(:time_format) : default_time_format
+        @log_host        = options.key?(:log_host) ? options.delete(:log_host) : true
+        @log_application = options.key?(:log_application) ? options.delete(:log_application) : true
+        @exclude_fields  = options.key?(:exclude_fields) ? options.delete(:exclude_fields).map(&:to_sym) : {}
+        fail(ArgumentError, "Unknown options: #{options.inspect}") unless options.empty?
+      end
     end
   end
 end

data/lib/sapience/formatters/json.rb

@@ -13,9 +13,25 @@ module Sapience
       # Returns log messages in JSON format
       def call(log, logger)
         h = super(log, logger)
-        h.delete(:time)
-        h[:timestamp] = format_time(log.time)
-        h.to_json
+        prepare(h, log).to_json
+      end
+
+      private
+
+      def prepare(log_hash, log)
+        set_timestamp(log_hash, log)
+        remove_fields(log_hash)
+        log_hash
+      end
+
+      def set_timestamp(log_hash, log)
+        log_hash.delete(:time)
+        log_hash[:timestamp] = format_time(log.time)
+        log_hash
+      end
+
+      def remove_fields(log_hash)
+        log_hash.delete_if { |k, _v| exclude_fields.include?(k.to_sym) } if exclude_fields.any?
       end
     end
   end

data/lib/sapience/grape.rb

@@ -19,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)

data/lib/sapience/version.rb

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

data/sapience.gemspec

@@ -28,9 +28,9 @@ 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"
+  spec.add_development_dependency "bundler", "~> 1.17.3"
   spec.add_development_dependency "codeclimate-test-reporter"
-  spec.add_development_dependency "dogstatsd-ruby", "~> 2.0"
+  spec.add_development_dependency "dogstatsd-ruby", "~> 5.2.0"
   spec.add_development_dependency "fuubar"
   spec.add_development_dependency "gem-release"
   spec.add_development_dependency "grape"
@@ -39,10 +39,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rails", "~> 5.0.0.1"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "reevoocop"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
   spec.add_development_dependency "rspec-its"
   spec.add_development_dependency "rspec-prof"
-  spec.add_development_dependency "sentry-raven"
+  spec.add_development_dependency "sentry-raven", "~> 3.1.2"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-json"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: '2.11'
+  version: '3.0'
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -213,14 +213,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -253,16 +253,16 @@ dependencies:
   name: sentry-raven
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -404,7 +404,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Hasslefree autoconfiguration for logging, metrics and exception collection.