https://github.com/jgaskins/bugsnag

https://github.com/jgaskins/bugsnag

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/jgaskins/bugsnag
• Owner: jgaskins
• License: mit
• Created: 2020-08-19T21:28:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-20T07:47:28.000Z (about 1 year ago)
• Last Synced: 2024-12-09T10:55:40.119Z (25 days ago)
• Language: Crystal
• Homepage:
• Size: 11.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bugsnag

`Bugsnag` is a [Bugsnag](https://bugsnag.com) client for Crystal, providing error tracking for your Crystal apps.

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml

   dependencies:

     bugsnag:

       github: jgaskins/bugsnag

   ```

2. Run `shards install`

## Usage

```crystal

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

```

```crystal

Bugsnag.api_key = "my_bugsnag_key"

```

### HTTP handler

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

```crystal

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

```crystal

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 ()

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

- [Jamie Gaskins](https://github.com/jgaskins) - creator and maintainer