Redmine Airbrake Backend
This plugin provides the necessary API to use Redmine as an Airbrake backend.
Installation
Add this line to the Gemfile or Gemfile.local of your Redmine installation:
gem 'redmine_airbrake_backend'
And then execute:
$ bundle install
$ rake redmine:plugins:migrate
Alternate installation method
Please see http://www.redmine.org/projects/redmine/wiki/Plugins for installation instructions.
Integration
- Enable REST web service authentication
- Create the following custom fields for issues:
- Airbrake hash (String) (required)
- Number of occurrences (Integer) (optional)
- Configure the plugin to use these 2 custom fields (Administration -> Plugins -> Airbrake -> Configure)
- Check if the custom fields are assigned to the trackers you want to use with airbrake
- Enable the project module (Airbrake) in your project settings (don't forget to add at least the Airbrake notice ID custom field to your project if it is not a global field)
- Configure additional defaults under the settings tab per project (Airbrake)
- Check if the user used for airbrake has a role with the Airbrake permission
Client configuration
For a Rails application add the airbrake gem to your Gemfile:
gem 'airbrake'
And configure it, e.g. with an initializer config/initializers/airbrake.rb
:
Airbrake.configure do |c|
c.project_id = 'redmine_project_identifier'
c.project_key = {
key: 'redmine_api_key', # the api key for a user which has permission to create issues in the project specified in the previous step
tracker: 'Bug', # the name or id of your desired tracker (optional if default is configured)
category: 'Development', # the name or id of a ticket category, optional
priority: 5, # the name or id of the priority for new tickets, optional.
assignee: 'admin' # the login or id of a user the ticket should get assigned to by default, optional
}.to_json
c.host = 'https://redmine.example.com/'
c.root_directory = Rails.root
c.environment = 'production'
c.performance_stats = false # Performance stats are not supported
end
Notes
Based on https://github.com/milgner/redmine_airbrake_server
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request