sapience 2.10 → 2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8328fe94f351331e7594422f677311ba6363758a907930a25d21d044b26546c
-  data.tar.gz: a3504915777fc5ce3faf0ea8b8e310269b8cba1d0c6b9ad7013bec43884a4046
+  metadata.gz: a617af7787dbacebb45f2dcbfd6ec0c930e1d436488d37507bbd85e2f2856778
+  data.tar.gz: 68ebecc04c1377f17fd48d9f3e24cd0eab3b8bc813e14aa237426472e7377fc5
 SHA512:
-  metadata.gz: ffcd578e958d88c52a12ebe6926478d7fec5077dc4d5d328a14e0bb088337758f3e81ab40e1a996211cac07d64cd6b66e73a1cf51b23ebb7eb7a953802146308
-  data.tar.gz: f88677aa78333f3b804c50c9b3cad868d2d37fe71dbd994ba165943f657f40ba78d0e9a620c8b2b23aea98a82dd2b39fcfe1c781bdae8ca4470d74675fce231e
+  metadata.gz: 64ac6ba2a9084b6903aec351acc2811b272502a00ea366e80bc060e687fd2b6ad86aec8d348bdcc5f7ed1655369ef1d59c0441255ff46c37d7c5ebefeaa58df9
+  data.tar.gz: f514453bb97eb2a139b0c5139fc8a2e6215299f47a60da60df849e982fbc98da51f85e74dfa8b927bdf7fde753f0af20a9de5a3358120804cd66751e03f64433

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 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
+
 ## v2.10
 - Fix spec for Ruby 2.4.1
 - Bump version to 2.10 in order to properly highlight more significant change

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/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

@@ -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/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)
@@ -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.10"
+  VERSION = "2.15"
 end

data/sapience.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   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 "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.10'
+  version: '2.15'
 platform: ruby
 authors:
 - Mikael Henriksson
 - Alex Malkov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -183,16 +183,16 @@ dependencies:
   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,8 +404,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Hasslefree autoconfiguration for logging, metrics and exception collection.
 test_files: []