rollbar 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 307192963be4a3aefcd14f135c284089329768e8
-  data.tar.gz: 827eab30ef25e8da4c2ad4befcd48f6e9d142794
+  metadata.gz: 02b1f207b7667f4649a6c2805f73d8df71ba24ec
+  data.tar.gz: fe08097d60766f76e75baa4ebe133dc36d49fc3b
 SHA512:
-  metadata.gz: fa47e8350d65964e7077556ec9c5930ae429850ce83a8ca945dd57415429c8c800f7617d99b440e2596e01e7d0613b72f31b0d40f9a1341ffc75dec625ae9327
-  data.tar.gz: 313592eef5826b4f7bb9674848b28d30b2e366fd4ad580b5a1478fb18d118ff9f49a6ad5d54bb349adc80794460ae8ae239b2e856d4680f9cd17921625c47a06
+  metadata.gz: 028215d0b1b0bbafc92b75b078618833a5e2c263c50333834d3c32c934fae9e97e412e9272dd3a4aaaf9b862c128f9857633e7d26e6d76714e9e7f6c4f919da4
+  data.tar.gz: 44b5505e3ac14dcaabce4b5ec2db7226c392e2991f1ea6e30500fb66c5feffdc60c5d439a262259747f0e59ef68ed865002369c46220eb9bf5d55904bd472919

data/.gitignore

@@ -20,3 +20,7 @@ test/version_tmp
 tmp
 *.swp
 .idea/
+.ruby-version
+.byebug_history
+
+gemfiles/vendor

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "rollbar.js"]
+	path = rollbar.js
+	url = https://github.com/rollbar/rollbar.js.git

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'gemfiles/vendor/**/*'
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+  SupportedStyles:
+    - hash_rockets
+
+Metrics/LineLength:
+  Max: 1000
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false

data/.travis.yml

@@ -22,8 +22,7 @@ jdk:
   - oraclejdk7
   - oraclejdk8
 env:
-  - SKIP_DUMMY_ROLLBAR=true ROLLBAR_SSL_CERT_FILE=/home/travis/build/rollbar/rollbar-gem/spec/cacert.pem
-  - SKIP_DUMMY_ROLLBAR=false ROLLBAR_SSL_CERT_FILE=/home/travis/build/rollbar/rollbar-gem/spec/cacert.pem
+  - ROLLBAR_SSL_CERT_FILE=/home/travis/build/rollbar/rollbar-gem/spec/cacert.pem
 gemfile:
   - gemfiles/rails30.gemfile
   - gemfiles/rails31.gemfile
@@ -40,8 +39,6 @@ matrix:
     # Seems to work with oraclejdk7.
     - rvm: jruby-19mode
       jdk: openjdk7
-      env: SKIP_DUMMY_ROLLBAR=false
-
   exclude:
     # Don't run tests for non-jruby environments with the JDK.
     # NOTE: openjdk7 is missing from these exclusions so that Travis will run at least 1 build for the given rvm.

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Change Log
 
+## 2.8.0
+
+New features:
+
+- Add before_process and transform hooks. See [#375](https://github.com/rollbar/rollbar-gem/pull/375)
+- Rollbar.js instrumentation. See [#382](https://github.com/rollbar/rollbar-gem/pull/382)
+- Add `disable_rack_monkey_patch` configuration option. See [#377](https://github.com/rollbar/rollbar-gem/pull/377)
+- Add Rubocop config. See [#379](https://github.com/rollbar/rollbar-gem/pull/379)
+
+Bug fixes:
+
+- Notify deploy only on primary `:rollbar_role` server. See [#368](https://github.com/rollbar/rollbar-gem/pull/368)
+- Fix `Rollbar::Notifier#report_custom_data_error`. See [#376](https://github.com/rollbar/rollbar-gem/pull/376)
+- Reset the notifier when we use `Rollbar.preconfigure`. See [#378](https://github.com/rollbar/rollbar-gem/pull/378)
+- Fix sucker_punch tests. See [#372](https://github.com/rollbar/rollbar-gem/pull/372)
+
+Docs:
+
+- Add link from README to configuration. See [#383](https://github.com/rollbar/rollbar-gem/pull/383)
+- Add rough draft of configuration options documentation. See [#373](https://github.com/rollbar/rollbar-gem/pull/373)
+- Add plain ruby docs. See [#374](https://github.com/rollbar/rollbar-gem/pull/374)
+- Document exception level filters. See [#366](https://github.com/rollbar/rollbar-gem/pull/366)
+- Fix typo in README.md Sending backtrace without rescued exceptions. See [#364](https://github.com/rollbar/rollbar-gem/pull/364)
+
+
 ## 2.7.1
 
 - Suggest using ROLLBAR_ENV for staging apps. See [#353](https://github.com/rollbar/rollbar-gem/pull/353).

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.7.1)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.8.0)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 [Rollbar](https://rollbar.com) is an error tracking service for Ruby and other languages. The Rollbar service will alert you of problems with your code and help you understand them in a ways never possible before. We love it and we hope you will too.
@@ -12,7 +12,7 @@ This is the Ruby library for Rollbar. It will instrument many kinds of Ruby appl
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rollbar', '~> 2.7.1'
+gem 'rollbar', '~> 2.8.0'
 ```
 
 And then execute:
@@ -99,6 +99,57 @@ class MyApp < Sinatra::Base
 end
 ```
 
+### If using Plain Ruby
+
+Rollbar isn't dependent on Rack or Rails for most of its functionality. In a regular script, assuming you've
+installed the rollbar gem:
+
+ 1. Require rollbar
+ 2. Configure rollbar
+ 3. Send Rollbar data
+
+```ruby
+require 'rollbar'
+
+Rollbar.configure do |config|
+  config.access_token = "POST_SERVER_ITEM_ACCESS_TOKEN"
+  # Other Configuration Settings
+end
+
+Rollbar.debug("Running Script")
+
+begin
+  run_script ARGV
+rescue Exception => e # Never rescue Exception *unless* you re-raise in rescue body
+  Rollbar.error(e)
+  raise e
+end
+
+Rollbar.info("Script ran successfully")
+```
+
+
+## Integration with Rollbar.js
+
+In case you want to report your JavaScript errors using [Rollbar.js](https://github.com/rollbar/rollbar.js), you can configure the gem to enable Rollbar.js on your site. Example:
+
+```ruby
+Rollbar.configure do |config|
+  # common gem configuration
+  # ...
+  config.js_enabled = true
+  config.js_options = {
+    accessToken: "POST_CLIENT_ITEM_ACCESS_TOKEN",
+    captureUncaught: true,
+    payload: {
+      environment: "production"
+    }
+  }
+end
+```
+
+The `Hash` passed to `#js_options=` should have the same availalbe options that you can find in [Rollbar.js](https://github.com/rollbar/rollbar.js), using symbols or strings for the keys.
+
 ## Test your installation
 
 To confirm that it worked, run:
@@ -379,7 +430,14 @@ By default, all uncaught exceptions are reported at the "error" level, except fo
 - ```AbstractController::ActionNotFound```
 - ```ActionController::RoutingError```
 
-If you'd like to customize this list, see the example code in ```config/initializers/rollbar.rb```. Supported levels: "critical", "error", "warning", "info", "debug", "ignore". Set to "ignore" to cause the exception not to be reported at all.
+If you'd like to customize this list, modify the example code in ```config/initializers/rollbar.rb```. Supported levels: "critical", "error", "warning", "info", "debug", "ignore". Set to "ignore" to cause the exception not to be reported at all. For example, to ignore 404s and treat `NoMethodError`s as critical bugs, you can use the following code:
+
+```ruby
+config.exception_level_filters.merge!({
+  'ActiveRecord::RecordNotFound': 'ignore'
+  'NoMethodError': 'critical'
+})
+```
 
 This behavior applies to uncaught exceptions, not direct calls to `Rollbar.error()`, `Rollbar.warning()`, etc. If you are making a direct call to one of the log methods and want exception level filters to apply, pass an extra keyword argument:
 
@@ -387,6 +445,84 @@ This behavior applies to uncaught exceptions, not direct calls to `Rollbar.error
 Rollbar.error(exception, :use_exception_level_filters => true)
 ```
 
+## [Before process hook](#before-process-hook)
+
+Before we process data sent to Rollbar.log (or Rollbar.error/info/etc.) to build and send the payload, the gem will call the handlers defined in `configuration.before_process`. This handlers should be `Proc` objects or objects responding to `#call` method. The received argument is a `Hash` object with these keys:
+
+- `level`: the level used for the report.
+- `exception`: the exception that caused the report, if any.
+- `message`: the message to use for the report, if any.
+- `extra`: extra data passed to the report methods.
+- `scope`: the current Scope; see [Scope](#the-scope)
+
+If the exception `Rollbar::Ignore` is raised inside any of the handlers defined for `configuration.before_process`, we'll ignore the report and not send it to the API. For example:
+
+```ruby
+handler = proc do |options|
+  raise Rollbar::Ignore if any_smart_method(options)
+end
+
+Rollbar.configure do |config|
+  config.before_process << handler
+end
+```
+
+## [Transform hook](#transform-hook]
+
+After the payload is built but before it it sent to our API, the gem will call the handlers defined in `configuration.transform`. This handlers should be `Proc` objects or objects responding to `#call` method. The received argument is a `Hash` object with these keys:
+
+- `level`: the level used for the report.
+- `exception`: the exception that caused the report, if any.
+- `message`: the message to use for the report, if any.
+- `extra`: extra data passed to the report methods.
+- `scope`: the current Scope; see [Scope](#the-scope)
+- `payload`: the built payload that will be sent to the API
+
+Handlers may mutate the payload. For example:
+
+```ruby
+handler = proc do |options|
+  payload = options[:payload]
+
+  payload['data']['environment'] = 'foo'
+end
+
+Rollbar.configure do |config|
+  config.before_process << handler
+end
+```
+
+## [The Scope](#the-scope)
+
+The scope an object, an instance of `Rollbar::LazyStore` that stores the current context data for a certain moment or situation. For example, the Rails middleware defines the scope in a way similar to this:
+
+```ruby
+scope = {request: request_data,
+         person: person_data,
+         context: context_data
+}
+Rollbar.scoped(scope) do
+  begin
+    @app.call(env)
+  rescue Exception => exception
+    # ...
+  end
+end
+
+```
+
+You can access the scope on the [before_process](#before-process-hook) and [transform](#transform-hook) hooks like this:
+
+```ruby
+your_handler = proc do |options|
+  scope = options[:scope]
+
+  request_data = scope[:request]
+  person_data = scope[:person]
+  context_data = scope[:context]
+end
+```
+
 ## Silencing exceptions at runtime
 
 If you just want to disable exception reporting for a single block, use ```Rollbar.silenced```:
@@ -406,7 +542,7 @@ exception = MyException.new('this is a message')
 Rollbar.error(exception)
 ```
 
-You will notice a backtrace doesn't appear in your Rollbar dashboard. This is because `exception.backtrace` is `nil` in these cases. We can send the current backtrace for you even your exception doesn't have it. In order to enable this feature you should configure Rollbar in this way:
+You will notice a backtrace doesn't appear in your Rollbar dashboard. This is because `exception.backtrace` is `nil` in these cases. We can send the current backtrace for you even if your exception doesn't have it. In order to enable this feature you should configure Rollbar in this way:
 
 ```ruby
 Rollbar.configure do |config|
@@ -693,6 +829,12 @@ end
 
 Some users have reported problems with Zeus when ```rake``` was not explicitly included in their Gemfile. If the zeus server fails to start after installing the rollbar gem, try explicitly adding ```gem 'rake'``` to your ```Gemfile```. See [this thread](https://github.com/rollbar/rollbar-gem/issues/30) for more information.
 
+
+## Configuration options
+
+For a listing of all configuration options available see
+[configuration options](https://www.rollbar.com/docs/notifier/rollbar-gem/configuration).
+
 ## Backwards Compatibility
 
 You can find upgrading notes in [UPGRADING.md](UPGRADING.md).

data/Rakefile

@@ -11,9 +11,11 @@ desc 'Run specs'
 task :default do
   ENV['LOCAL'] = '1'
   Rake::Task[:spec].invoke
-  
+
   Rake::Task[:spec].reenable
-  
+
   ENV['LOCAL'] = '0'
   Rake::Task[:spec].invoke
-end
+end
+
+Dir.glob('lib/tasks/*.rake').each { |r| load r }

data/data/rollbar.snippet.js

@@ -0,0 +1 @@
+!function(r){function o(e){if(t[e])return t[e].exports;var n=t[e]={exports:{},id:e,loaded:!1};return r[e].call(n.exports,n,n.exports,o),n.loaded=!0,n.exports}var t={};return o.m=r,o.c=t,o.p="",o(0)}([function(r,o,t){"use strict";var e=t(1).Rollbar,n=t(2);_rollbarConfig.rollbarJsUrl=_rollbarConfig.rollbarJsUrl||"https://d37gvrvc0wt4s1.cloudfront.net/js/v1.8/rollbar.min.js";var a=e.init(window,_rollbarConfig),i=n(a,_rollbarConfig);a.loadFull(window,document,!_rollbarConfig.async,_rollbarConfig,i)},function(r,o){"use strict";function t(r){return function(){try{return r.apply(this,arguments)}catch(o){try{console.error("[Rollbar]: Internal error",o)}catch(t){}}}}function e(r,o,t){window._rollbarWrappedError&&(t[4]||(t[4]=window._rollbarWrappedError),t[5]||(t[5]=window._rollbarWrappedError._rollbarContext),window._rollbarWrappedError=null),r.uncaughtError.apply(r,t),o&&o.apply(window,t)}function n(r){var o=function(){var o=Array.prototype.slice.call(arguments,0);e(r,r._rollbarOldOnError,o)};return o.belongsToShim=!0,o}function a(r){this.shimId=++s,this.notifier=null,this.parentShim=r,this._rollbarOldOnError=null}function i(r){var o=a;return t(function(){if(this.notifier)return this.notifier[r].apply(this.notifier,arguments);var t=this,e="scope"===r;e&&(t=new o(this));var n=Array.prototype.slice.call(arguments,0),a={shim:t,method:r,args:n,ts:new Date};return window._rollbarShimQueue.push(a),e?t:void 0})}function l(r,o){if(o.hasOwnProperty&&o.hasOwnProperty("addEventListener")){var t=o.addEventListener;o.addEventListener=function(o,e,n){t.call(this,o,r.wrap(e),n)};var e=o.removeEventListener;o.removeEventListener=function(r,o,t){e.call(this,r,o&&o._wrapped?o._wrapped:o,t)}}}var s=0;a.init=function(r,o){var e=o.globalAlias||"Rollbar";if("object"==typeof r[e])return r[e];r._rollbarShimQueue=[],r._rollbarWrappedError=null,o=o||{};var i=new a;return t(function(){if(i.configure(o),o.captureUncaught){i._rollbarOldOnError=r.onerror,r.onerror=n(i);var t,a,s="EventTarget,Window,Node,ApplicationCache,AudioTrackList,ChannelMergerNode,CryptoOperation,EventSource,FileReader,HTMLUnknownElement,IDBDatabase,IDBRequest,IDBTransaction,KeyOperation,MediaController,MessagePort,ModalWindow,Notification,SVGElementInstance,Screen,TextTrack,TextTrackCue,TextTrackList,WebSocket,WebSocketWorker,Worker,XMLHttpRequest,XMLHttpRequestEventTarget,XMLHttpRequestUpload".split(",");for(t=0;t<s.length;++t)a=s[t],r[a]&&r[a].prototype&&l(i,r[a].prototype)}return r[e]=i,i})()},a.prototype.loadFull=function(r,o,e,n,a){var i=function(){var o;if(void 0===r._rollbarPayloadQueue){var t,e,n,i;for(o=new Error("rollbar.js did not load");t=r._rollbarShimQueue.shift();)for(n=t.args,i=0;i<n.length;++i)if(e=n[i],"function"==typeof e){e(o);break}}"function"==typeof a&&a(o)},l=!1,s=o.createElement("script"),u=o.getElementsByTagName("script")[0],p=u.parentNode;s.crossOrigin="",s.src=n.rollbarJsUrl,s.async=!e,s.onload=s.onreadystatechange=t(function(){if(!(l||this.readyState&&"loaded"!==this.readyState&&"complete"!==this.readyState)){s.onload=s.onreadystatechange=null;try{p.removeChild(s)}catch(r){}l=!0,i()}}),p.insertBefore(s,u)},a.prototype.wrap=function(r,o){try{var t;if(t="function"==typeof o?o:function(){return o||{}},"function"!=typeof r)return r;if(r._isWrap)return r;if(!r._wrapped){r._wrapped=function(){try{return r.apply(this,arguments)}catch(o){throw o._rollbarContext=t()||{},o._rollbarContext._wrappedSource=r.toString(),window._rollbarWrappedError=o,o}},r._wrapped._isWrap=!0;for(var e in r)r.hasOwnProperty(e)&&(r._wrapped[e]=r[e])}return r._wrapped}catch(n){return r}};for(var u="log,debug,info,warn,warning,error,critical,global,configure,scope,uncaughtError".split(","),p=0;p<u.length;++p)a.prototype[u[p]]=i(u[p]);r.exports={Rollbar:a,_rollbarWindowOnError:e}},function(r,o){"use strict";r.exports=function(r,o){return function(t){if(!t&&!window._rollbarInitialized){var e=window.RollbarNotifier,n=o||{},a=n.globalAlias||"Rollbar",i=window.Rollbar.init(n,r);i._processShimQueue(window._rollbarShimQueue||[]),window[a]=i,window._rollbarInitialized=!0,e.processPayloads()}}}}]);

data/docs/configuration_options.md

@@ -0,0 +1,281 @@
+# Configuration Reference
+
+<!-- Sub:[TOC] -->
+
+## General Settings
+
+### access_token
+
+**Required**
+
+Sets the access token used to send payloads to rollbar.
+
+Items sent through a given access token arrive in that access token's project
+and respect the rate limits set on that access token.
+
+### async_handler
+
+If `config.use_async = true` explicitly sets the function used to send
+asynchronous payloads to Rollbar. Should be an object that responds to `#call``
+Not needed if using one of the built in async reporters:
+
+ * girl_friday
+ * sucker_punch
+ * Sidekiq
+ * Resque
+ * threading
+
+### branch
+
+Name of the checked-out source control branch.
+
+### code_version
+
+A string, up to 40 characters, describing the version of the application code.
+
+Rollbar understands these formats:
+
+ * semantic version (i.e. "2.1.12")
+ * integer (i.e. "45")
+ * git SHA (i.e. "3da541559918a808c2402bba5012f6c60b27661c")
+
+### custom_data_method
+
+The method to call to gather custom data to send with each rollbar request.
+
+```ruby
+def custom_data
+  return {
+    :custom => {
+      :key1 => get_key_one,
+      :key2 => get_key_two
+    },
+    :server => {
+      :root => '/home/username/www/'
+    }
+  }
+end
+```
+
+### default_logger
+
+**Default** `Logger.new(STDERR)`
+
+What logger to use for printing debugging and informational messages during
+operation.
+
+### disable_monkey_patch
+
+**Default** `false`
+
+Disables monkey patching all non-core monkey patches and automatic reporting.
+
+If you set this to true you will be responsible for rescuing and reporting all
+errors manually.
+
+### disable_core_monkey_patch
+
+**Default** `false`
+
+Disables our monkey patches in the ruby core. One mandatory monkey patch is left.
+Be careful using this option as it may caused unexpected behavior in some situations.
+
+
+### disable_rack_monkey_patch
+
+**Default** `false`
+
+Disables monkey patches on Rack classes, `Rack::Builder` for now, maybe more
+at some point.
+
+### delayed_job_enabled
+
+**Default** `true`
+
+
+Set to false if you have `delayed_job`  but do not wish to wrap jobs with a
+Rollbar notifier.
+
+### dj_threshold
+
+**Default** 0 (Report *any* errors)
+
+The number of job failures before reporting the failure to Rollbar.
+
+### failover_handlers
+
+An array of backup handlers if the async handlers fails. Each should respond to
+`#call` and should receive a `payload`.
+
+### filepath
+
+For use with `write_to_file`. Indicates location of the rollbar log file being
+tracked by [rollbar-agent](https://github.com/rollbar/rollbar-agent).
+
+### framework
+
+**Default** 'Plain'
+
+Indicates which framework you're using. Common options include 'Rails',
+'Sinatra', and 'Rack' to name a few.
+
+### ignored_person_ids
+
+**Default** `[]`
+
+Ids of people whose reports you wish to ignore. Only works in conjunction with a
+properly defined `person_method` or `person_id_method`.
+
+### logger
+
+The logger to use *instead of* the default logger. Especially useful when you
+wish to send log messages elsewhere.
+
+### payload_options
+
+Extra data to send with the payload.
+
+### person_method
+
+Rails only: A string or symbol giving the name of the method on the controller.
+Should return an object with an `id` method, and optionally `username` and
+`email` methods. The names of the `id`, `username` and `email` methods can be
+overridden. See `person_id_method`, `person_username_method`, and
+`person_email_method`.
+
+If not using Rails:
+
+Populate the `rollbar.person_data` key with a hash containing `:id`, and
+optionally `:username` and `:email`.
+
+### person_id_method
+
+A string or symbol giving the name of the method on the user instance that
+returns the person's id. Gets called on the result of `person_method`. Ignored
+if `person_method` not present.
+
+### person_username_method
+
+A string or symbol giving the name of the method on the user instance that
+returns the person's username. Gets called on the result of `person_method`.
+Ignored if `person_method` not present.
+
+### person_email_method
+
+A string or symbol giving the name of the method on the user instance that
+returns the person's email. Gets called on the result of `person_method`.
+Ignored if `person_method` not present.
+
+### populate_empty_backtraces
+
+Raising an exception in Ruby is what populates the backtraces. If you report a
+manually initialized exception instead of a raised and rescued exception, the
+backtraces will be empty. Set `populate_empty_backtraces` to `true` to have
+Rollbar load the traces before sending them.
+
+### report_dj_data
+
+**Default** `true`
+
+Set to `false` to skip automatic bundling of job metadata like queue, job class
+name, and job options.
+
+### request_timeout
+
+**Default** `3`
+
+Set the request timeout for sending POST data to Rollbar.
+
+### root
+
+Set the server root, all stack frames outside that root are considered
+'non-project' frames. Also used to setup Github linking.
+
+### safely
+
+**Default** `false`
+
+When `true` evaluates `custom_data_method` returns `{}` if an error,
+otherwise reports the error to Rollbar.
+
+### scrub_fields
+
+Fields to scrub out of the parsed request data. Will scrub from `GET`, `POST`,
+url, and several other locations. Does not currently recurse into the full
+payload.
+
+### scrub_user
+
+**Default** `true`
+
+Set to false to skip scrubbing user out of the URL.
+
+### scrub_password
+
+Set to false to skip scrubbing password out of the URL.
+
+### user_ip_obfuscator_secret
+
+A string used hash IP addresses when obfuscating them.
+
+### randomize_scrub_length
+
+**Default** `true`
+
+When true randomizes the number of asterisks used to display scrubbed fields.
+
+### uncaught_exception_level
+
+**Default** `error`
+
+Use this field to select a different level for uncaught errors (like `critical`,
+or `warning`).
+
+### scrub_headers
+
+**Default** `["Authentication"]`
+
+The headers to scrub.
+
+### sidekiq_threshold
+
+**Default** `0`
+
+The number of job re-tries before reporting an error to Rollbar via Sidekiq.
+Ignored unless you've called `use_sidekiq`.
+
+### verify_ssl_peer
+
+**Default** `true`
+
+By default we use `OpenSSL::SSL::VERIFY_PEER` for SSL. Although we don't
+recommend changing it, you can disable peer verification in case you experience
+SSL connection problems.
+
+### use_async
+
+**Default** `false`
+
+When `true` indicates you wish to send data to Rollbar asynchronously. If
+installed, uses `girl_friday`, otherwise defaults to `Thread`.
+
+### use_eventmachine
+
+**Default** `false`
+
+When `true` indicates you wish to send data to Rollbar with `eventmachine`.
+Won't work unless `eventmachine` is installed.
+
+### web_base
+
+**Default** `'https://rollbar.com'`
+
+The root of the web app that serves your rollbar data. Unless you're an
+enterprise customer this should never change.
+
+### write_to_file
+
+**Default** `false`
+
+If `true` writes all errors to a log file which can be sent with
+`rollbar-agent`.