Skip to content
This repository

Exceptional helps you track errors in apps. This Repo contains the Ruby Gem. Exceptional also supports Django, iOS, Javascript, Node-JS, PHP. Each App needs an API key, this is given on signup at

branch: master
README.markdown

Exceptional http://exceptional.io

Exceptional helps you track errors in your Ruby apps

This Gem/Plugin posts exception data to Exceptional http://exceptional.io. Data about the request, session, environment and a backtrace of the exception is sent.

Rails 2.x Installation

  1. Install the Gem

    $ gem install exceptional
    
  2. Add config.gem entry to 'config/environment.rb'

    config.gem 'exceptional'
    
  3. Create your account and app at http://exceptional.io

  4. Configue your API Key

    $ exceptional install <api-key>
    

    using the api-key from the app settings screen within Exceptional

  5. Test with exceptional test

Rails 3 Installation

  1. Add gem entry to Gemfile

    gem 'exceptional'
    
  2. Run bundle install

  3. Create your account and app at http://exceptional.io

  4. Configue your API Key

    $ exceptional install <api-key>
    

    using the api-key from the app settings screen within Exceptional

  5. Test with exceptional test

Reporting exceptions in development

Exceptional will not report your exceptions in development environment by default.

To enable reporting of exceptions in development, please add the following lines to your exceptional.yml.

development:

  enabled: true

To write Exceptional information to the log or STDOUT instead of sending it to the remote API, add the following line to your exceptional.yml.

development:

  send_to: stdout

This allows you to monitor Exceptional processing in development mode. Valid values for send_to are api (the default), log and stdout.

You can provide custom printers for the log and stdout destinations. For example, if you like using AwesomePrint, you can use something like:

Exceptional::Config.stdout_printer = lambda do |exception_data|
  ap ["@@@ Exceptional error", exception_data]
end

Exceptional::Config.log_printer = lambda do |exception_data|
  Rails.logger.ap ["@@@ Exceptional error", exception_data], :error
end

Multiple Rails environments

To use Exceptional within multiple Rails environments, edit your config/exceptional.yml to look like the following

development:
  enabled: true
  api-key: your-dev-api-key

production:
  enabled: true
  api-key: you-prod-api-key

Development

Use rake spec to run the specs. We use Appraisals for integration tests, so install dependencies with rake appraisal:install. To run integration tests, use rake appraise.

To run all tests use rake.

Exceptional also supports your rack, rake, sinatra and plain ruby apps

For more information check out our docs site http://docs.exceptional.io Or visit our knowledge base http://support.exceptional.io/

Copyright © 2008 - 2012 Exceptional Cloud Services.

Something went wrong with that request. Please try again.