This connector allows you to easily send messages to the Coalmine API.

Coalmine is a cloud-based exception and error tracking service for your web apps.

You can always find the latest source code on GitHub.

Rails 3.x:

gem "coalmine"

In a Rails app create an initializer and configure as such:

Coalmine.configure do |config|
  config.signature = "my_secret_signature"
  config.logger = Rails.logger
end

All uncaught exceptions are automatically logged. To manually log an exception to coalmine from a controller:

begin
  call_dangerous_method
rescue Exception => e
  notify_coalmine(e)
end

To notify Coalmine of a deployment

rake coalmine:deployment[your_version,username]

# For example
rake coalmine:deployment[1.0.0,brad]

Or, with Capistrano add this to your deploy.rb:

require "coalmine/capistrano"

This will automatically send a deployment notification to Coalmine when you run cap deploy

Coalmine will automatically string-replace values that you deem to be sensitive and do not want to be sent out. Coalmine automatically honors Rails.application.config.filter_parameters. If you wish to include additional filter properties, you can via the config:

Coalmine.configure do |config|
  config.filters += ["credit-card"]
end

The above would replace all properties named credit-card with the value [FILTERED].

You can include extra information by defining custom variables. These are automatically appended to the notification sent to Coalmine and appear in the 'Application' tab. Custom variables are added like so:

Coalmine.custom_variables[:username] = current_user.username

You will most likely initialize all your custom application variables at the beginning of the request. If you are using Rails, it might look something like:

class ApplicationController < ApplicationController::Base
  before_filter :set_custom_variables
  
protected
  
  def set_custom_variables
    Coalmine.custom_variables[:user_name] = current_user.username
    Coalmine.custom_variables[:something] = "another custom value"
  end
end

• Resque (Fatsoma/resque_coalmine_gem)