config.rb in timber-2.0.7

- old
+ new

@@ -16,57 +16,72 @@
     PRODUCTION_NAME = "production".freeze
     STAGING_NAME = "staging".freeze
 
     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"
     # @example Everything else
     #   Timber::Config.instance.environment = "staging"
     def environment
       @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
     # @example Everything else
     #   Timber::Config.instance.http_body_limit = 500
     def http_body_limit
       @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
     #   Timber::Config.instance.append_metadata = false
     def append_metadata?
@@ -75,13 +90,12 @@
       end
 
       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)
     #   config.timber.logger = Rails.logger
     # @example Everything else
\ No newline at end of file