Bugsnag

Bugsnag is a Bugsnag client for Crystal, providing error tracking for your Crystal apps.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
  bugsnag:
    github: jgaskins/bugsnag

  2. Run shards install

Usage

require "bugsnag"

Set your Bugsnag API key either through the BUGSNAG_API_KEY environment variable or by setting Bugsnag.api_key in your Crystal code:

$ shards build my_app

$ BUGSNAG_API_KEY=my_bugsnag_key bin/my_app
Bugsnag.api_key = "my_bugsnag_key"

HTTP handler

For an HTTP server, you can use Bugsnag::Middleware as an intermediate HTTP handler:

http = HTTP::Server.new([
  Bugsnag::Middleware.new
    .with_user { |context| Bugsnag::User.from_user(find_user_from(context)) }
    .with_app { Bugsnag::App.new(id: "my-app") }
    .with_metadata { |context| Bugsnag::Metadata { "session" => context.session.data } },
  MyApp.new,
])

One-off usage

struct Foo
  include JSON::Serializable

  getter bar : String
  getter baz : Int32
end

BUGSNAG_APP = Bugsnag::App.new(id: "my-app")

begin
  user = Queries::GetUserByID[user_id]
  # code that can raise an exception
rescue ex
  spawn Bugsnag.notify ex,
    # If your user model has an `id`, `email`, and `name` properties, you can use the
    # `.from_user` constructor. Otherwise, you need to build the `Bugsnag::User` with
    # the `.new(id, email, name)` constructor.
    user: Bugsnag::User.from_user(user),
    # The `app` here distinguishes your apps to the Bugsnag API
    app: BUGSNAG_APP,
    # Additional metadata is supplied with a `Bugsnag::Metadata` hash-like object
    metadata: Bugsnag::Metadata {
      # You can supply your own objects as metadata as long as they can be JSONified.
      # In this example, `foo` is a `Foo` object (defined in the struct above).
      "foo" => foo
    }

  raise ex
end

Contributing

  1. Fork it (https://github.com/jgaskins/bugsnag/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors