timber 1.1.14 → 2.0.0

data/lib/timber/cli/io_helper.rb

@@ -0,0 +1,58 @@
+module Timber
+  class CLI
+    module IOHelper
+      def ask(message)
+        write message + " "
+        gets
+      end
+
+      def ask_yes_no(message)
+        case ask(message + " (y/n)")
+        when "y", "Y"
+          :yes
+        when "n", "N"
+          :no
+        else
+          puts "Woops! That's not a valid input. Please try again."
+          ask_yes_no(message)
+        end
+      end
+
+      def colorize(text, color)
+        return text if Gem.win_platform?
+
+        code =
+          case color
+          when :red then 31
+          when :green then 32
+          when :yellow then 33
+          else 0
+          end
+
+        "\e[#{code}m#{text}\e[0m"
+      end
+
+      def gets
+        value = stdin.gets
+        value ? value.chomp.downcase : ""
+      end
+
+      def puts(message)
+        stdout.puts(message)
+      end
+
+      def write(message)
+        stdout.write(message)
+      end
+
+      private
+        def stdout
+          $stdout
+        end
+
+        def stdin
+          $stdin
+        end
+    end
+  end
+end

data/lib/timber/cli/messages.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+
+module Timber
+  class CLI
+    module Messages
+      extend self
+
+      APP_URL = "https://app.timber.io"
+      DOCS_URL = "https://timber.io/docs"
+      REPO_URL = "https://github.com/timberio/timber-ruby"
+      SUPPORT_EMAIL = "support@timber.io"
+      TWITTER_HANDLE = "@timberdotio"
+      WEBSITE_URL = "https://timber.io"
+      MAX_LENGTH = 80.freeze
+
+      def application_details(app)
+        message = <<-MESSAGE
+Woot! Your API 🔑  is valid. Here are you application details:
+
+Name:      #{app.name} (#{app.environment})
+Framework: #{app.framework_type}
+Platform:  #{app.platform_type}
+MESSAGE
+message.rstrip
+      end
+
+      def edit_app_url(app)
+        "#{APP_URL}"
+      end
+
+      def bad_experience_message
+message = <<-MESSAGE
+Bummer! That is certainly not the experience we were going for.
+
+Could you tell us why you a bad experience?
+
+(this will be sent directly to the Timber engineering team)
+MESSAGE
+message.rstrip
+      end
+
+      def commit_and_deploy_reminder
+message = <<-MESSAGE
+Last step! Commit these changes and deploy. 🚀
+MESSAGE
+message.rstrip
+end
+
+      def contact
+message = <<-MESSAGE
+Website:       #{WEBSITE_URL}
+Documentation: #{DOCS_URL}
+Support:       #{SUPPORT_EMAIL}
+MESSAGE
+message.rstrip
+      end
+
+      def http_environment_variables(api_key)
+message = <<-MESSAGE
+Great! Add this variable to your environment:
+
+    export TIMBER_API_KEY="#{api_key}"
+
+MESSAGE
+message.rstrip
+      end
+
+      def free_data
+message = <<-MESSAGE
+Get free data on Timeber!
+
+* 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})
+MESSAGE
+message.rstrip
+end
+
+      def header
+message = <<-MESSAGE
+🌲 Timber.io Ruby Installer
+
+ ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^
+/|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+/|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+/|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+MESSAGE
+message.rstrip
+      end
+
+      def heroku_install(app)
+message = <<-MESSAGE
+Now we need to send your logs to the Timber service.
+
+Please run this command in a separate terminal and return back here when complete:
+
+    heroku drains:add #{app.heroku_drain_url}
+
+Note: Your Heroku app must be generating logs for this to work.
+MESSAGE
+message.rstrip
+      end
+
+      def no_api_key_provided
+message = <<-MESSAGE
+Woops! You didn't provide an API key. You can do so via:
+
+    bundle exec timber install my-api-key
+
+#{obtain_key_instructions}
+MESSAGE
+message.rstrip
+      end
+
+      def obtain_key_instructions
+message = <<-MESSAGE
+Don't have a key? Head over to:
+
+    https://app.timber.io
+
+Once there, create an application. Your API key will be displayed afterwards.
+For more detailed instructions, checkout our docs page:
+https://timber.io/docs/app/obtain-api-key/
+MESSAGE
+message.rstrip
+      end
+
+      def separator
+        "--------------------------------------------------------------------------------"
+      end
+
+      def spinner(iteration)
+        rem = iteration % 3
+        case rem
+        when 0
+          "/"
+        when 1
+          "-"
+        when 2
+          "\\"
+        end
+      end
+
+      def success
+        "✓ Success!"
+      end
+
+      def task_complete(message)
+        remainder = MAX_LENGTH - message.length - success.length
+
+        dots = "." * remainder
+        "\r#{message}#{dots}#{success}"
+      end
+
+      def task_start(message)
+        remainder = MAX_LENGTH - message.length - success.length
+
+        "\r#{message}" + ("." * remainder)
+      end
+
+      def we_love_you_too
+        "💖  We love you too! Let's get to loggin' 🌲"
+      end
+    end
+  end
+end

data/lib/timber/config.rb

@@ -1,18 +1,59 @@
 require "singleton"
 
 module Timber
-  # Interface for configuring Timber.
+  # Interface for settings and reading Timber configuration.
   #
-  # @note If using rails this will be installed in the `config` object via `config.timber`.
+  # You can override any configuration supplied here by simply setting it:
+  #
+  #     # Rails
+  #     config.timber.api_key = "my api key"
+  #
+  #     # Everything else
+  #     Timber::Config.instance.api_key = "my api key"
+  #
+  # If a value is not explicity set, the environment is checked for it's associated
+  # environment variable. If that is not set, a reasonable default will be chosen. Each
+  # method documents this.
   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 :logger
+    attr_writer :capture_http_bodies, :debug_logger, :log_formatter, :logger
+
+    def initialize
+      @capture_http_bodies = true
+      @capture_http_body_content_types = [FORM_URL_ENCODED_CONTENT_TYPE, JSON_CONTENT_TYPE]
+    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
+    # written to this logger.
+    def debug_logger
+      @debug_logger
+    end
+
 
-    # Set a logger to view internal Timber library log message.
-    # Useful for debugging. Defaults to `::Logger.new(nil)`.
+    # This is the logger Timber writes to. It should be set to your global
+    # logger to keep the logging destination consitent. Please see `delegate_logger_to`
+    # to  delegate this call to another method. This is set to `Rails.logger`
+    # for rails.
     def logger
-      @logger ||= Logger.new(nil)
+      @logger || raise(NoLoggerError.new)
     end
   end
 end

data/lib/timber/contexts/http.rb

@@ -4,8 +4,8 @@ module Timber
     # as join data across your logs, allowing you to query all logs for any attribute
     # presented here. For example, viewing all logs for a given request_id.
     #
-    # @note This context should be installed automatically through probes,
-    #   such as the {Probes::RackHTTPContext} probe.
+    # @note This context should be installed automatically through integrations,
+    #   such as the {Intregrations::Rack::HTTPContext} rack middleware.
     class HTTP < Context
       @keyspace = :http
 

data/lib/timber/current_context.rb

@@ -56,7 +56,7 @@ module Timber
     #     # ... anything logged here will include the context ...
     #   end
     #   # Be sure to checkout Timber::Contexts! These are officially supported and many of these
-    #   # will be automatically included via Timber::Probes
+    #   # will be automatically included via Timber::Integrations
     #
     # @example Adding multiple contexts
     #   Timber::CurrentContext.with(context1, context2) { ... }

data/lib/timber/event.rb

@@ -10,6 +10,14 @@ module Timber
       raise NotImplementedError.new
     end
 
+    # This ensures that Timber events get logged as messages if they are passed to
+    # the standard ::Logger.
+    #
+    # See: https://github.com/ruby/ruby/blob/f6e77b9d3555c1fbaa8aab1cdc0bd6bde95f62c6/lib/logger.rb#L615
+    def inspect
+      message
+    end
+
     def to_json(options = {})
       as_json.to_json(options)
     end

data/lib/timber/events.rb

@@ -1,6 +1,8 @@
 require "timber/events/controller_call"
 require "timber/events/custom"
 require "timber/events/exception"
+require "timber/events/http_client_request"
+require "timber/events/http_client_response"
 require "timber/events/http_server_request"
 require "timber/events/http_server_response"
 require "timber/events/sql_query"

data/lib/timber/events/controller_call.rb

@@ -4,8 +4,8 @@ module Timber
     #
     #   Processing by PagesController#home as HTML
     #
-    # @note This event should be installed automatically through probes,
-    #   such as the {Probes::ActionControllerLogSubscriber} probe.
+    # @note This event should be installed automatically through integrations,
+    #   such as the {Integrations::ActionController::LogSubscriber} integration.
     class ControllerCall < Timber::Event
       attr_reader :controller, :action, :params, :format
 
@@ -17,7 +17,7 @@ module Timber
       end
 
       def to_hash
-        {controller: controller, action: action}
+        {controller: controller, action: action, params_json: params_json}
       end
       alias to_h to_hash
 
@@ -35,6 +35,15 @@ module Timber
         end
         message
       end
+
+      private
+        def params_json
+          @params_json ||= if params.nil? || params == {}
+            nil
+          else
+            params.to_json
+          end
+        end
     end
   end
 end

data/lib/timber/events/exception.rb

@@ -2,8 +2,8 @@ module Timber
   module Events
     # The exception event is used to track exceptions.
     #
-    # @note This event should be installed automatically through probes,
-    #   such as the {Probes::ActionDispatchDebugExceptions} probe.
+    # @note This event should be installed automatically through integrations,
+    #   such as the {Integrations::ActionDispatch::DebugExceptions} integration.
     class Exception < Timber::Event
       attr_reader :name, :exception_message, :backtrace
 
@@ -16,7 +16,8 @@ module Timber
           raise(ArgumentError.new(":backtrace is required"))
         end
 
-        @backtrace = backtrace.collect { |line| parse_backtrace_line(line) }
+        # 10 items max
+        @backtrace = backtrace[0..9].collect { |line| parse_backtrace_line(line) }
       end
 
       def to_hash

data/lib/timber/events/http_client_request.rb

@@ -0,0 +1,61 @@
+module Timber
+  module Events
+    # The HTTP client request event tracks *outgoing* HTTP requests giving you structured insight
+    # into communication with external services.
+    #
+    # @note This event should be installed automatically through integrations,
+    #   such as the {Integrations::NetHTTP} integration.
+    class HTTPClientRequest < Timber::Event
+      attr_reader :body, :headers, :host, :method, :path, :port, :query_string, :request_id,
+        :scheme, :service_name
+
+      def initialize(attributes)
+        @headers = Util::HTTPEvent.normalize_headers(attributes[:headers])
+        @host = attributes[:host] || raise(ArgumentError.new(":host is required"))
+        @method = Util::HTTPEvent.normalize_method(attributes[:method]) || raise(ArgumentError.new(":method is required"))
+        @path = attributes[:path] || raise(ArgumentError.new(":path is required"))
+        @port = attributes[:port]
+        @query_string = Util::HTTPEvent.normalize_query_string(attributes[:query_string])
+        @request_id = attributes[:request_id]
+        @scheme = attributes[:scheme] || raise(ArgumentError.new(":scheme is required"))
+        @service_name = attributes[:service_name]
+
+        @body = Util::HTTPEvent.normalize_body(@headers["content-type"], attributes[:body])
+      end
+
+      def to_hash
+        {headers: headers, host: host, method: method, parsed_body_json: parsed_body_json,
+          path: path, port: port, query_string: query_string, request_id: request_id,
+          scheme: scheme, service_name: service_name}
+      end
+      alias to_h to_hash
+
+      def as_json(_options = {})
+        {:server_side_app => {:http_client_request => to_hash}}
+      end
+
+      def message
+        message = 'Outgoing HTTP request to '
+
+        if service_name
+          mesage << " #{service_name} [#{method}] #{full_path}"
+        else
+          message << " [#{method}] #{full_url}"
+        end
+      end
+
+      def status_description
+        Rack::Utils::HTTP_STATUS_CODES[status]
+      end
+
+      private
+        def full_path
+          Util::HTTPEvent.full_path(path, query_string)
+        end
+
+        def full_url
+          "#{scheme}#{host}#{full_path}"
+        end
+    end
+  end
+end