timber 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2575049d24c209a60b30d3c307d948a4dd6fd96
-  data.tar.gz: 5f2fa7d925b449836a7b17f6ade39a69d9d2138e
+  metadata.gz: b8e5de46982d4346797f2fcefba7f45d601bc6cd
+  data.tar.gz: 2a46a4fbc36cb8b6de0901cb138aeb7249ddd931
 SHA512:
-  metadata.gz: c6cefa704196b834836c4ec586a2aba41a27bdab0e11d9ca943a0ffca8425768c45c2ce71fd35f05f8aab935f2ad822e556d930736d7055f5a6515872b7f97de
-  data.tar.gz: afc046c48f805a946fd49353b3a56629bc1557df302790d88b9c15fb51fa5d16f2cf4569e63f5fa7a14d9ece7b4bedf16646c64e3005435c154809231af5da61
+  metadata.gz: 81c9834d338f1d54f15df5c36802e761c3725da1cc36de4c46992fc7cc536ff6d0630678666937d22e0181dffdc7c1790ff2c4a4046732d8cdf352ccee60cb36
+  data.tar.gz: 8167bb8a446d336b4f798da86f10d66b1b67cba12f1d95f4c0a1be828d08526add3346916451f4a02226f469320c476a43ff1372a2f67384d68500e63a0553a9

data/lib/timber/config.rb

@@ -18,14 +18,28 @@ module Timber
 
     include Singleton
 
-    attr_writer :append_metadata, :debug_logger, :http_body_limit, :logger
+    attr_writer :append_metadata, :debug_logger, :header_filters, :http_body_limit, :logger
 
     # @private
     def initialize
+      @header_filters = []
       @http_body_limit = 2000
     end
 
+    # This is useful for debugging. This Sets a debug_logger to view internal Timber library
+    # log messages. The default is `nil`. Meaning log to nothing.
+    #
+    # @example Rails
+    #   config.timber.debug_logger = ::Logger.new(STDOUT)
+    # @example Everything else
+    #   Timber::Config.instance.debug_logger = ::Logger.new(STDOUT)
+    def debug_logger
+      @debug_logger
+    end
+
     # The environment your app is running in. Defaults to `RACK_ENV` and `RAILS_ENV`.
+    # It should be rare that you have to set this. If the aforementioned env vars are not
+    # set please do.
     #
     # @example Rails
     #   config.timber.environment = "staging"
@@ -35,21 +49,21 @@ module Timber
       @environment ||= ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
     end
 
-    # Set a debug_logger to view internal Timber library log message.
-    # Useful for debugging. Defaults to `nil`. If set, debug messages will be
-    # written to this logger.
+    # This is a list of header keys that should be filtered. Note, all headers are
+    # normalized to down-case. So please _only_ pass down-cased headers.
     #
     # @example Rails
-    #   config.timber.debug_logger = ::Logger.new(STDOUT)
-    # @example Everything else
-    #   Timber::Config.instance.debug_logger = ::Logger.new(STDOUT)
-    def debug_logger
-      @debug_logger
+    #   # config/environments/production.rb
+    #   config.timber.filter_headers += ['api-key']
+    def header_filters
+      @header_filters
     end
 
     # Truncates captured HTTP bodies to this specified limit. The default is `2000`.
     # If you want to capture more data, you can raise this to a maximum of `5000`,
-    # or lower this to be more efficient with data.
+    # or lower this to be more efficient with data. `2000` characters should give you a good
+    # idea of the body content. If you need to raise to `5000` you're only constraint is
+    # network throughput.
     #
     # @example Rails
     #   config.timber.http_body_limit = 500
@@ -59,12 +73,13 @@ module Timber
       @http_body_limit
     end
 
-    # Should the logger append the Timber metadata. This is automatically turned on
-    # for production and staging environments. Other environments should be set manually.
-    # If set to `true` log messages will look like:
+    # This determines if the log messages should have metadata appended. Ex:
     #
     #     log message @metadata {...}
     #
+    # By default, this is turned on for production and staging environments only. Other
+    # environment should set this setting explicitly.
+    #
     # @example Rails
     #   config.timber.append_metadata = false
     # @example Everything else
@@ -77,10 +92,9 @@ module Timber
       production? || staging?
     end
 
-    # This is the logger Timber writes to. All of the Timber integrations write to
-    # this logger. It should be set to your global logger to keep the logging destination consitent.
-    #
-    # For Rails this is set automatically to `Rails.logger`.
+    # This is the _main_ logger Timber writes to. All of the Timber integrations write to
+    # this logger instance. It should be set to your global logger. For Rails, this is set
+    # automatically to `Rails.logger`, you should not have to set this.
     #
     # @example Rails
     #   Rails.logger = Timber::Logger.new(STDOUT)

data/lib/timber/util/http_event.rb

@@ -31,7 +31,11 @@ module Timber
             when AUTHORIZATION_HEADER
               h[k] = SANITIZED_VALUE
             else
-              h[k] = v
+              if Config.instance.header_filters && Config.instance.header_filters.include?(k)
+                h[k] = SANITIZED_VALUE
+              else
+                h[k] = v
+              end
             end
           end
         else
@@ -48,7 +52,7 @@ module Timber
           query_string = query_string.to_s
         end
 
-        query_string[0..(QUERY_STRING_LIMIT - 1)]
+        query_string && query_string[0..(QUERY_STRING_LIMIT - 1)]
       end
     end
   end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.0.6"
+  VERSION = "2.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack