sapience 2.14 → 2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5ef38812e94717d5c17cbc973d7aef79deb1905a
-  data.tar.gz: c95f1ae7e46b15e7e9bbbac99ed2bad8705cfc9b
+SHA256:
+  metadata.gz: a617af7787dbacebb45f2dcbfd6ec0c930e1d436488d37507bbd85e2f2856778
+  data.tar.gz: 68ebecc04c1377f17fd48d9f3e24cd0eab3b8bc813e14aa237426472e7377fc5
 SHA512:
-  metadata.gz: 7d4106483c8d8f01f3b8e869b4930f0a7a702702060d84052513a0b3ea8d481ce7df9d4eb4a352c9b9389e5306234726e2ad4ddbac5593cd19f385f9c696c993
-  data.tar.gz: ff0ad620ddb060381b8ce51f0579b9dcb8230920fe3bd27b594a83507584f0a74938119f1b344dbbfcd0eeb452f6399ac8ec1c8f0d54ea92be7a9004627ef107
+  metadata.gz: 64ac6ba2a9084b6903aec351acc2811b272502a00ea366e80bc060e687fd2b6ad86aec8d348bdcc5f7ed1655369ef1d59c0441255ff46c37d7c5ebefeaa58df9
+  data.tar.gz: f514453bb97eb2a139b0c5139fc8a2e6215299f47a60da60df849e982fbc98da51f85e74dfa8b927bdf7fde753f0af20a9de5a3358120804cd66751e03f64433

data/.ruby-version

@@ -1 +1 @@
-2.4.10
+2.4.9

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 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
 

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

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sapience
-  VERSION = "2.14"
+  VERSION = "2.15"
 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"
+  spec.add_development_dependency "bundler", "~> 1"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "dogstatsd-ruby", "~> 2.0"
   spec.add_development_dependency "fuubar"
@@ -36,7 +36,7 @@ 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"
+  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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapience
 version: !ruby/object:Gem::Version
-  version: '2.14'
+  version: '2.15'
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-05-17 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: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -171,14 +171,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -404,8 +404,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.14.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Hasslefree autoconfiguration for logging, metrics and exception collection.