asana_exception_notifier

Simple ruby implementation to send notifications to Asana when a exception happens in Rails or Rack-based apps by creating a task and uploading exception details to the task

The gem provides a notifier for sending notifications to Asana when errors occur in a Rack/Rails application courtesy of exception_notification gem. Check out that gem for more details on setting up the rack middleware with additional options.

Starting with version 0.3.1, this gem no longer uses eventmachine and em-http-request gems. Instead they are replaced with Asana gem and Typhoeus.

• Ruby 2.0 or greater
• Rails 4.0 or greater, Sinatra or another Rack-based application.

1. ActiveSuport > 4.0
2. asana >= 0.5.0
3. typhoeus >= 1.0.2
4. exception_notification >= 4.1.4
5. tilt >= 1.4
6. rack >= 1.6
7. rubyzip >= 1.0.0
8. zip-zip >= 0.3
9. sys-uname >= 1.0.2

Add the following to your Gemfile :

  gem "asana_exception_notifier"

If you are settting up for the first time this gem, just run the following command from the terminal:

rails g asana_exception_notifier:install

This command generates an initialize file (config/initializers/asana_exception_notifier.rb) where you can customize your configurations. ( Please see section 2.2) Options for the Rack middleware) for more information on available options )

Make sure the gem is not listed solely under the production group, since this initializer will be loaded regardless of environment.

AsanaExceptionNotifier is used as a rack middleware, or in the environment you want it to run. In most cases you would want AsanaExceptionNotifier to run on production. Thus, you can make it work by putting the following lines in your config/environments/production.rb:

Rails.application.config.middleware.use ExceptionNotification::Rack

In order to use ExceptionNotification with Sinatra, please take a look in the example application.

If you want to send notifications from a background process like DelayedJob, you should use the notify_exception method like this:

begin
  some code...
rescue => exception
  ExceptionNotifier.notify_exception(exception, notifiers: :asana)
end

You can include information about the background process that created the error by including a data parameter:

begin
  some code...
rescue => exception
  ExceptionNotifier.notify_exception(exception,
    :data => {:worker => worker.to_s, :queue => queue, :payload => payload}, notifiers: :asana)
end

If your controller action manually handles an error, the notifier will never be run. To manually notify of an error you can do something like the following:

rescue_from Exception, :with => :server_error

def server_error(exception)
  # Whatever code that handles the exception

  ExceptionNotifier.notify_exception(exception,
    :env => request.env, :data => {:message => "was doing something wrong"}, notifiers: :asana)
end

String, required

Your Personal Access Token from Asana. You can get it from here. Please make sure you keep the token secret, and don't commit it in your repository. I suggest to put it into an environment variable and use it from that variable.

Integer, required

The workspace ID where the task will be created.

If you don't supply the workspace or the asana_api_key flags , the notifier will not run!!!

String, optional

Who will be assigned by default to the task that is going to be created. (Default: 'me'). Can be disabled by setting it to NIL value

String, optional

Scheduling status of this task for the user it is assigned to. This field can only be set if the assignee is non-null. (Default: 'today'). Can be disabled by setting it to NIL value.

Time, optional

Date and time on which this task is due, or null if the task has no due time. This takes a UTC timestamp and should not be used together with due_on. Default ( Time.now.iso8601)

Time, optional

Date on which this task is due, or null if the task has no due date. This takes a date with YYYY-MM-DD format and should not be used together with due_at

Boolean, optional

True if the task is hearted by the authorized user, false if not (Default: false).

Array, optional

Array of users who will heart the task after creation. (Default: []).

Array, optional

Array of projects this task is associated with. At task creation time, this array can be used to add the task to many projects at once.(Default: []).

Array, optional

Array of users following this task. (Default: []).

Array, optional

Array of projects this task is associated with and the section it is in. At task creation time, this array can be used to add the task to specific sections.Note that over time, more types of memberships may be added to this property.(Default: []).

Array, optional

Array of tags associated with this task. This property may be specified on creation using just an array of existing tag IDs. (Default: []).

String, optional

Name of the task. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer. (Default: "[AsanaExceptionNotifier] %Exception Class Name%").

String, optional

More detailed, free-form textual information associated with the task. (Default: '')

Array, optional

This can be used to override the default template when rendering the exception details with customized template.

Array, optional

This can be used to specify options as strings that will be filtered from session and from request parameters ( The options will not be displayed in the HTML template)

To test, do the following:

1. cd to the gem root.
2. bundle install
3. bundle exec rake

Please log all feedback/issues via Github Issues. Thanks.

• Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
• Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
• Fork the project.
• Start a feature/bugfix branch.
• Commit and push until you are happy with your contribution.
• Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
• You can read more details about contributing in the Contributing document

== Copyright

Copyright (c) 2016 bogdanRada. See LICENSE.txt for further details.