AppsignalHelper

Small helper that allows you to fetch parameters from an appsignal error

Installation

Add this line to your application's Gemfile:

gem 'appsignal_helper'

And then execute:

$ bundle

Or install it yourself as:

$ gem install appsignal_helper

Setup

You will need the following env vars:

  export APPSIGNAL_URL=https://appsignal.com
  export APPSIGNAL_API_TOKEN=…
  export APP_ID=…

You can then start a console to play with the API:

    bin/console

Usage

How to retrieve parameters from an appsignal exception ?

open a terminal with $ irb

then

require 'appsignal_helper'

p AppsignalHelper::ApiHelper.new(
  exception: 'ActionController::ActionControllerError',
  limit: 10,
  action: 'MyController-hash-create',
  since: 1537374524,
).retrieve_parameters.uniq

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/williampollet/appsignal_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the AppsignalHelper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.