Exception Notification - Lark Notifier

The Exception Notification gem provides a set of notifiers for sending notifications when errors occur in a Rack/Rails application. This gem adds support for delivering notifications to Lark.

Installation

Add this line to your application's Gemfile:

gem 'exception_notification'
gem 'exception_notification-lark-notifier'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install exception_notification-lark-notifier

Usage

In order to receive exceptions in Lark, you need to add a custom bot to the group chat.

To configure it, you need to set the webhook address, like this:

Rails.application.config.middleware.use ExceptionNotification::Rack,
  lark: {
    webhook_url: 'https://open.larksuite.com/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx',
    webhook_secret: '123456',
    http: {
      timeout_class: HTTP::Timeout::Global,
      timeout_options: {global_timeout: 5}
    }
  }

Options

webhook_url

String, required

The Incoming WebHook URL on Lark.

webhook_secret

String, optional

The secret key for Signature validation.

app_name

String, optional

Your application name, shown in the notification.

env_name

String, optional

Your env name, shown in the notification.

http

Hash, optional

Configure the HTTP client.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/rspec 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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/souk4711/exception_notification-lark-notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 exception_notification-lark-notifier project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.