timber 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 764a9a04b4bb8dcb4a6bd93e531ba1eea9959f8d
-  data.tar.gz: 6dbf3db66270006e11d274c0a966456bb57e9419
+  metadata.gz: a5285d17535de9890e141603c444772904265630
+  data.tar.gz: 5ccb28e7a21bdcaa1d5d71822160114e422e5f7f
 SHA512:
-  metadata.gz: b9b093be5167377e5b6566441c7e5e91f98f2eaa06bd18d25906ffd11fba35b9338dadb7aa99e85b05c8d64ddd659686d29d58d7aa8f8f8865d058d9c15688e2
-  data.tar.gz: fc8ebd26419c4b8b248c8af55007b6579e428c96249cfc673ee4439de9480cde0f883d66880110cb1d5cb15b4ba84254e823bfd6da084fa716f330908dbd4507
+  metadata.gz: ef8847f90d849dabed1702427574a3864095cf6098801cad33cc45302203bdfdd4ccc11fd0c37c9724342ff29bf2f40c3ae9b98bf8da71d07f1b022f71f4b970
+  data.tar.gz: 8a200733730ff167b57ecbf844bd2aa1ab057bbab66dc3f6d407eec4830877c0b68e9437a1464123fd85bd1f150fdea044d3537cdf679d7414974e45f8d35210

data/lib/timber/cli/install.rb

@@ -40,6 +40,9 @@ module Timber
               puts Messages.heroku_install(app)
               puts ""
 
+              ask_yes_no("Ready to proceed?")
+              puts ""
+
             else
               puts ""
               puts Messages.separator
@@ -58,15 +61,18 @@ module Timber
                 puts Messages.http_environment_variables(app.api_key)
                 puts ""
 
+                ask_yes_no("Ready to proceed?")
+                puts ""
+
               when "2"
                 create_initializer(:http, :api_key_code => "'#{app.api_key}'")
 
-                puts ""
               end
 
               send_test_messages(api_key)
             end
 
+
             api.wait_for_logs do |iteration|
               write Messages.task_start("Waiting for logs")
               write Messages.spinner(iteration)
@@ -74,10 +80,6 @@ module Timber
 
             puts colorize(Messages.task_complete("Waiting for logs"), :green)
 
-            puts ""
-            puts Messages.separator
-            puts ""
-            puts Messages.free_data
             puts ""
             puts Messages.separator
             puts ""
@@ -87,6 +89,12 @@ module Timber
 
             collect_feedback(api)
 
+            puts ""
+            puts Messages.separator
+            puts ""
+            puts Messages.free_data
+            puts ""
+
           when :no
             puts ""
             puts "Bummer. Head to this URL to update the details:"
@@ -108,7 +116,7 @@ module Timber
               when :http
                 api_key_code = options[:api_key_code] || raise(ArgumentError.new("the :api_key_code option is required"))
                 "log_device = Timber::LogDevices::HTTP.new(#{api_key_code})\n" +
-                  "Timber::Logger.new(log_device)"
+                  "  Timber::Logger.new(log_device)"
 
               when :stdout
                 "Timber::Logger.new(STDOUT)"
@@ -127,15 +135,19 @@ module Timber
 # Support:  support@timber.io
 
 logger = case Rails.env
-when "development", "test"
-  logger = Timber::Logger.new(STDOUT)
-  logger.formatter = Timber::Logger::SimpleFormatter.new
-  logger
-else
+when "development"
+  # Write logs to STDOUT in a simple message only format
+  Timber::Logger.new(STDOUT).tap do |logger|
+    logger.formatter = Timber::Logger::SimpleFormatter.new
+  end
+when "production", "staging"
   #{logger_code}
 end
 
-Timber::Frameworks::Rails.set_logger(logger)
+if logger
+  logger.level = Rails.application.config.log_level
+  Timber::Frameworks::Rails.set_logger(logger)
+end
 BODY
 
             FileUtils.mkdir_p(File.join(Dir.pwd, "config", "initializers"))
@@ -177,8 +189,6 @@ BODY
               puts ""
               puts "Thank you! We take feedback seriously and will work to improve this."
             end
-
-            puts ""
           end
       end
     end

data/lib/timber/cli/messages.rb

@@ -17,7 +17,7 @@ module Timber
 
       def application_details(app)
         message = <<-MESSAGE
-Woot! Your API 🔑  is valid. Here are you application details:
+Woot! Your API 🔑  is valid:
 
 Name:      #{app.name} (#{app.environment})
 Framework: #{app.framework_type}
@@ -43,7 +43,7 @@ message.rstrip
 
       def commit_and_deploy_reminder
 message = <<-MESSAGE
-Last step!
+Last step! Commit and deploy:
 
     #{colorize("git add config/initializers/timber.rb", :blue)}
     #{colorize("git commit -am 'Install Timber'", :blue)}
@@ -53,6 +53,12 @@ MESSAGE
 message.rstrip
 end
 
+      def console_url(app)
+message = <<-MESSAGE
+Your console URL: https://app.timber.io/organizations/timber/apps/#{app.slug}/console
+MESSAGE
+      end
+
       def contact
 message = <<-MESSAGE
 Website:       #{WEBSITE_URL}
@@ -66,7 +72,7 @@ message.rstrip
 message = <<-MESSAGE
 Great! Add this variable to your environment:
 
-    export TIMBER_API_KEY="#{api_key}"
+    #{colorize("export TIMBER_API_KEY=\"#{api_key}\"", :blue)}
 
 MESSAGE
 message.rstrip
@@ -74,15 +80,11 @@ message.rstrip
 
       def free_data
 message = <<-MESSAGE
-Get free data on Timeber!
+As a welcome gift, we've credited your account with ✨ 50mb✨. Get more:
 
-* Timber URL: https://app.timber.io
 * Get ✨ 250mb✨ for tweeting your experience to #{TWITTER_HANDLE}
 * Get ✨ 100mb✨ for starring our repo: #{REPO_URL}
-* Get ✨ 50mb✨ for following #{TWITTER_HANDLE} on twitter
-
-(Your account will be credited within 2-3 business days.
- If you do not notice a credit please contact us: #{SUPPORT_EMAIL})
+* Get ✨ 100mb✨ for following #{TWITTER_HANDLE} on twitter
 MESSAGE
 message.rstrip
 end
@@ -101,13 +103,10 @@ message.rstrip
 
       def heroku_install(app)
 message = <<-MESSAGE
-Now we need to send your logs from Heroku to Timber.
-
-Please run this command in a separate terminal, return back when complete:
+To send logs from Heroku please run this command in a separate window:
 
     #{colorize("heroku drains:add #{app.heroku_drain_url}", :blue)}
 
-Note: Your Heroku app must be generating logs for this to work.
 MESSAGE
 message.rstrip
       end
@@ -175,7 +174,7 @@ message.rstrip
       end
 
       def we_love_you_too
-        "💖  We love you too! Let's get to loggin' 🌲"
+        "Thanks! We 💖 you too!"
       end
     end
   end

data/lib/timber/config.rb

@@ -17,29 +17,14 @@ module Timber
   class Config
     class NoLoggerError < StandardError; end
 
-    FORM_URL_ENCODED_CONTENT_TYPE = "application/x-www-form-urlencoded".freeze
-    JSON_CONTENT_TYPE = "application/json".freeze
-
     include Singleton
 
-    attr_writer :capture_http_bodies, :debug_logger, :log_formatter, :logger
+    attr_writer :debug_logger, :http_body_limit, :logger
 
     def initialize
-      @capture_http_bodies = true
-      @capture_http_body_content_types = [FORM_URL_ENCODED_CONTENT_TYPE, JSON_CONTENT_TYPE]
       @http_body_limit = 2000
     end
 
-    # Enables and disables the capturing of HTTP bodies in `Events::HTTPServerRequest`,
-    # `HTTPClientRequest`, and `HTTPClientRespone`.
-    def capture_http_bodies?
-      @capture_http_bodies == true
-    end
-
-    # Limits HTTP body capturing to the listed content types. This must be an array.
-    def capture_http_body_content_types
-      @capture_http_body_content_types ||= []
-    end
 
     # Set a debug_logger to view internal Timber library log message.
     # Useful for debugging. Defaults to `nil`. If set, debug messages will be

data/lib/timber/events/http_server_request.rb

@@ -18,11 +18,6 @@ module Timber
         @query_string = Util::HTTPEvent.normalize_query_string(attributes[:query_string])
         @scheme = attributes[:scheme] || raise(ArgumentError.new(":scheme is required"))
         @request_id = attributes[:request_id]
-
-        # This is disabled for now. The ControllerCall event records the parsed params.
-        # This should be sufficient for body inspection. If we come across a case where
-        # it is not we can consider re-enabling this.
-        # @body = Util::HTTPEvent.normalize_body(attributes[:body])
       end
 
       def to_hash

data/lib/timber/frameworks/rails.rb

@@ -5,20 +5,37 @@ module Timber
       class Railtie < ::Rails::Railtie
         config.timber = Config.instance
 
-        initializer(:timber_logger, before: :initialize_logger) do
-          Rails.configure_middlewares(config.app_middleware)
-          Integrations.integrate!
-
+        initializer(:timber_silence_logger_complaints, before: :initialize_logger) do
           # We set a default logger because Rails tries to write to a file by default.
-          # This causes errors on paltforms with a readon only file system (Heroku)
+          # This causes errors on platforms with a read only file system (Heroku).
+          # See this commit: https://github.com/heroku/rails_stdout_logging/commit/13d092650118bcfeb30f383d3274cee46cbf7b8f
           # Moreover, the Timber logger gets configured properly later in an initiailizer.
           # This is a hold over until we reach that file in the initialization process.
-          logger = if defined?(::ActiveSupport::Logger)
-            ::ActiveSupport::Logger.new(STDOUT)
-          else
-            ::Logger.new(STDOUT)
+          is_heroku = !ENV['DYNO'].nil?
+          if is_heroku
+            logger = defined?(::ActiveSupport::Logger) ?
+              ::ActiveSupport::Logger.new(STDOUT) : ::Logger.new(STDOUT)
+            ::Rails.logger = config.logger = logger
           end
-          ::Rails.logger = Config.instance.logger = logger
+        end
+
+        # Initialize Timber immediately after the logger in case anything uses the logger
+        # during the initialization process.
+        initializer(:timber, after: :initialize_logger) do
+          # The goals here:
+          # 1. Respect the default log device that rails sets in :initialize_logger
+          # 2. Replace the logger with Timber::Logger so that users get our logger API
+          # 3. Disable metadata so that the logger is essentially transparent until further
+          #    configuration in initializers/timber.rb. This allows them to essentially "turn on"
+          #    timber for production, staging, etc.
+          log_device = ::Rails.logger.instance_variable_get(:@logdev).try(:dev)
+          logger = Logger.new(log_device)
+          logger.formatter = Logger::SimpleFormatter.new
+          logger.level = ::Rails.logger.level
+          ::Rails.logger = config.logger = logger
+
+          Rails.configure_middlewares(config.app_middleware)
+          Integrations.integrate!
         end
       end
 

data/lib/timber/integrations/rack/http_events.rb

@@ -10,11 +10,9 @@ module Timber
         def call(env)
           start = Time.now
           request = Util::Request.new(env)
-          body = Config.instance.capture_http_bodies? ? request.body_content : nil
 
           Config.instance.logger.info do
             Events::HTTPServerRequest.new(
-              body: body,
               headers: request.headers,
               host: request.host,
               method: request.request_method,

data/lib/timber/logger.rb

@@ -166,10 +166,11 @@ module Timber
       end
     end
 
-    class << self
-      def new_from_config
-      end
-    end
+    # These are rails modules that change the logger behavior. We have to
+    # include these if they are present or the logger will not function properly
+    # in a rails environment.
+    include ::ActiveSupport::LoggerThreadSafeLevel if defined?(::ActiveSupport::LoggerThreadSafeLevel)
+    include ::LoggerSilence if defined?(::LoggerSilence)
 
     # Creates a new Timber::Logger instances. Accepts the same arguments as `::Logger.new`.
     # The only difference is that it default the formatter to {HybridFormatter}. Using
@@ -194,6 +195,8 @@ module Timber
 
       self.level = environment_level
 
+      after_initialize if respond_to? :after_initialize
+
       @initialized = true
     end
 

data/lib/timber/util/http_event.rb

@@ -15,18 +15,12 @@ module Timber
         end
       end
 
-      def normalize_body(content_type, body)
-        if Config.instance.capture_http_body_content_types.include?(content_type)
-          if body.respond_to?(:body)
-            body = body.body.to_s
-          end
-
-          body[0..(Config.instance.http_body_limit - 1)]
-        else
-          # Drop the body if it is not a format we want to capture.
-          # This gives users more control to avoid loggin files, etc.
-          nil
+      def normalize_body(body)
+        if body.respond_to?(:body)
+          body = body.body.to_s
         end
+
+        body[0..(Config.instance.http_body_limit - 1)]
       end
 
       def normalize_headers(headers)

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

data/timber.gemspec

@@ -20,16 +20,16 @@ Gem::Specification.new do |s|
 
   s.add_dependency('msgpack', '~> 1.0')
 
-  s.add_development_dependency('rails_stdout_logging', '~> 0')
-  s.add_development_dependency('rake', '~> 0')
+  s.add_development_dependency('rails_stdout_logging', '>= 0')
+  s.add_development_dependency('rake', '>= 0')
   s.add_development_dependency('rspec', '~> 3.4')
-  s.add_development_dependency('rspec-its', '~> 0')
-  s.add_development_dependency('timecop', '~> 0')
+  s.add_development_dependency('rspec-its', '>= 0')
+  s.add_development_dependency('timecop', '>= 0')
 
   if RUBY_PLATFORM == "java"
-    s.add_development_dependency('activerecord-jdbcsqlite3-adapter', '~> 0')
+    s.add_development_dependency('activerecord-jdbcsqlite3-adapter', '>= 0')
   else
-    s.add_development_dependency('sqlite3', '~> 0')
+    s.add_development_dependency('sqlite3', '>= 0')
   end
 
   if RUBY_VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -28,28 +28,28 @@ dependencies:
   name: rails_stdout_logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -70,42 +70,42 @@ dependencies:
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency