timberio 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a2f951ecceb005b1ad5298962aaf33f78095aa
-  data.tar.gz: 88359ccfc0697431e1ed5739090dbb1e737df25e
+  metadata.gz: 9e9463fc2083482f241bbe9f87bc3d50aec6cb10
+  data.tar.gz: 2ea0cb35a47c3854b235db761b4e54091779e0cf
 SHA512:
-  metadata.gz: 5eec11448e4d4c7c12e2d0b997087d650022922b11c079e79ec615ff04c824b09c046399eb3e852c41b04d125fe0af6860dedd8982f23852e52dba1f92838325
-  data.tar.gz: 9cb61772c8c75ba6d95134deff15e034184ec4c1d4bae0f35cbe41821d69c2176282d562b59b7fe78d989032ec128c5c33cabb9ee359c8373a847426994fbd1e
+  metadata.gz: 2e60262ff12446fd9054fd3903273a13602a94dd994b5d5e7c51d6ab554ba169b0e0b786a30af64ea3e1039538ba60269ef276be28d05528aa2965026d6d6ffe
+  data.tar.gz: edc32d438d1b37858de0f2a862261179767d33a280dac86f713372ff7332edaf3c0db34e103a30ebdb0a093c7157971b9e7524bc6f95e873a2f782a9a37d1c70

data/README.md

@@ -1,7 +1,7 @@
 # Timber
 
 <p align="center" style="background: #140f2a;">
-<a href="http://github.com/timberio/timber-ruby"><img src="http://files.timber.io/images/ruby-library-readme-header.gif" height="370" /></a>
+<a href="http://github.com/timberio/timber-ruby"><img src="http://files.timber.io/images/ruby-library-readme-header.gif" height="469" /></a>
 </p>
 
 [![CircleCI](https://circleci.com/gh/timberio/timber-ruby.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/timberio/timber-ruby/tree/master)
@@ -11,16 +11,15 @@
 
 
 1. [What is timber?](#what-is-timber)
-2. [Examples](#examples)
-3. [Pricing](#pricing)
+2. [Logger Examples](#logger-examples)
+3. [Console Pricing](#console-pricing)
 2. [Install](#install)
 
 
 ## What is Timber?
 
-Glad you asked :) Timber tames the crazy world that is logging. First, it *automatically*
-augments your logs with structured data. Second, it provides a transparent, no lock-in, API
-for logging your own events. Lastly, it can be paired with a [simple modern console](https://timber.io) for querying.
+Glad you asked! :) Timber turns your messy string logs into structured events with context where
+it can optionally be paired with our [simple modern console](https://timber.io) for querying.
 
 For example, it automatically turns this:
 
@@ -69,7 +68,7 @@ This enables you to query your logs in a way that
   4. `level:warn` - Log levels in your logs. Imagine that!
 
 
-## Examples
+## Logger Examples
 
 > Another service? More lock-in? More code debt? More sadness? :*(
 
@@ -128,18 +127,18 @@ My Application |--[STDOUT]--> logs ---> Timber ---> |-- new relic / etc
 ```
 
 
-## Pricing
+## Console Pricing
 
 > This is all gravy, but wouldn't it get expensive?
 
 If you opt to send your data to the [Timber service](https://timber.io), we only charge for
 the size of the `message`, `dt`, and `event.custom` attributes. Everything else is
 stored at no cost to you. [Say wha?!](http://i.giphy.com/l0HlL2vlfpWI0meJi.gif). This ensures
-pricing remains predictable. And our pricing is simple, we charge per GB transferred to us and
-retained, no user limits, and no weird feature matrixes. Lastly, the data is yours, in a simple
-non-proprietary JSON format.
+pricing remains predictable and simple. We charge per GB transferred to us and
+retained, no user limits, and no weird feature matrixes. Finally, the data is yours, in a simple
+non-proprietary JSON format that you can export to S3, Redshift, or any of our other integrations.
 
-For more details checkout our [timber.io](https://timber.io).
+For more details checkout out [timber.io](https://timber.io).
 
 ## Install
 
@@ -147,7 +146,7 @@ For more details checkout our [timber.io](https://timber.io).
 
 ```ruby
 # Gemfile
-gem 'timberio', require: "timber"
+gem 'timberio'
 ```
 
 ### 2. Install the logger:

data/circle.yml

@@ -10,12 +10,10 @@ dependencies:
     - PATH=/home/ubuntu/.rvm/gems/ruby-1.9.3-p448/bin:$PATH rvm-exec 1.9.3 appraisal rails-3.0.X bundle install
     - PATH=/home/ubuntu/.rvm/gems/ruby-1.9.3-p448/bin:$PATH rvm-exec 1.9.3 appraisal rails-3.1.X bundle install
     - PATH=/home/ubuntu/.rvm/gems/ruby-1.9.3-p448/bin:$PATH rvm-exec 1.9.3 appraisal rails-3.2.X bundle install
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 bundle install
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-4.0.X bundle install
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-4.1.X bundle install
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-4.2.X bundle install
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-5.0.X bundle install
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-edge bundle install
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.2.6/bin:$PATH rvm-exec 2.2.6 bundle install
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.2.6/bin:$PATH rvm-exec 2.2.6 appraisal install
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.3/bin:$PATH rvm-exec 2.3.3 bundle install
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.3/bin:$PATH rvm-exec 2.3.3 appraisal install
 
 test:
   override:
@@ -23,8 +21,13 @@ test:
     - PATH=/home/ubuntu/.rvm/gems/ruby-1.9.3-p448/bin:$PATH rvm-exec 1.9.3 appraisal rails-3.0.X rspec
     - PATH=/home/ubuntu/.rvm/gems/ruby-1.9.3-p448/bin:$PATH rvm-exec 1.9.3 appraisal rails-3.1.X rspec
     - PATH=/home/ubuntu/.rvm/gems/ruby-1.9.3-p448/bin:$PATH rvm-exec 1.9.3 appraisal rails-3.2.X rspec
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-4.0.X rspec
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-4.1.X rspec
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-4.2.X rspec
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-5.0.X rspec
-    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.0/bin:$PATH rvm-exec 2.3.0 appraisal rails-edge rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.2.6/bin:$PATH rvm-exec 2.2.6 appraisal rails-4.0.X rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.2.6/bin:$PATH rvm-exec 2.2.6 appraisal rails-4.1.X rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.2.6/bin:$PATH rvm-exec 2.2.6 appraisal rails-4.2.X rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.2.6/bin:$PATH rvm-exec 2.2.6 appraisal rails-5.0.X rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.2.6/bin:$PATH rvm-exec 2.2.6 appraisal rails-edge rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.3/bin:$PATH rvm-exec 2.3.3 appraisal rails-4.0.X rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.3/bin:$PATH rvm-exec 2.3.3 appraisal rails-4.1.X rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.3/bin:$PATH rvm-exec 2.3.3 appraisal rails-4.2.X rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.3/bin:$PATH rvm-exec 2.3.3 appraisal rails-5.0.X rspec
+    - PATH=/home/ubuntu/.rvm/gems/ruby-2.3.3/bin:$PATH rvm-exec 2.3.3 appraisal rails-edge rspec

data/lib/timber/logger.rb

@@ -114,8 +114,7 @@ module Timber
         log_entry = build_log_entry(severity, time, progname, msg)
         metadata = log_entry.to_json(:except => [:message])
         # use << for concatenation for performance reasons
-        puts msg
-        log_entry.message << " " << METADATA_CALLOUT << " " << metadata << "\n"
+        log_entry.message.gsub("\n", "\\n") << " " << METADATA_CALLOUT << " " << metadata << "\n"
       end
     end
 

data/lib/timber/probes/action_dispatch_debug_exceptions.rb

@@ -11,7 +11,6 @@ module Timber
             private
               def log_error(request, wrapper)
                 logger = logger(request)
-                puts logger.inspect
                 return unless logger
 
                 exception = wrapper.exception

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/spec/timber/logger_spec.rb

@@ -54,6 +54,11 @@ describe Timber::Logger, :rails_23 => true do
         end
         expect(io.string).to eq("payment rejected @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\",\"event\":{\"custom\":{\"payment_rejected\":{\"customer_id\":\"abcde1234\",\"amount\":100}}}}\n")
       end
+
+      it "should escape new lines" do
+        logger.info "first\nsecond"
+        expect(io.string).to eq("first\\nsecond @timber.io {\"level\":\"info\",\"dt\":\"2016-09-01T12:00:00.000000Z\"}\n")
+      end
     end
 
     context "with the :json format" do

data/spec/timber/probes/action_dispatch_debug_exceptions_spec.rb

@@ -37,7 +37,7 @@ describe Timber::Probes::ActionDispatchDebugExceptions do
         mock_class
         dispatch_rails_request("/exception")
         # Because constantly updating the line numbers sucks :/
-        expect(io.string).to include("RuntimeError (boom):\n\n")
+        expect(io.string).to include("RuntimeError (boom):\\n\\n")
         expect(io.string).to include("@timber.io")
         expect(io.string).to include("\"event\":{\"exception\":{\"name\":\"RuntimeError\",\"message\":\"boom\",\"backtrace\":[\"")
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timberio
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2016-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack