opbeat 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cc7e45c2207d40f1deaa655ae2510e7f6c38d7c
-  data.tar.gz: 2793d306ca86292a30fedc2ee831af7086862adc
+  metadata.gz: ab9a138807b83eccad509ecbb47bd14c4fd4d0d9
+  data.tar.gz: 63eb2b18b8391863405f1d2d1b1e6def179ca6af
 SHA512:
-  metadata.gz: 388d8dedb07d74f4ee42fa21855a037a0559ea4c783e2107a8158dcc9dd2510e6e4fdc0e90a19b1a4e7fa4fdf290a50ebf23aacab5934ca937ab9edd84a01616
-  data.tar.gz: 2dc336b2815d477d7fc2fd30d2941f60cf5dd95777bdb1e3a3e70440eaa119546daff324ab07798b6d2bc58d2c15083704aa6dabbabb6fdd5fcbebbd287b59b4
+  metadata.gz: 641e5c53512558c13573579d30d92b1032116e2773a80a19c5fc8b8b381c38f4d402f8072878d3b6bce764b8577569da91eea90b75112a4559ce5b7ced08e659
+  data.tar.gz: eff01294ef09048a0e1938b8e307f6d7570f3ded99b6cb4a2f270bec1b18db48da988f67a0058d8d5b7fa3d0eeda1263bd91b985981b8f904cd1bf38ddc7d7a7

data/.gitignore

@@ -1,5 +1,6 @@
+doc
 coverage
-pkg
-ruby/
-.bundle
 Gemfile.lock
+opbeat*.gem
+.yardoc
+profile-*

data/.travis.yml

@@ -1,36 +1,27 @@
+---
 language: ruby
+cache: bundler
 rvm:
-- 1.9.2
-- 1.9.3
-- 2.0
-- 2.1
-- 2.2
-- jruby
-- rbx-2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.3
 gemfile:
-- gemfiles/rails30.gemfile
-- gemfiles/rails31.gemfile
-- gemfiles/rails32.gemfile
-- gemfiles/rails40.gemfile
-- gemfiles/rails41.gemfile
-- gemfiles/rails42.gemfile
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.0.x
+  - gemfiles/Gemfile.rails-4.1.x
+  - gemfiles/Gemfile.rails-4.2.x
 matrix:
-  include:
-    - rvm: 1.9.2
-      gemfile: gemfiles/ruby192_rails31.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/ruby192_rails32.gemfile
   exclude:
-    - rvm: 1.9.2
-      gemfile: gemfiles/rails31.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/rails32.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/rails40.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/rails41.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/rails42.gemfile
+    # Rails 4.0+ requires ruby 2.0+
+    - rvm: 1.9.3
+      Gemfile: gemfiles/Gemfile.rails-4.0.x
+    - rvm: 1.9.3
+      Gemfile: gemfiles/Gemfile.rails-4.1.x
+    - rvm: 1.9.3
+      Gemfile: gemfiles/Gemfile.rails-4.2.x
+
 notifications:
+  email: false
   slack:
     secure: IniiL3PdFsht2zykTwd/z5Et/L1U6GzsmMC1LrgccKCrvLsdcdlBU3VrAgIb1GT9FPEFpb5sl7FEBN80p6uW15uO57onUawFaSWDhSA3eXG1ImmunVPJ20U4NkJvMbnUdZXQ9XXqOw1ggkR7GrD0PM9Nzr4puWaaGq42UJjdaq0=

data/.yardopts

@@ -0,0 +1,3 @@
+--hide-api private
+--exclude lib/opbeat/integration
+lib/**/*.rb

data/Gemfile

@@ -1,2 +1,4 @@
-source "https://rubygems.org/"
-gemspec
+eval_gemfile 'gemfiles/Gemfile.base'
+
+gem "rails", ">= 3.0"
+gem 'pry'

data/HISTORY.md

@@ -0,0 +1,3 @@
+# v3.0.0
+
+3.0.0 marks a fresh start. Follow this file onwards for update information.

data/LICENSE

@@ -1,201 +1,12 @@
-                              Apache License
-                        Version 2.0, January 2004
-                     http://www.apache.org/licenses/
+Copyright (c) 2016, Opbeat, Inc
+All rights reserved.
 
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-1. Definitions.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-   "License" shall mean the terms and conditions for use, reproduction,
-   and distribution as defined by Sections 1 through 9 of this document.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-   "Licensor" shall mean the copyright owner or entity authorized by
-   the copyright owner that is granting the License.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-   "Legal Entity" shall mean the union of the acting entity and all
-   other entities that control, are controlled by, or are under common
-   control with that entity. For the purposes of this definition,
-   "control" means (i) the power, direct or indirect, to cause the
-   direction or management of such entity, whether by contract or
-   otherwise, or (ii) ownership of fifty percent (50%) or more of the
-   outstanding shares, or (iii) beneficial ownership of such entity.
-
-   "You" (or "Your") shall mean an individual or Legal Entity
-   exercising permissions granted by this License.
-
-   "Source" form shall mean the preferred form for making modifications,
-   including but not limited to software source code, documentation
-   source, and configuration files.
-
-   "Object" form shall mean any form resulting from mechanical
-   transformation or translation of a Source form, including but
-   not limited to compiled object code, generated documentation,
-   and conversions to other media types.
-
-   "Work" shall mean the work of authorship, whether in Source or
-   Object form, made available under the License, as indicated by a
-   copyright notice that is included in or attached to the work
-   (an example is provided in the Appendix below).
-
-   "Derivative Works" shall mean any work, whether in Source or Object
-   form, that is based on (or derived from) the Work and for which the
-   editorial revisions, annotations, elaborations, or other modifications
-   represent, as a whole, an original work of authorship. For the purposes
-   of this License, Derivative Works shall not include works that remain
-   separable from, or merely link (or bind by name) to the interfaces of,
-   the Work and Derivative Works thereof.
-
-   "Contribution" shall mean any work of authorship, including
-   the original version of the Work and any modifications or additions
-   to that Work or Derivative Works thereof, that is intentionally
-   submitted to Licensor for inclusion in the Work by the copyright owner
-   or by an individual or Legal Entity authorized to submit on behalf of
-   the copyright owner. For the purposes of this definition, "submitted"
-   means any form of electronic, verbal, or written communication sent
-   to the Licensor or its representatives, including but not limited to
-   communication on electronic mailing lists, source code control systems,
-   and issue tracking systems that are managed by, or on behalf of, the
-   Licensor for the purpose of discussing and improving the Work, but
-   excluding communication that is conspicuously marked or otherwise
-   designated in writing by the copyright owner as "Not a Contribution."
-
-   "Contributor" shall mean Licensor and any individual or Legal Entity
-   on behalf of whom a Contribution has been received by Licensor and
-   subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   copyright license to reproduce, prepare Derivative Works of,
-   publicly display, publicly perform, sublicense, and distribute the
-   Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   (except as stated in this section) patent license to make, have made,
-   use, offer to sell, sell, import, and otherwise transfer the Work,
-   where such license applies only to those patent claims licensable
-   by such Contributor that are necessarily infringed by their
-   Contribution(s) alone or by combination of their Contribution(s)
-   with the Work to which such Contribution(s) was submitted. If You
-   institute patent litigation against any entity (including a
-   cross-claim or counterclaim in a lawsuit) alleging that the Work
-   or a Contribution incorporated within the Work constitutes direct
-   or contributory patent infringement, then any patent licenses
-   granted to You under this License for that Work shall terminate
-   as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-   Work or Derivative Works thereof in any medium, with or without
-   modifications, and in Source or Object form, provided that You
-   meet the following conditions:
-
-   (a) You must give any other recipients of the Work or
-       Derivative Works a copy of this License; and
-
-   (b) You must cause any modified files to carry prominent notices
-       stating that You changed the files; and
-
-   (c) You must retain, in the Source form of any Derivative Works
-       that You distribute, all copyright, patent, trademark, and
-       attribution notices from the Source form of the Work,
-       excluding those notices that do not pertain to any part of
-       the Derivative Works; and
-
-   (d) If the Work includes a "NOTICE" text file as part of its
-       distribution, then any Derivative Works that You distribute must
-       include a readable copy of the attribution notices contained
-       within such NOTICE file, excluding those notices that do not
-       pertain to any part of the Derivative Works, in at least one
-       of the following places: within a NOTICE text file distributed
-       as part of the Derivative Works; within the Source form or
-       documentation, if provided along with the Derivative Works; or,
-       within a display generated by the Derivative Works, if and
-       wherever such third-party notices normally appear. The contents
-       of the NOTICE file are for informational purposes only and
-       do not modify the License. You may add Your own attribution
-       notices within Derivative Works that You distribute, alongside
-       or as an addendum to the NOTICE text from the Work, provided
-       that such additional attribution notices cannot be construed
-       as modifying the License.
-
-   You may add Your own copyright statement to Your modifications and
-   may provide additional or different license terms and conditions
-   for use, reproduction, or distribution of Your modifications, or
-   for any such Derivative Works as a whole, provided Your use,
-   reproduction, and distribution of the Work otherwise complies with
-   the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-   any Contribution intentionally submitted for inclusion in the Work
-   by You to the Licensor shall be under the terms and conditions of
-   this License, without any additional terms or conditions.
-   Notwithstanding the above, nothing herein shall supersede or modify
-   the terms of any separate license agreement you may have executed
-   with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-   names, trademarks, service marks, or product names of the Licensor,
-   except as required for reasonable and customary use in describing the
-   origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-   agreed to in writing, Licensor provides the Work (and each
-   Contributor provides its Contributions) on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-   implied, including, without limitation, any warranties or conditions
-   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-   PARTICULAR PURPOSE. You are solely responsible for determining the
-   appropriateness of using or redistributing the Work and assume any
-   risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-   whether in tort (including negligence), contract, or otherwise,
-   unless required by applicable law (such as deliberate and grossly
-   negligent acts) or agreed to in writing, shall any Contributor be
-   liable to You for damages, including any direct, indirect, special,
-   incidental, or consequential damages of any character arising as a
-   result of this License or out of the use or inability to use the
-   Work (including but not limited to damages for loss of goodwill,
-   work stoppage, computer failure or malfunction, or any and all
-   other commercial damages or losses), even if such Contributor
-   has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-   the Work or Derivative Works thereof, You may choose to offer,
-   and charge a fee for, acceptance of support, warranty, indemnity,
-   or other liability obligations and/or rights consistent with this
-   License. However, in accepting such obligations, You may act only
-   on Your own behalf and on Your sole responsibility, not on behalf
-   of any other Contributor, and only if You agree to indemnify,
-   defend, and hold each Contributor harmless for any liability
-   incurred by, or claims asserted against, such Contributor by reason
-   of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-   To apply the Apache License to your work, attach the following
-   boilerplate notice, with the fields enclosed by brackets "[]"
-   replaced with your own identifying information. (Don't include
-   the brackets!)  The text should be enclosed in the appropriate
-   comment syntax for the file format. We also recommend that a
-   file or class name and description of purpose be included on the
-   same "printed page" as the copyright notice for easier
-   identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,267 +1,186 @@
-# Opbeat
+<h1>
+  <img src='http://opbeat-brand-assets.s3-website-us-east-1.amazonaws.com/svg/logo/logo.svg' width=400 alt='Opbeat' />
+</h1>
 
-[![Build Status](https://travis-ci.org/opbeat/opbeat_ruby.svg?branch=master)](https://travis-ci.org/opbeat/opbeat_ruby)
-
-A client and integration layer for [Opbeat](https://opbeat.com). Forked from the [raven-ruby](https://github.com/getsentry/raven-ruby) project.
+[![Build status](https://travis-ci.org/opbeat/opbeat-ruby.svg)](https://travis-ci.org/opbeat/opbeat-ruby)
 
 ## Installation
 
 Add the following to your `Gemfile`:
 
 ```ruby
-gem "opbeat", "~> 2.0"
+gem 'opbeat', git: 'https://github.com/opbeat/opbeat-ruby'
 ```
 
 The Opbeat gem adhere to [Semantic
 Versioning](http://guides.rubygems.org/patterns/#semantic-versioning)
-and so you can safely trust all minor and patch versions (e.g. 2.x.x) to
+and so you can safely trust all minor and patch versions (e.g. 3.x.x) to
 be backwards compatible.
 
 ## Usage
 
 ### Rails 3 and Rails 4
 
-Add a `config/initializers/opbeat.rb` containing:
+Add the following to your `config/environments/production.rb`:
 
 ```ruby
-require 'opbeat'
-
-Opbeat.configure do |config|
-  config.organization_id = '094e250818f44e82bfae13919f55fb35'
-  config.app_id = '094e250818'
-  config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
+Rails.application.configure do |config|
+  # ...
+  config.opbeat.organization_id = 'XXX'
+  config.opbeat.app_id = 'XXX'
+  config.opbeat.secret_token = 'XXX'
 end
 ```
 
-### Rails 2
-
-No support for Rails 2 yet.
-
 ### Rack
 
-Basic RackUp file.
-
 ```ruby
 require 'opbeat'
 
-use Opbeat::Rack
-
-Opbeat.configure do |config|
-  config.organization_id = '094e250818f44e82bfae13919f55fb35'
-  config.app_id = '094e250818'
-  config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
+# set up an Opbeat configuration
+config = Opbeat::Configuration.new do |conf|
+  conf.organization_id = 'XXX'
+  conf.app_id = 'XXX'
+  conf.secret_token = 'XXX'
 end
 
-```
+# start the Opbeat client
+Opbeat.start! config
 
-### Sinatra
+# install the Opbeat middleware
+use Opbeat::Middleware
 
-```ruby
-require 'sinatra'
-require 'opbeat'
-
-use Opbeat::Rack
-
-Opbeat.configure do |config|
-  config.organization_id = '094e250818f44e82bfae13919f55fb35'
-  config.app_id = '094e250818'
-  config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
-end
-
-get '/' do
-  1 / 0
-end
 ```
 
-### Other Ruby
-
-```ruby
-require 'opbeat'
+## Configuration
 
-Opbeat.configure do |config|
-  config.organization_id = '094e250818f44e82bfae13919f55fb35'
-  config.app_id = '094e250818'
-  config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
+Opbeat works with just the authentication configuration but of course there are other knobs to turn. For a complete list, see [configuration.rb](https://github.com/opbeat/opbeat-ruby/blob/master/lib/opbeat/configuration.rb).
 
-  # manually configure environment if ENV['RACK_ENV'] is not defined
-  config.current_environment = 'production'
-end
+#### Enable in development and other environments
 
-Opbeat.capture # Global style
+As a default Opbeat only runs in production. You can make it run in other environments by adding them to the `enabled_environments` whitelist.
 
-Opbeat.capture do # Block style
-  1 / 0
-end
+```ruby
+config.opbeat.enabled_environments += %w{development}
 ```
 
-## Background processing
-
-With [delayed_job](https://github.com/collectiveidea/delayed_job) and [sidekiq](http://sidekiq.org/), Opbeat will automatically pick up exceptions that are raised in background jobs. 
-
-To enable Opbeat for [resque](https://github.com/resque/resque), add the following (for example in `config/initializers/opbeat.rb`):
+#### Ignore specific exceptions
 
 ```ruby
-require "resque/failure/multiple"
-require "opbeat/integrations/resque"
-
-Resque::Failure::Multiple.classes = [Resque::Failure::Opbeat]
-Resque::Failure.backend = Resque::Failure::Multiple
+config.opbeat.excluded_exceptions += %w{
+  ActiveRecord::RecordNotFound
+  ActionController::RoutingError
+}
 ```
 
-## Explicitly notifying Opbeat
+### Sanitizing data
 
-It is possible to explicitely notify Opbeat. In the case of a simple message:
-```
-Opbeat.capture_message("Not happy with the way things turned out")
-```
+Opbeat can strip certain data points from the reports it sends like passwords or other sensitive information. If you're on Rails the list will automatically include what you have in `config.filter_parameters`.
 
-If you want to catch and explicitely send an exception to Opbeat, this is the way to do it:
-```
-begin
-  faultyCall
-rescue Exception => e
-  Opbeat.capture_exception(e)
-```
+Add or modify the list using the `filter_parameters` configuration:
 
-Both `Opbeat.capture_exception` and `Opbeat.capture_message` take additional `options`:
 ```ruby
-Opbeat.capture_message("Device registration error", :extra => {:device_id => my_device_id})
+config.opbeat.filter_parameters += [/regex(p)?/, "string", :symbol]
 ```
 
+### User information
 
-## Notifications in development mode
-
-By default events will be sent to Opbeat if your application is running in any of the following environments: `development`, `production`, `default`. Environment is set by default if you are running a Rack application (i.e. anytime `ENV['RACK_ENV']` is set).
-
-You can configure Opbeat to run only in production environments by configuring the `environments` whitelist:
+Opbeat can automatically add user information to errors. By default it looks for at method called `current_user` on the current controller. To change the method use `current_user_method`.
 
-```ruby
-require 'opbeat'
-
-Opbeat.configure do |config|
-  config.organization_id = '094e250818f44e82bfae13919f55fb35'
-  config.app_id = '094e250818'
-  config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
-
-  config.environments = %w[ production ]
-end
+```
+config.opbeat.current_user_method = :current_employee
 ```
 
-## Excluding Exceptions
+## Background processing
 
-If you never wish to be notified of certain exceptions, specify 'excluded_exceptions' in your config file.
+Opbeat automatically catches exceptions in [delayed_job](https://github.com/collectiveidea/delayed_job) or [sidekiq](http://sidekiq.org/).
 
-In the example below, the exceptions Rails uses to generate 404 responses will be suppressed.
+To enable Opbeat for [resque](https://github.com/resque/resque), add the following (for example in `config/initializers/opbeat_resque.rb`):
 
 ```ruby
-require 'opbeat'
-
-Opbeat.configure do |config|
-  config.organization_id = '094e250818f44e82bfae13919f55fb35'
-  config.app_id = '094e250818'
-  config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
+require "resque/failure/multiple"
+require "opbeat/integration/resque"
 
-  config.excluded_exceptions = ['ActionController::RoutingError', 'ActiveRecord::RecordNotFound']
-end
+Resque::Failure::Multiple.classes = [Resque::Failure::Opbeat]
+Resque::Failure.backend = Resque::Failure::Multiple
 ```
 
-## Sanitizing Data
+## Manual profiling
 
-The Opbeat agent will sanitize the data sent to the Opbeat server based
-on the following rules.
+It's easy to add performance tracking wherever you want using the `Opbeat` module.
 
-If you are running Rails, the agent will first try to fetch the
-filtering settings from `Rails.application.config.filter_parameters`.
+Basically you have to know about two concepts: `Transaction` and `Trace`.
 
-If those are not set (or if you are not running Rails), the agent will
-fall back to its own defaults:
+**Transactions** are a bundles of transactions. In a typical webapp every request is wrapped in a transaction. If you're instrumenting worker jobs, a single job run would be a transaction.
 
-```ruby
-/(authorization|password|passwd|secret)/i
-```
+**Traces** are spans of time that happen during a transaction. Like a call to the database, a render of a view or a HTTP request. Opbeat will automatically trace the libraries that it knows of and you can manually trace whatever else you'd like to.
 
-To specify your own (or to remove the defaults), simply set the
-`filter_parameters` configuration parameter:
+The basic api looks like this:
 
 ```ruby
-require 'opbeat'
-
-Opbeat.configure do |config|
-  config.organization_id = '094e250818f44e82bfae13919f55fb35'
-  config.app_id = '094e250818'
-  config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
-  
-  config.filter_parameters = [:credit_card, /^pass(word)$/i]
-end
+Opbeat.transaction "Transaction identifier" do
+  data = Opbeat.trace "Preparation" do
+    prepare_data
+  end
+  Opbeat.trace "Description", "kind" do
+    perform_expensive_task data
+  end
+end.done(200)
 ```
 
-Note that only the `data`, `query_string` and `cookies` fields under
-`http` are filtered.
-
-## User information
-
-With Rails, Opbeat expects `controller#current_user` to return an object with `id`, `email` and/or `username` attributes. You can change the name of the current user method in the following manner:
+Here, for example is how you could profile a Sidekiq worker job:
 
 ```ruby
-Opbeat.configure do |config|
-  ...
-  config.user_controller_method = "my_other_user_method"
+class MyWorker
+  include Sidekiq::Worker
+
+  def perform
+    Opbeat.transaction "MyWorker#perform", "worker.sidekiq" do
+      User.find_each do |user|
+        Opbeat.trace 'run!' do 
+          user.sync_with_payment_provider!
+        end
+      end
+    end.submit(true)
+    # `true` here is the result of the transaction
+    # eg 200, 404 and so on for web requests but
+    # anything that translates into JSON works
+
+    Opbeat.flush_transactions # send transactions right away
+  end
 end
 ```
 
-Opbeat will now call `controller#my_other_user_method` to retrieve the user object.
-
-## Setting context
-
-It is possible to set a context which be included an exceptions that are captured.
+If you are inside a web request, you are already inside a transaction so you only need to use trace:
 
 ```ruby
-Opbeat.set_context :extra => {:device_id => my_device_id}
+class UsersController < ApplicationController
 
-Opbeat.capture_message("Hello world")  # will include the context
-```
+  def extend_profiles
+    users = User.all
 
-## Timeouts
+    Opbeat.trace "prepare users" do
+      users.each { |user| user.extend_profile! }
+    end
 
-Opbeat uses a low default timeout. If you frequently experience timeouts, try increasing it in the following manner:
+    render text: 'ok'
+  end
 
-```ruby
-Opbeat.configure do |config|
-  ...
-  config.timeout = 5
-  config.open_timeout = 5
 end
 ```
 
-## Async Delivery
-
-When an error occurs, the notification is immediately sent to Opbeat.
-This will hold up the client HTTP request as long as the request to
-Opbeat is ongoing. Alternatively the agent can be configured to send
-notifications asynchronously.
-
-Example using a native Ruby `Thread`:
-
-```ruby
-Opbeat.configure do |config|
-  config.async = lambda { |event|
-    Thread.new { Opbeat.send(event) }
-  }
-end
-```
-
-Using this decoupled approach you can easily implement this into your
-existing background job infrastructure. The only requirement is that you
-at some point call the `Opbeat.send` method with the `event` object.
-
-## Testing
+## Testing and development
 
 ```bash
 $ bundle install
-$ rake spec
+$ rspec spec
 ```
 
+## Legacy
+
+Be aware that 3.0 is a almost complete rewrite of the Opbeat ruby client. It is not api compliant with version 2 and below.
+
 ## Resources
 
-* [Bug Tracker](http://github.com/opbeat/opbeat_ruby/issues)
-* [Code](http://github.com/opbeat/opbeat_ruby)
+* [Bug Tracker](http://github.com/opbeat/opbeat-ruby/issues)
+* [Code](http://github.com/opbeat/opbeat-ruby)