timber 2.1.0.rc3 → 2.1.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f1b00e64f1666ef47d33c347cea42bcc4d7b262
-  data.tar.gz: cbde1d3d51a40c4e08eb3357f8d1fa72beae5d19
+  metadata.gz: 6c4de508448203aa02a9dba6eec487ed04d0ffcf
+  data.tar.gz: 8c7e69aad8ab879841ca7d31910e09e86e5c7658
 SHA512:
-  metadata.gz: 374705c1b1a8f0e0091d92a4ee0186246af3126a8c4e5e5358591deac6a1f2174052347350d42d1c8d1e79548a9a159438e39bdcbc95a2753182d5b52f18b921
-  data.tar.gz: baa0ba4b26cc7157710213635f12750da54ee3bde50e7b1fdac74a06da5ba2b1314c66db5aa258cfd8a170d4299b4f866520ba9a63a31a6ee39f200f95c9331e
+  metadata.gz: e91f93d4548d7459c5ecdda73917a1cf188301feaab95de3bcd319e8b779a9f250507046010688c459bbfc1a06de058df9caf3329e834d0f6e49d31fe9099c22
+  data.tar.gz: d944798f07d4b1bb0ee0d07b34ce321b75918aa5c5b23107ca6e6f62ba532837d474f2f625092f513c977fe7362fbfd4831506383945e28419c68c8fe44950a1

data/README.md

@@ -26,8 +26,9 @@ focusing on logging.
 3. **Seamlessly integrates with popular libraries and frameworks.** - Rails, Rack, Devise,
    Omniauth, etc. [Automatically captures user context, HTTP context, and event data.](#third-party-integrations)
 
-4. **Pairs with a modern console.** - Designed specifically for this librariy, hosted, instantly
-   usable, zero configuration. [Checkout the docs](https://timber.io/docs/app/overview/).
+4. **Pairs with a modern structured-logging console.** - Designed specifically for structured data,
+   hosted, instantly usable, tail users, trace requests.
+   [Checkout the docs](https://timber.io/docs/app/tutorials/).
 
 
 ## Installation
@@ -45,16 +46,16 @@ focusing on logging.
 
 ## How it works
 
-Let's start with an example. Timber turns this:
+Let's start with an example. Timber turns this production log line:
 
 ```
-Sent 200 in 45.2ms
+I, [2017-06-04T18:04:53.653812 #42348]  INFO -- : [my.host.com] [df88dbaa-50fd-4178-85d7-d66279ea33b6] [192.32.23.12] [bfa8242cd9733bf0211e334be203f0d0] Sent 200 in 45.2ms
 ```
 
-Into a rich [`http_server_response` event](https://timber.io/docs/ruby/events-and-context/http-server-response-event/).
+Into a structured [`http_server_response` event](https://timber.io/docs/ruby/events-and-context/http-server-response-event/).
 
 ```
-Sent 200 in 45.2ms @metadata {"dt": "2017-02-02T01:33:21.154345Z", "level": "info", "context": {"http": {"method": "GET", "path": "/path", "remote_addr": "192.32.23.12", "request_id": "abcd1234"}, "system": {"hostname": "1.server.com", "pid": "254354"}, "user": {"id": 1, "name": "Ben Johnson", "email": "bens@email.com"}}, "event": {"http_server_response": {"status": 200, "time_ms": 45.2}}}
+Sent 200 in 45.2ms @metadata {"dt": "2017-02-02T01:33:21.154345Z", "level": "info", "context": {"http": {"method": "GET", "path": "/path", "remote_addr": "192.32.23.12", "request_id": "df88dbaa-50fd-4178-85d7-d66279ea33b6"}, "session": {"id": "bfa8242cd9733bf0211e334be203f0d0"}, "system": {"hostname": "my.host.com", "pid": "254354"}, "user": {"id": 1, "name": "Ben Johnson", "email": "bens@email.com"}}, "event": {"http_server_response": {"status": 200, "time_ms": 45.2}}}
 ```
 
 Notice that instead of completely replacing your log messages,
@@ -72,7 +73,7 @@ logger.info("Sent 200 in 45.2ms")
 
 Here's a better look at the metadata:
 
-```json
+```js
 {
   "dt": "2017-02-02T01:33:21.154345Z",
   "level": "info",
@@ -83,11 +84,14 @@ Here's a better look at the metadata:
       "remote_addr": "192.32.23.12",
       "request_id": "abcd1234"
     },
+    "session": {
+      "id": "bfa8242cd9733bf0211e334be203f0d0"
+    },
     "system": {
       "hostname": "1.server.com",
       "pid": "254354"
     },
-    "user": {
+    "user": { // user identifiable logs :O
       "id": 1,
       "name": "Ben Johnson",
       "email": "bens@email.com"
@@ -418,15 +422,18 @@ Lastly, you can checkout how we capture these events in
 
 <details><summary><strong>Won't this increase the size of my log data?</strong></summary><p>
 
-Yes. In terms of size, it's no different than adding tags to your logs or any other useful
-data. A few things to point out though:
-
-1. Timber generally _reduces_ the amount of logs your app generates by providing options to
-   consolidate request / response logs, template logs, and even silence logs that are not
-   of value to you. (see [configuration](#configuration) for examples).
-2. Your log provider should be compressing your data and charging you accordingly. Log data
-   is notoriously repetitive, and the context Timber generates is repetitive as well.
-   Because of compression we've seen somes apps only incur a 10% increase in data size.
+Yes, but it's no different than adding any other useful data to your logs, such as
+[tags](http://api.rubyonrails.org/classes/ActiveSupport/TaggedLogging.html). A few
+of things to note:
+
+1. Timber generally _reduces_ the amount of logs your app generates, trading quality for quantity.
+   It does so by providing options to consolidate request / response logs, template logs, and
+   even silence logs that are not of value to you. (see [configuration](#configuration) for examples).
+2. Timber lets you pick exactly which events and contexts you want.
+   (see [configuration](#configuration) for examples)
+3. Your logging provider should be compressing your data and charging you accordingly. Log data
+   is notoriously repetitive, and the context Timber generates is repetitive.
+   Because of compression we've seen somes apps only incur a ~15% increase in data size.
 
 Finally, log what is useful to you. Quality over quantity certainly applies to logging.
 

data/lib/timber/cli/api.rb

@@ -64,7 +64,7 @@ module Timber
       HAS_LOGS_PATH = "/installer/has_logs".freeze
       USER_AGENT = "Timber Ruby/#{Timber::VERSION} (HTTP)".freeze
 
-      attr_reader :api_key
+      attr_accessor :api_key
 
       def initialize(api_key)
         @api_key = api_key
@@ -103,7 +103,7 @@ module Timber
         when 0
           event(:waiting_for_logs)
         when 20
-          event(:excessively_waiting_for_logs)
+          event(:excessive_log_waiting)
         when 60
           raise LogsNotReceivedError.new
         end
@@ -142,7 +142,10 @@ module Timber
         end
 
         def issue!(req)
-          req['Authorization'] = "Basic #{encoded_api_key}"
+          if api_key
+            req['Authorization'] = "Basic #{encoded_api_key}"
+          end
+
           req['User-Agent'] = USER_AGENT
           req['X-Installer-Session-Id'] = @session_id
           res = http.start do |http|

data/lib/timber/cli/api/application.rb

@@ -2,7 +2,8 @@ module Timber
   class CLI
     class API
       class Application
-        DEVELOPMENT = "development".freeze
+        DEVELOPMENT_ENVIRONMENT = "development".freeze
+        TEST_ENVIRONMENT = "test".freeze
         HEROKU = "heroku".freeze
 
         attr_accessor :api_key, :environment, :framework_type, :heroku_drain_url,
@@ -18,7 +19,11 @@ module Timber
         end
 
         def development?
-          environment == DEVELOPMENT
+          environment == DEVELOPMENT_ENVIRONMENT
+        end
+
+        def test?
+          environment == TEST_ENVIRONMENT
         end
 
         def heroku?

data/lib/timber/cli/config_file.rb

@@ -7,27 +7,24 @@ module Timber
 
       def initialize(path)
         @path = path
-        FileHelper.read_or_create(path, initial_content)
+      end
+
+      def create!
+        FileHelper.write(path, content)
+      end
+
+      def exists?
+        File.exists?(path)
       end
 
       def logrageify!
-        append("config.logrageify!")
+        append!("config.logrageify!")
       end
 
       private
-        def get_content
-          FileHelper.read(path)
-        end
-
-        def append(code)
-          current_content = get_content
-          if !current_content.include?(code)
-            if current_content.include?(insert_hook)
-              new_content = current_content.gsub(insert_hook, "#{code}\n\n#{insert_hook}")
-              FileHelper.write(path, new_content)
-            else
-              FileHelper.append(path, new_content)
-            end
+        def append!(code)
+          if !content.include?(code)
+            content.gsub!(insert_hook, "#{code}\n\n#{insert_hook}")
           end
 
           true
@@ -39,8 +36,8 @@ module Timber
 
         # We provide this as an instance method so that the string is only defined when needed.
         # This avoids allocating this string during normal app runtime.
-        def initial_content
-          <<-CONTENT
+        def content
+          @content ||= <<-CONTENT
 # Timber.io Ruby Configuration - Simple Structured Logging
 #
 #  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^

data/lib/timber/cli/file_helper.rb

@@ -1,32 +1,44 @@
 module Timber
   class CLI
-    module FileHelper
-      def self.append(path, contents)
+    class FileHelper
+      attr_reader :api
+
+      def initialize(api)
+        @api = api
+      end
+
+      def append(path, contents)
         File.open(path, "a") do |f|
           f.write(contents)
         end
       end
 
-      def self.read_or_create(path, contents)
-        if !File.exists?(path)
+      def exists?(path)
+        File.exists?(path)
+      end
+
+      def read_or_create(path, contents)
+        if !exists?(path)
           write(path, contents)
         end
 
-        File.read(path)
+        read(path)
       end
 
-      def self.read(path)
+      def read(path)
         File.read(path)
       end
 
-      def self.write(path, contents)
+      def write(path, contents)
         File.open(path, "w") do |f|
           f.write(contents)
         end
+
+        api.event(:file_written, path: path)
       end
 
-      def self.verify(path, io)
-        if !File.exists?(path)
+      def verify(path, io)
+        if !exists?(path)
           io.puts ""
           io.puts "Uh oh! It looks like we couldn't locate the #{path} file. "
           io.puts "Please enter the correct path:"

data/lib/timber/cli/installer.rb

@@ -1,13 +1,15 @@
+require "timber/cli/file_helper"
 require "timber/cli/io/messages"
 
 module Timber
   class CLI
     class Installer
-      attr_reader :io, :api
+      attr_reader :io, :api, :file_helper
 
       def initialize(io, api)
         @io = io
         @api = api
+        @file_helper = FileHelper.new(api)
       end
 
       def run(app)

data/lib/timber/cli/installers.rb

@@ -9,57 +9,65 @@ module Timber
   class CLI
     module Installers
       def self.run(api_key, io)
-        io.puts IO::Messages.header, :green
-        io.puts IO::Messages.separator, :green
-        io.puts IO::Messages.contact, :green
-        io.puts IO::Messages.separator, :green
-        io.puts ""
+        api = API.new(api_key)
+        api.event(:started)
 
-        if !api_key
-          app_url = IO::Messages::APP_URL
-
-          io.puts "Hey there! Welcome to Timber. In order to proceed, you'll need an API key."
-          io.puts "You can grab one by registering at #{IO::ANSI.colorize(app_url, :blue)}."
-          io.puts ""
-          io.puts "It takes less than a minute, with one click Google and Github registration."
+        begin
+          io.puts IO::Messages.header, :green
+          io.puts IO::Messages.separator, :green
+          io.puts IO::Messages.contact, :green
+          io.puts IO::Messages.separator, :green
           io.puts ""
 
-          if OSHelper.can_open?
-            case io.ask_yes_no("Open #{app_url}?")
-            when :yes
-              puts ""
-              io.task("Opening #{app_url}") do
-                OSHelper.open(app_url)
+          if !api_key
+            api.event(:no_api_key)
+
+            app_url = IO::Messages::APP_URL
+
+            io.puts "Hey there! Welcome to Timber. In order to proceed, you'll need an API key."
+            io.puts "You can grab one by registering at #{IO::ANSI.colorize(app_url, :blue)}."
+            io.puts ""
+            io.puts "It takes less than a minute, with one click Google and Github registration."
+            io.puts ""
+
+            if OSHelper.can_open?
+              case io.ask_yes_no("Open #{app_url}?")
+              when :yes
+                puts ""
+                io.task("Opening #{app_url}") do
+                  OSHelper.open(app_url)
+                end
+              when :no
+                io.puts ""
+                io.puts "No problem, navigate to the following URL:"
+                io.puts ""
+                io.puts "    #{IO::ANSI.colorize(app_url, :blue)}"
               end
-            when :no
+            else
               io.puts ""
-              io.puts "No problem, navigate to the following URL:"
+              io.puts "Please navigate to:"
               io.puts ""
               io.puts "    #{IO::ANSI.colorize(app_url, :blue)}"
             end
-          else
+
             io.puts ""
-            io.puts "Please navigate to:"
+            io.puts "Once you obtain your API key, you can run the installer like"
             io.puts ""
-            io.puts "    #{IO::ANSI.colorize(app_url, :blue)}"
-          end
-
-          io.puts ""
-          io.puts "Once you obtain your API key, you can run the installer like"
-          io.puts ""
-          io.puts "    #{IO::ANSI.colorize("bundle exec timber my-api-key", :blue)}"
-          io.puts ""
-          io.puts "See you soon! 🎈"
-          io.puts ""
-        else
-          api = API.new(api_key)
-          api.event(:started)
-
-          io.api = api
+            io.puts "    #{IO::ANSI.colorize("bundle exec timber my-api-key", :blue)}"
+            io.puts ""
+            io.puts "See you soon! 🎈"
+            io.puts ""
+          else
+            api.event(:api_key_provided)
+            io.api = api
 
-          app = api.application!
+            app = api.application!
 
-          Root.new(io, api).run(app)
+            Root.new(io, api).run(app)
+          end
+        rescue Exception => e
+          api.event(:exception, message: e.message, stacktrace: e.backtrace)
+          raise e
         end
       end
     end

data/lib/timber/cli/installers/config_file.rb

@@ -0,0 +1,60 @@
+begin
+  require "lograge"
+rescue Exception
+end
+
+require "timber/cli/config_file"
+require "timber/cli/installer"
+require "timber/cli/io/messages"
+
+module Timber
+  class CLI
+    module Installers
+      class ConfigFile < Installer
+        def run(app, path)
+          config_file = Timber::CLI::ConfigFile.new(path)
+
+          if config_file.exists?
+            io.puts ""
+            io.task_complete("#{config_file.path} already created")
+            return true
+          end
+
+          if logrageify?
+            config_file.logrageify!
+          end
+
+          io.puts ""
+          task_message = "Creating #{config_file.path}"
+          io.task(task_message) { config_file.create! }
+        end
+
+        private
+          def logrageify?
+            if defined?(::Lograge)
+              io.puts ""
+              io.puts IO::Messages.separator
+              io.puts ""
+              io.puts "We noticed you have lograge installed. Would you like to configure "
+              io.puts "Timber to function similarly?"
+              io.puts "(This silences template renders, sql queries, and controller calls."
+              io.puts "You can always do this later in config/initialzers/timber.rb)"
+              io.puts ""
+              io.puts "y) Yes, configure Timber like lograge", :blue
+              io.puts "n) No, use the Rails logging defaults", :blue
+              io.puts ""
+
+              case io.ask_yes_no("Enter your choice:", event_prompt: "Logrageify?")
+              when :yes
+                true
+              when :no
+                false
+              end
+            else
+              false
+            end
+          end
+      end
+    end
+  end
+end

data/lib/timber/cli/installers/other.rb

@@ -14,13 +14,7 @@ module Timber
             install_http(api_key_code)
           end
 
-          io.puts ""
-          io.puts IO::Messages.separator
-          io.puts ""
-          io.puts "We're going to send a few test messages to ensure communication is working."
-          io.puts ""
-          io.ask_to_proceed
-          io.puts ""
+          ask_to_proceed
         end
 
         private
@@ -48,6 +42,16 @@ module Timber
             io.puts ""
             io.ask_to_proceed
           end
+
+          def ask_to_proceed
+            io.puts ""
+            io.puts IO::Messages.separator
+            io.puts ""
+            io.puts "We're going to send a few test messages to ensure communication is working."
+            io.puts ""
+            io.ask_to_proceed
+            io.puts ""
+          end
       end
     end
   end