timber 2.1.4 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8abcf84c32b728be216520c831ea391b2d8d4aff
-  data.tar.gz: bd66dceece6b234a4de867656eeaeebeb5c9a7a5
+  metadata.gz: 73567629c6afb913426d711c96cb394d9e2bf741
+  data.tar.gz: 952d3e7d73d9de740abdaf536d3eb3fe985024e4
 SHA512:
-  metadata.gz: 71850c881fe047e8e80f850010f99989b0206be96087cbf15ff84adb09b6d9780b062ba492e65c2fffd659bd2d013c12f6e2b829c60847d0e750ae56f9d6268d
-  data.tar.gz: 27c4421fcfa563a47d6d92911effde2472a3e48b4ba5da9b7def6ee3fa031f1bcc2d3a9cd54da88a3aa13db1f0a19e5556eb6d5c84fba4394aa62f28ab353c54
+  metadata.gz: 5ddc053cd804b4121e27fd91128b9f950270a85fc10a316a57f9a618000c46e5fbe07627a492af9574d7c77096004da07b21343263155cf40dc534f1301174d5
+  data.tar.gz: 2f063f0a6ec629265f4fbd1f2d7de23392d81faaef3a671fc02129bdfa984ddbda873391ca118040cda3a27fe61ad599a4920ce9014b05e2da757bbb1375ca61

data/README.md

@@ -4,17 +4,17 @@
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/timberio/timber-ruby)
 [![Build Status](https://travis-ci.org/timberio/timber-ruby.svg?branch=master)](https://travis-ci.org/timberio/timber-ruby)
 
+[Timber.io](https://timber.io) is a simple cloud-based logging platform built for developers.
+This is our official Ruby library.
+
 ## Overview
 
-Timber for Ruby is a drop-in upgrade for your Ruby logs that unobtrusively
-[structures your logs through augmentation](https://timber.io/docs/concepts/structuring-through-augmentation).
-It's clean structured logging without the effort. When paired with the
-[Timber console](#the-timber-console), Timber will
-[fundamentally change the way you use your logs](#do-amazing-things-with-your-logs).
+Ruby logs are broken. They're noisy, unparesable, and in the context of multiple servers and processes, unreadable. Current logging systems built for ops engineers haven't helped. This is why we built Timber. It's a different approach to Ruby logging. Instead of prefixing your logs with noisy tags, Timber integrates directly with your application, capturing rich context and metadata without altering your logs. This makes your logs easy to [search, use, and _read_](#do-amazing-things-with-your-logs), giving you _complete_ insight into your Ruby app.
 
 1. [**Easy setup** - `bundle exec timber install`](#installation)
-2. [**Seamlessly integrates with popular libraries and frameworks**](#integrations)
-3. [**Do amazing things with your Ruby logs**](#do-amazing-things-with-your-logs)
+2. [**Powerful logging**](#usage)
+3. [**Seamlessly integrates with popular libraries and frameworks**](#integrations)
+4. [**Do amazing things with your Ruby logs**](#do-amazing-things-with-your-logs)
 
 
 ## Installation
@@ -52,12 +52,13 @@ metadata, you don't have to worry about making every log structured!
 
 </p></details>
 
-<details><summary><strong>Custom events</strong></summary><p>
+<details><summary><strong>Logging events (structured data)</strong></summary><p>
 
-Custom events allow you to extend beyond events already defined in the
-[`Timber::Events`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Events) namespace.
-If you aren't sure what an event is, please read the
-["Metdata, Context, and Events" doc](https://timber.io/docs/concepts/metadata-context-and-events).
+Logging events allows you to log structured data without sacrificing readability or worrying about
+structured data name or type conflicts. Keep in mind, Timber defines common events in the
+[`Timber::Events`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Events) namespace,
+which are automatically logged for you through our [integrations](#integrations). You should not
+have to maually log events defined there except in special circumstances.
 
 ### How to use it
 
@@ -75,22 +76,29 @@ logger.warn "Payment rejected", payment_rejected: {customer_id: "abcd1234", amou
 
 </p></details>
 
-<details><summary><strong>Custom contexts</strong></summary><p>
+<details><summary><strong>Setting context</strong></summary><p>
 
-Custom contexts allow you to extend beyond contexts already defined in
-the [`Timber::Contexts`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Contexts)
-namespace. If you aren't sure what context is, please read the
-["Metdata, Context, and Events" doc](https://timber.io/docs/concepts/metadata-context-and-events).
+Context is amazingly powerful, think of it like join data for your logs. It represents the
+environment when the log was written, allowing you to relate logs so you can easily segment them.
+It's how Timber is able to accomplish features like
+[tailing users](https://timber.io/docs/app/console/tail-a-user) and
+[tracing HTTP requests](https://timber.io/docs/app/console/trace-http-requests).
+Keep in mind, Timber defines common contexts in the
+[`Timber::Contexts`](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Contexts) namespace,
+which are automatically set for you through our [integrations](#integrations). You should not
+have to maually set these contexts except in special circumstances.
 
 ### How to use it
 
 ```ruby
-logger.with_context(build: {version: "1.0.0"}) do
-  logger.info("My log message")
+logger.with_context(job: {id: 123}) do
+  logger.info("Background job execution started")
+  # ... code here
+  logger.info("Background job execution completed")
 end
 ```
 
-1. [Search it](https://timber.io/docs/app/console/searching) with queries like: `build.version:1.0.0`
+1. [Search it](https://timber.io/docs/app/console/searching) with queries like: `job.id:123`
 2. [View this context when viewing a log's metadata](https://timber.io/docs/app/console/view-metdata-and-context)
 3. ...read more in our [docs](https://timber.io/docs/languages/ruby/usage/custom-context)
 
@@ -158,7 +166,7 @@ config = Timber::Config.instance
 config.logrageify!()
 ```
 
-## How it works
+### How it works
 
 It turns this:
 
@@ -301,10 +309,10 @@ All variables are optional, but at least one must be present.
 
 ## Integrations
 
-[Timber for Ruby](https://github.com/timberio/timber-ruby) extends beyond your basic logging
-functionality and integrates with popular libraries and frameworks. This makes structured quality
-logging effortless. Below is a list of integrations we offer and the various events and contexts
-they create.
+Timber integrates with popular frameworks and libraries to capture context and metadata you
+couldn't otherwise. This automatically upgrades logs produced by these libraries, making them
+[easier to search and use](#do-amazing-things-with-your-logs). Below is a list of libraries we
+support:
 
 1. [**Rails**](https://timber.io/docs/languages/ruby/integrations/rails)
 2. [**Rack**](https://timber.io/docs/languages/ruby/integrations/rack)
@@ -318,14 +326,13 @@ they create.
 
 ## Do amazing things with your logs
 
-What does all of this mean? Doing amazing things with your logs! Being more productive, solving
-problems faster, and _actually_ enjoying using your logs for application insight:
+Unlock the potential of your logs:
 
-1. [**Live tail users on your app**](https://timber.io/docs/app/console/tail-a-user)
-2. [**Trace HTTP requests**](https://timber.io/docs/app/console/trace-http-requests)
-3. [**Inspect HTTP request parameters**](https://timber.io/docs/app/console/inspect-http-requests)
-4. [**Powerful searching**](https://timber.io/docs/app/console/searching)
-5. [**Threshold based alerting**](https://timber.io/docs/app/alerts)
+1. [**Powerful searching.** - Find what you need faster.](https://timber.io/docs/app/console/searching)
+2. [**Live tail users.** - Easily solve customer issues.](https://timber.io/docs/app/console/tail-a-user)
+3. [**Viw logs per HTTP request.** - See the full story without the noise.](https://timber.io/docs/app/console/trace-http-requests)
+4. [**Inspect HTTP request parameters.** - Quickly reproduce issues.](https://timber.io/docs/app/console/inspect-http-requests)
+5. [**Threshold based alerting.** - Know when things break.](https://timber.io/docs/app/alerts)
 6. ...and more! Checkout our [the Timber application docs](https://timber.io/docs/app)
 
 

data/lib/timber/cli/config_file.rb

@@ -22,6 +22,10 @@ module Timber
         append!("config.logrageify!")
       end
 
+      def silence_template_renders!
+        append!("config.integrations.action_view.silence = true")
+      end
+
       private
         def append!(code)
           if !content.include?(code)

data/lib/timber/cli/installers.rb

@@ -19,6 +19,33 @@ module Timber
           io.puts IO::Messages.separator, :green
           io.puts ""
 
+          # if OSHelper.has_git?
+          #   if OSHelper.git_master? || !OSHelper.git_clean_working_tree?
+          #     io.puts "Before we begin, this installer will make a few simple code changes."
+          #     io.puts ""
+
+          #     case io.ask_yes_no("Would you like to exit and start over on a clean git branch?")
+          #     when :yes
+          #       command = "git checkout -b install-timber"
+          #       copied = OSHelper.copy_to_clipboard(command)
+
+          #       io.puts ""
+          #       io.puts "Good idea. Here's a simple git command to make things easier:"
+          #       io.puts ""
+          #       io.puts "    #{IO::ANSI.colorize(command, :blue)}"
+
+          #       if copied
+          #         io.puts "    #{IO::Messages.copied_to_clipboard}"
+          #       end
+
+          #       io.puts ""
+          #       io.puts "Once you've switched branches, run the installer command again."
+          #       io.puts ""
+          #       return
+          #     end
+          #   end
+          # end
+
           if !api_key
             api.event(:no_api_key)
 
@@ -33,7 +60,7 @@ module Timber
             if OSHelper.can_open?
               case io.ask_yes_no("Open #{app_url}?")
               when :yes
-                puts ""
+                io.puts ""
                 io.task("Opening #{app_url}") do
                   OSHelper.open(app_url)
                 end

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

@@ -22,6 +22,8 @@ module Timber
 
           if logrageify?
             config_file.logrageify!
+          elsif silence_template_renders?
+            config_file.silence_template_renders!
           end
 
           io.puts ""
@@ -31,7 +33,7 @@ module Timber
 
         private
           def logrageify?
-            if defined?(::Lograge)
+            if lograge?
               io.puts ""
               io.puts IO::Messages.separator
               io.puts ""
@@ -54,6 +56,44 @@ module Timber
               false
             end
           end
+
+          def lograge?
+            require "lograge"
+            true
+          rescue Exception
+            false
+          end
+
+          def silence_template_renders?
+            if action_view?
+              io.puts ""
+              io.puts IO::Messages.separator
+              io.puts ""
+              io.puts "Would you like to silence template render logs?"
+              io.puts "(We've founds this to be of low value in production environments."
+              io.puts "You can always adjust this later in config/initialzers/timber.rb)"
+              io.puts ""
+              io.puts "y) Yes, silence template renders", :blue
+              io.puts "n) No, use the Rails logging defaults", :blue
+              io.puts ""
+
+              case io.ask_yes_no("Enter your choice:", event_prompt: "Silence template renders?")
+              when :yes
+                true
+              when :no
+                false
+              end
+            else
+              false
+            end
+          end
+
+          def action_view?
+            require("action_view")
+            true
+          rescue Exception
+            false
+          end
       end
     end
   end

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

@@ -111,11 +111,11 @@ module Timber
             io.puts ""
             io.puts IO::Messages.separator
             io.puts ""
-            io.puts "All done! Simply run your application locally and you'll see logs"
-            io.puts "show up in Timber. Enjoy!"
+            io.puts "All done! To start using Timber:"
             io.puts ""
-            io.puts "When you're ready to move to production/staging, create a"
-            io.puts "production/staging app in Timber and follow the instructions shown."
+            io.puts IO::ANSI.colorize("1. Run your application locally to see logs show up in Timber", :blue)
+            io.puts IO::ANSI.colorize("2. When you're ready to move to production/staging, create a", :blue)
+            io.puts IO::ANSI.colorize("   production/staging app in Timber and follow the instructions shown.", :blue)
             io.puts ""
             io.ask_to_proceed
           end

data/lib/timber/cli/io/messages.rb

@@ -91,7 +91,7 @@ MESSAGE
 
         def free_data
           message = <<-MESSAGE
-Because you're awesome, we've credited your account with ✨ 100mb✨.
+Get free data:
 
 * Get ✨ 250mb✨  for starring our repo: #{IO::ANSI.colorize(REPO_URL, :blue)}
 * Get ✨ 250mb✨  for tweeting your experience to #{IO::ANSI.colorize(TWITTER_HANDLE, :blue)}
@@ -101,7 +101,7 @@ MESSAGE
 
         def header
           message = <<-MESSAGE
-🌲 Timber.io Ruby Installer
+🌲 Timber.io Ruby Installer - Sane logging for Ruby developers.
 
  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^
 /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\

data/lib/timber/cli/os_helper.rb

@@ -14,6 +14,10 @@ module Timber
         false
       end
 
+      def self.git_clean_working_tree?
+        `git diff-index --quiet HEAD -- || echo "untracked";` == ""
+      end
+
       def self.git_commit_changes
         begin
           `git add config/initializers/timber.rb`
@@ -26,6 +30,10 @@ module Timber
         false
       end
 
+      def self.git_master?
+        `git rev-parse --abbrev-ref HEAD` == "master"
+      end
+
       def self.has_git?
         begin
           `which git` != ""

data/lib/timber/current_context.rb

@@ -52,22 +52,11 @@ module Timber
     # @note Because context is included with every log line, it is recommended that you limit this
     #   to only neccessary data.
     #
-    # @example Adding a custom context with a map
+    # @example Adding a custom context
     #   Timber::CurrentContext.with({build: {version: "1.0.0"}}) do
     #     # ... anything logged here will include the context ...
     #   end
     #
-    # @example Adding a custom context with a struct
-    #   BuildContext = Struct.new(:version) do
-    #     def type; :build; end
-    #    end
-    #    build_context = BuildContext.new("1.0.0")
-    #    Timber::CurrentContext.with(build_context) do
-    #     # ... 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::Integrations
-    #
     # @example Adding multiple contexts
     #   Timber::CurrentContext.with(context1, context2) { ... }
     def with(*objects)

data/lib/timber/log_devices.rb

@@ -1,5 +1,4 @@
 require "timber/log_devices/http"
-require "timber/log_devices/multi"
 
 module Timber
   # Namespace for all log devices.

data/lib/timber/logger.rb

@@ -8,63 +8,14 @@ require "timber/log_devices"
 require "timber/log_entry"
 
 module Timber
-  # The Timber Logger behaves exactly like `::Logger`, except that it supports a transparent API
-  # for logging structured messages. It ensures your log messages are communicated properly
-  # with the Timber.io API.
+  # The Timber Logger behaves exactly like the standard Ruby `::Logger`, except that it supports a
+  # transparent API for logging structured data and events.
   #
-  # To adhere to our no code debt / no lock-in promise, the Timber Logger will *never* deviate
-  # from the `::Logger` interface. That is, it will *never* add methods, or alter any
-  # method signatures. This ensures Timber can be removed without consequence.
-  #
-  # @example Basic example (the original ::Logger interface remains untouched):
+  # @example Basic logging
   #   logger.info "Payment rejected for customer #{customer_id}"
   #
-  # @example Using a Hash
-  #   # The :message key is required, the other additional key is your event type and data
-  #   # :type is the namespace used in timber for the :data
+  # @example Logging an event
   #   logger.info "Payment rejected", payment_rejected: {customer_id: customer_id, amount: 100}
-  #
-  # @example Using a Struct (a simple, more structured way, to define events)
-  #   PaymentRejectedEvent = Struct.new(:customer_id, :amount, :reason) do
-  #     # `#message` and `#type` are required, otherwise they will not be logged properly.
-  #     # `#type` is the namespace used in timber for the struct data
-  #     def message; "Payment rejected for #{customer_id}"; end
-  #     def type; :payment_rejected; end
-  #   end
-  #   Logger.info PaymentRejectedEvent.new("abcd1234", 100, "Card expired")
-  #
-  # @example Using typed Event classes
-  #   # Event implementation is left to you. Events should be simple classes.
-  #   # The only requirement is that it responds to #to_timber_event and return the
-  #   # appropriate Timber::Events::* type.
-  #   class Event
-  #     def to_hash
-  #       hash = {}
-  #       instance_variables.each { |var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
-  #       hash
-  #     end
-  #     alias to_h to_hash
-  #
-  #     def to_timber_event
-  #       Timber::Events::Custom.new(type: type, message: message, data: to_hash)
-  #     end
-  #
-  #     def message; raise NotImplementedError.new; end
-  #     def type; raise NotImplementedError.new; end
-  #   end
-  #
-  #   class PaymentRejectedEvent < Event
-  #     attr_accessor :customer_id, :amount
-  #     def initialize(customer_id, amount)
-  #       @customer_id = customer_id
-  #       @amount = amount
-  #     end
-  #     def message; "Payment rejected for customer #{customer_id}"; end
-  #     def type; :payment_rejected_event; end
-  #   end
-  #
-  #   Logger.info PymentRejectedEvent.new("abcd1234", 100)
-  #
   class Logger < ::Logger
 
     # @private
@@ -209,15 +160,13 @@ module Timber
     #   file_device = Logger::LogDevice.new("path/to/file.log")
     #   logger = Timber::Logger.new(http_device, file_device)
     def initialize(*io_devices)
-      io_device = \
-        if io_devices.size == 0
-          raise ArgumentError.new("At least one IO device must be provided when instantiating " +
-            "a Timber::Logger. Ex: Timber::Logger.new(STDOUT).")
-        elsif io_devices.size > 1
-          LogDevices::Multi.new(io_devices)
-        else
-          io_devices.first
-        end
+      if io_devices.size == 0
+        raise ArgumentError.new("At least one IO device must be provided when instantiating " +
+          "a Timber::Logger. Ex: Timber::Logger.new(STDOUT).")
+      end
+
+      @extra_loggers = io_devices[1..-1].collect { |io_device| self.class.new(io_device) }
+      io_device = io_devices[0]
 
       super(io_device)
 
@@ -275,6 +224,11 @@ module Timber
     # This is required because of Rails' monkey patching on Logger via `::LoggerSilence`.
     def add(severity, message = nil, progname = nil, &block)
       return true if @logdev.nil? || (severity || UNKNOWN) < level
+
+      @extra_loggers.each do |logger|
+        logger.add(severity, message, progname, &block)
+      end
+
       super
     end
 

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.1.4"
+  VERSION = "2.1.5"
 end

data/spec/timber/cli/config_file_spec.rb

@@ -16,7 +16,8 @@ describe Timber::CLI::ConfigFile, :rails_23 => true do
   end
 
   describe ".logrageify!" do
-    it "should set the option in the config file" do
+    it "should not set the option in the config file" do
+      allow(config_file).to receive(:log_rage?).and_return(true)
       config_file.logrageify!
       new_contents = initial_contents.gsub(contents_hook, "config.logrageify!\n\n#{contents_hook}")
       expect(config_file.send(:content)).to eq(new_contents)

data/spec/timber/cli/installers/config_file_spec.rb

@@ -40,18 +40,11 @@ describe Timber::CLI::Installers::ConfigFile, :rails_23 => true do
       expect(output.string).to eq("")
     end
 
-    context "with a Lograge constant" do
-      around(:each) do |example|
-        Lograge = 1
-        example.run
-        Object.send(:remove_const, :Lograge)
-      end
-
-      it "should prompt for Lograge configuration and return true for y" do
-        input.string = "y\n"
-        expect(installer.send(:logrageify?)).to eq(true)
-        expect(output.string).to eq("\n--------------------------------------------------------------------------------\n\nWe noticed you have lograge installed. Would you like to configure \nTimber to function similarly?\n(This silences template renders, sql queries, and controller calls.\nYou can always do this later in config/initialzers/timber.rb)\n\n\e[34my) Yes, configure Timber like lograge\e[0m\n\e[34mn) No, use the Rails logging defaults\e[0m\n\nEnter your choice: (y/n) ")
-      end
+    it "should prompt for Lograge configuration and return true for y" do
+      allow(installer).to receive(:lograge?).and_return(true)
+      input.string = "y\n"
+      expect(installer.send(:logrageify?)).to eq(true)
+      expect(output.string).to eq("\n--------------------------------------------------------------------------------\n\nWe noticed you have lograge installed. Would you like to configure \nTimber to function similarly?\n(This silences template renders, sql queries, and controller calls.\nYou can always do this later in config/initialzers/timber.rb)\n\n\e[34my) Yes, configure Timber like lograge\e[0m\n\e[34mn) No, use the Rails logging defaults\e[0m\n\nEnter your choice: (y/n) ")
     end
   end
 end

data/spec/timber/logger_spec.rb

@@ -21,7 +21,7 @@ describe Timber::Logger, :rails_23 => true do
       end
     end
 
-    it "should use the Multi log device" do
+    it "should allow multiple loggers" do
       io1 = StringIO.new
       io2 = StringIO.new
       logger = Timber::Logger.new(STDOUT, io1, io2)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -217,7 +217,6 @@ files:
 - lib/timber/log_devices/http.rb
 - lib/timber/log_devices/http/dropping_sized_queue.rb
 - lib/timber/log_devices/http/flushable_sized_queue.rb
-- lib/timber/log_devices/multi.rb
 - lib/timber/log_entry.rb
 - lib/timber/logger.rb
 - lib/timber/overrides.rb

data/lib/timber/log_devices/multi.rb

@@ -1,34 +0,0 @@
-module Timber
-  module LogDevices
-    # @private
-    #
-    # A log device that writes to multiple IO devices.
-    #
-    # Note, you should not have to instantiate this class directly. Simply pass multiple
-    # arguments to the `Timber::Logger#new` method.
-    #
-    # See the {Timber::Logger#new} for examples.
-    class Multi
-      def initialize(targets)
-        @targets = targets
-      end
-
-      def write(*args)
-        @targets.each { |t| t.write(*args) }
-        @targets.first
-      end
-
-      def sync=(value)
-        @targets.each do |t|
-          if t.respond_to?(:sync=)
-            t.sync = value
-          end
-        end
-      end
-
-      def close
-        @targets.each(&:close)
-      end
-    end
-  end
-end