timber 2.6.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb990174a93469450d73ae20ffd997d61ca0f01e
-  data.tar.gz: 0f7ada34254928c3b196b5e33ab5e7b11dbc3982
+SHA256:
+  metadata.gz: 3a26e7b9b1e27e631deac9a62753d67fabfe532a37446c29ad532fc6948b5682
+  data.tar.gz: 66c38071146891f8d8e7a763a2486eda7d5aef7fdffbffb9a26dc8128a581e79
 SHA512:
-  metadata.gz: 859c860cb28a5e11d6901ca8648e8e3467b43ac21131e4c33f5601883c8543427a21709f4f19827728ed0d0cddfe5ddfb176851109d69e5c4d8b3eb5ee11d701
-  data.tar.gz: 10750c2cdd80151a56dee093f0c63e8180d4875235092e795a69ea1d459108e7f02f246251492267d1bacaf32ad1e3b36dc98e0db9dd4b696c2680b7518b7270
+  metadata.gz: 5acf7ca9461dd5b24b20cda20f7f6828e5f78c8fcb8cc44a3ef8a01ec882ba5fbcdec33f522d5753b4ef81a750c27820b33dbfb8d4cdd5eab80a299ce43bdece
+  data.tar.gz: e47f9313d14194be733203491d82213f87e5d1c2d5f2f6796a29e489dec892b6b699016a657147263e2658fd835f7836b64ed423fa6c882c1dd9171b8e2c51ee

data/.travis.yml

@@ -3,23 +3,13 @@ language: ruby
 cache: bundler
 rvm:
 - 1.9.3
-- 2.2.6
-- 2.3.3
-- 2.4.2
-- jruby-1.7.26
-- jruby-9.1.9.0
-gemfile:
-- gemfiles/rails-3.0.gemfile
-- gemfiles/rails-3.1.gemfile
-- gemfiles/rails-3.2.gemfile
-- gemfiles/rails-4.0.gemfile
-- gemfiles/rails-4.1.gemfile
-- gemfiles/rails-4.2.gemfile
-- gemfiles/rails-5.0.gemfile
-- gemfiles/rails-5.1.gemfile
-- gemfiles/rails-edge.gemfile
-env:
-  global: RAILS_ENV=test
+- 2.2.10
+- 2.3.8
+- 2.4.5
+- 2.5.3
+- jruby-1.7.27
+- jruby-9.2.5.0
+before_install: gem install bundler -v 1.17.3
 before_script:
 - echo $BUNDLE_GEMFILE
 - bundle install
@@ -27,27 +17,7 @@ script:
   - bundle exec rspec --format documentation
 matrix:
   fast_finish: true
-  exclude:
-    - rvm: 1.9.3
-    - rvm: 2.2.6
-      gemfile: gemfiles/rails-edge.gemfile
-    - rvm: 2.3.3
-      gemfile: gemfiles/rails-edge.gemfile
-  include:
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails-3.0.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails-3.1.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails-3.2.gemfile
-  allow_failures:
-  - rvm: 1.9.3 # bundler wont install the gems
-  - rvm: 2.4.2
-    gemfile: gemfiles/rails-4.0.gemfile
-  - rvm: 2.4.2
-    gemfile: gemfiles/rails-4.1.gemfile
-  - rvm: jruby-1.7.26
-  - rvm: jruby-9.1.9.0
+
 notifications:
   email: false
   slack:

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Changed
+
+  - Timber's Rails integration has been moved to the optional `timber_rails` gem: https://github.com/timberio/timber-ruby-rails
+  - Timber's Rack integration has been moved to the optional `timber_rack` gem: https://github.com/timberio/timber-ruby-rack
+  - Custom events are no longer nested under the `custom.event` key, events are now merged into the root docoment.
+  - Custom contexts are no longer nested under the `context.custom` key, contexts are not part of the top-level `context` document.
+  - The Timber JSON schema (`$shema` key) was dropped since the Timber.io service no longer requires a strict schema (structured data in any shape is accepted).
+  - `Timber::LogDevices::HTTP#initialize` now takes a second `source_id` parameter. Timber's new API keys are no longer Timber source specific and therefore require a `source_id` to be specificed. Ex: `Timber::LogDevices::HTTP.new('api_key', 'source_id')`.
+
 ## [2.6.2] - 2018-10-17
 
 ### Fixed

data/README.md

@@ -1,299 +1,45 @@
 # 🌲 Timber - Great Ruby Logging Made Easy
 
+<p align="center">
+  <a href="https://timber.io" target="_blank" align="center">
+    <img src="https://res.cloudinary.com/timber/image/upload/v1552328675/banner.jpg" width="900">
+  </a>
+  <br>
+</p>
+
 [![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
 [![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)
 [![Code Climate](https://codeclimate.com/github/timberio/timber-ruby/badges/gpa.svg)](https://codeclimate.com/github/timberio/timber-ruby)
 
-Timber for Ruby is a drop in replacement for your Ruby logger that
-[unobtrusively augments](https://timber.io/docs/concepts/structuring-through-augmentation) your
-logs with [rich metadata and context](https://timber.io/docs/concepts/metadata-context-and-events)
-making them [easier to search, use, and read](#get-things-done-with-your-logs). It pairs with the
-[Timber console](#the-timber-console) to deliver a tailored Ruby logging experience designed to make
-you more productive.
-
-1. [**Installation** - One command: `bundle exec timber install`](#installation)
-2. [**Usage** - Simple & powerful API](#usage)
-3. [**Integrations** - Automatic context and metadata for your existing logs](#integrations)
-4. [**The Timber Console** - Designed for applications & developers](#the-timber-console)
-5. [**Get things done with your logs 💪**](#get-things-done-with-your-logs)
-
-
-## Installation
-
-1. In your `Gemfile`, add the `timber` gem:
-
-    ```ruby
-    gem 'timber', '~> 2.3'
-    ```
-
-2. In your `shell`, run:
-
-    ```
-    bundle install && bundle exec timber install
-    ```
-
-
-## Usage
-
-<details><summary><strong>Basic logging</strong></summary><p>
+[Timber.io](https://timber.io) is a hosted service for aggregating logs across your entire stack -
+[any language](https://docs.timber.io/setup/languages),
+[any platform](https://docs.timber.io/setup/platforms),
+[any data source](https://docs.timber.io/setup/log_forwarders).
 
-Use the `Timber::Logger` just like you would `::Logger`:
-
-```ruby
-logger.debug("Debug message")
-logger.info("Info message")
-logger.warn("Warn message")
-logger.error("Error message")
-logger.fatal("Fatal message")
-```
-
-* [Search it](https://timber.io/docs/app/console/searching) with queries like: `error message`
-* [Alert on it](https://timber.io/docs/app/console/alerts) with threshold based alerts
-* [View this event's metadata and context](https://timber.io/docs/app/console/view-metadata-and-context)
-
-[...read more in our docs](https://timber.io/docs/languages/ruby/usage/basic-logging)
-
----
-
-</p></details>
-
-<details><summary><strong>Logging events (structured data)</strong></summary><p>
-
-Log structured data without sacrificing readability:
-
-```ruby
-logger.warn "Payment rejected", payment_rejected: {customer_id: "abcd1234", amount: 100, reason: "Card expired"}
-```
-
-* [Search it](https://timber.io/docs/app/console/searching) with queries like: `type:payment_rejected` or `payment_rejected.amount:>100`
-* [Alert on it](https://timber.io/docs/app/console/alerts) with threshold based alerts
-* [View this event's data and context](https://timber.io/docs/app/console/view-metadata-and-context)
-
-...[read more in our docs](https://timber.io/docs/languages/ruby/usage/custom-events)
+Unlike traditional logging tools, Timber integrates with language runtimes to automatically
+capture in-app context, turning your text-based logs into rich structured events.
+Timber integrates with Ruby through this library. And Timber's
+[rich free-form query tools](https://docs-new.timber.io/usage/live-tailing#query-syntax) and
+[real-time tailing](https://docs-new.timber.io/usage/live-tailing), make drilling down into
+important stats easier than ever.
 
 ---
 
-</p></details>
-
-<details><summary><strong>Setting context</strong></summary><p>
-
-Add shared structured data across your logs:
-
-```ruby
-Timber.with_context(job: {id: 123}) do
-  logger.info("Background job execution started")
-  # ... code here
-  logger.info("Background job execution completed")
-end
-```
-
-* [Search it](https://timber.io/docs/app/console/searching) with queries like: `job.id:123`
-* [View this context when viewing a log's metadata](https://timber.io/docs/app/console/view-metadata-and-context)
-
-...[read more in our docs](https://timber.io/docs/languages/ruby/usage/custom-context)
+* **[Features](https://docs.timber.io/setup/languages/ruby#features)**
+* **[Installation](https://docs.timber.io/setup/languages/ruby#installation)**
+* **[Configuration](https://docs.timber.io/setup/languages/ruby#configuration)**
+* **[Usage](https://docs.timber.io/setup/languages/ruby#usage)**
+* **[Guides](https://docs.timber.io/setup/languages/ruby#guides)**
+* **[Integrations](https://docs.timber.io/setup/languages/ruby/integrations)**
+* **[Performance](https://docs.timber.io/setup/languages/ruby#performance)**
 
 ---
 
-</p></details>
-
-<details><summary><strong>Metrics, Timings, & Tracing</strong></summary><p>
-
-Time code blocks:
-
-```ruby
-timer = Timber.start_timer
-# ... code to time ...
-logger.info("Processed background job", background_job: {time_ms: timer})
-```
-
-Log generic metrics:
-
-```ruby
-logger.info("Credit card charged", credit_card_charge: {amount: 123.23})
-```
-
-* [Search it](https://timber.io/docs/app/console/searching) with queries like: `background_job.time_ms:>500`
-* [Alert on it](https://timber.io/docs/app/console/alerts) with threshold based alerts
-* [View this log's metadata in the console](https://timber.io/docs/app/console/view-metadata-and-context)
-
-...[read more in our docs](https://timber.io/docs/languages/ruby/usage/metrics-and-timings)
-
-</p></details>
-
-
-## Configuration
-
-Below are a few popular configuration options, for a comprehensive list, see
-[Timber::Config](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config).
-
-<details><summary><strong>Logrageify. Silence noisy logs.</strong></summary><p>
-
-Silence noisy logs that aren't of value to you, just like
-[lograge](https://github.com/roidrage/lograge):
-
-```ruby
-# config/initializers/timber.rb
-Timber.config.logrageify!()
-```
-
-It turns this:
-
-```
-Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100
-Processing by HomeController#index as HTML
-  Rendered text template within layouts/application (0.0ms)
-  Rendered layouts/_assets.html.erb (2.0ms)
-  Rendered layouts/_top.html.erb (2.6ms)
-  Rendered layouts/_about.html.erb (0.3ms)
-  Rendered layouts/_google_analytics.html.erb (0.4ms)
-Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms)
-```
-
-Into this:
-
-```
-Get "/" sent 200 OK in 79ms
-```
-
-### Pro-tip: Keep controller call logs (recommended)
-
-Feel free to deviate and customize which logs you silence. We recommend a slight deviation
-from lograge with the following settings:
-
-```ruby
-# config/initializers/timber.rb
-
-Timber.config.integrations.action_view.silence = true
-Timber.config.integrations.active_record.silence = true
-Timber.config.integrations.rack.http_events.collapse_into_single_event = true
-```
-
-This does _not_ silence the controller call log event. This is because Timber captures the
-parameters passed to the controller, which are generally valuable when debugging.
-
-For a full list of integration settings, see
-[Timber::Config::Integrations](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config/Integrations)
-
----
-
-</p></details>
-
-<details><summary><strong>Silence specific requests (LB health checks, etc)</strong></summary><p>
-
-Silencing noisy requests can be helpful for silencing load balance health checks, bot scanning,
-or activity that generally is not meaningful to you. The following will silence all
-`[GET] /_health` requests:
-
-```ruby
-# config/initializers/timber.rb
-
-Timber.config.integrations.rack.http_events.silence_request = lambda do |rack_env, rack_request|
-  rack_request.path == "/_health"
-end
-```
-
-We require a block because it gives you complete control over how you want to silence requests.
-The first parameter being the traditional Rack env hash, the second being a
-[Rack Request](http://www.rubydoc.info/gems/rack/Rack/Request) object.
-
----
-
-</p></details>
-
-<details><summary><strong>Capture custom user context</strong></summary><p>
-
-By default Timber automatically captures user context for most of the popular authentication
-libraries (Devise, and Clearance). See
-[Timber::Integrations::Rack::UserContext](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Integrations/Rack/UserContext)
-for a complete list.
-
-In cases where you Timber doesn't support your strategy, or you want to customize it further,
-you can do so like:
-
-```ruby
-# config/initializers/timber.rb
-
-Timber.config.integrations.rack.user_context.custom_user_hash = lambda do |rack_env|
-  user = rack_env['warden'].user
-  if user
-    {
-      id: user.id, # unique identifier for the user, can be an integer or string,
-      name: user.name, # identifiable name for the user,
-      email: user.email, # user's email address
-    }
-  else
-    nil
-  end
-end
-```
-
-*All* of the user hash keys are optional, but you must provide at least one.
-
----
-
-</p></details>
-
-<details><summary><strong>Capture release / deploy context</strong></summary><p>
-
-[Timber::Contexts::Release](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Contexts/Release)
-tracks the current application release and version.
-
-If you're on Heroku, simply enable the
-[dyno metadata](https://devcenter.heroku.com/articles/dyno-metadata) feature. If you are not,
-set the following environment variables and this context will be added automatically:
-
-1. `RELEASE_COMMIT` - Ex: `2c3a0b24069af49b3de35b8e8c26765c1dba9ff0`
-2. `RELEASE_CREATED_AT` - Ex: `2015-04-02T18:00:42Z`
-3. `RELEASE_VERSION` - Ex: `v2.3.1`
-
-All variables are optional, but at least one must be present.
-
----
-
-</p></details>
-
-
-## Integrations
-
-Timber integrates with popular frameworks and libraries to capture context and metadata you
-couldn't otherwise. This automatically augments 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:
-
-* Frameworks & Libraries
-   * [**Rails**](https://timber.io/docs/languages/ruby/integrations/rails)
-   * [**Rack**](https://timber.io/docs/languages/ruby/integrations/rack)
-   * [**Devise**](https://timber.io/docs/languages/ruby/integrations/devise)
-   * [**Clearance**](https://timber.io/docs/languages/ruby/integrations/clearnace)
-   * [**Warden**](https://timber.io/docs/languages/ruby/integrations/devise)
-* Platforms
-   * [**Heroku**](https://timber.io/docs/languages/ruby/integrations/heroku)
-   * [**System / Server**](https://timber.io/docs/languages/ruby/integrations/system)
-
-...more coming soon! Make a request by [opening an issue](https://github.com/timberio/timber-ruby/issues/new)
-
-
-## Get things done with your logs
-
-Logging features designed to help developers get more done:
-
-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. [**View 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)
-
-
-## The Timber Console
-
-[![Timber Console](http://files.timber.io/images/readme-interface7.gif)](https://timber.io/docs/app)
-
-[Learn more about our app.](https://timber.io/docs/app)
-
-## Your Moment of Zen
-
-<p align="center" style="background: #221f40;">
-<a href="https://timber.io"><img src="http://files.timber.io/images/readme-log-truth.png" height="947" /></a>
+<p align="center">
+<a href="https://timber.io">Timber</a> &bull;
+<a href="https://docs.timber.io">Docs</a> &bull;
+<a href="https://timber.io/pricing">Pricing</a> &bull;
+<a href="https://timber.io/terms">Security</a> &bull;
+<a href="https://timber.io/privacy">Compliance</a>
 </p>

data/Rakefile

@@ -0,0 +1,78 @@
+require "bundler/gem_tasks"
+require "timber"
+
+def puts_with_level(message, level = :info)
+  case level
+  when :info
+    puts("\e[31m#{message}\e[0m")
+  when :error
+    puts("\e[31m#{message}\e[0m")
+  when :success
+    puts("\e[32m#{message}\e[0m")
+  else
+    puts(message)
+  end
+end
+
+task :test_the_pipes, [:api_key] do |t, args|
+  support_email = "support@timber.io"
+  # Do not modify below this line. It's important to keep the `Timber::Logger`
+  # because it provides an API for logging structured data and capturing context.
+      header = <<-HEREDOC
+  ^  ^   ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^
+ /|\\/|\\ /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+ /|\\/|\\ /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+ /|\\/|\\ /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\
+============================================================
+               TIMBER.IO - TESTING THE PIPES
+============================================================
+    HEREDOC
+
+  puts header
+
+  current_context = Timber::CurrentContext.instance.snapshot
+  entry = Timber::LogEntry.new(:info, Time.now, nil, "Testing the pipes (click the inspect icon to view more details)", current_context, nil)
+  http_device = Timber::LogDevices::HTTP.new(args.api_key, flush_continuously: false)
+  response = http_device.deliver_one(entry)
+  if response.is_a?(Exception)
+      message = <<~HEREDOC
+        Unable to deliver logs.
+        Here's what we received from the Timber API:
+        #{response.inspect}
+        If you continue to have trouble please contact support:
+        #{support_email}
+        HEREDOC
+    puts_with_level(message, :error)
+  elsif response.is_a?(Net::HTTPResponse)
+    if response.code.start_with? '2'
+      puts_with_level("Logs successfully sent! View them at https://app.timber.io",
+                      :success)
+    else
+      message =
+        <<~HEREDOC
+        Unable to deliver logs.
+        We received a #{response.code} response from the Timber API:
+        #{response.body.inspect}
+        If you continue to have trouble please contact support:
+        #{support_email}
+        HEREDOC
+      puts_with_level(message, :error)
+    end
+  end
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'timber'
+  $VERBOSE = nil
+
+  def reload!
+    files = $LOADED_FEATURES.select { |feat| feat =~ /\/timber\// }
+    files.each { |file| load file }
+    "reloaded"
+  end
+
+  ARGV.clear
+  IRB.start
+end