https://github.com/locaweb/heartcheck-sidekiq

A plugin to check sidekiq connection with heartcheck
https://github.com/locaweb/heartcheck-sidekiq

hacktoberfest ruby

Last synced: about 2 months ago
JSON representation

A plugin to check sidekiq connection with heartcheck

• Host: GitHub
• URL: https://github.com/locaweb/heartcheck-sidekiq
• Owner: locaweb
• License: mit
• Created: 2015-02-27T23:07:41.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2021-10-04T17:55:46.000Z (over 3 years ago)
• Last Synced: 2024-04-16T18:21:21.926Z (9 months ago)
• Topics: hacktoberfest, ruby
• Language: Ruby
• Homepage:
• Size: 36.1 KB
• Stars: 3
• Watchers: 17
• Forks: 7
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Heartcheck::Sidekiq

[![Build Status](https://travis-ci.org/locaweb/heartcheck-sidekiq.svg)](https://travis-ci.org/locaweb/heartcheck-sidekiq)

[![Code Climate](https://codeclimate.com/github/locaweb/heartcheck-sidekiq/badges/gpa.svg)](https://codeclimate.com/github/locaweb/heartcheck-sidekiq)

[![Ebert](https://ebertapp.io/github/locaweb/heartcheck-sidekiq.svg)](https://ebertapp.io/github/locaweb/heartcheck-sidekiq)

##A plugin to check sidekiq connection with [heartcheck](https://github.com/locaweb/heartcheck).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'heartcheck-sidekiq'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install heartcheck-sidekiq

## Usage

You can check any sidekiq connection that there's in your app.

```ruby

Heartcheck.setup do |config|

  config.add :sidekiq do |c|

    c.name = 'redis'

  end

end

```

### Check Heartcheck example [here](https://github.com/locaweb/heartcheck/blob/master/lib/heartcheck/generators/templates/config.rb)

## License

* [MIT License](https://github.com/locaweb/heartcheck-sidekiq/blob/master/LICENSE.txt)

## Contributing

1. Fork it ( https://github.com/locaweb/heartcheck-sidekiq/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

In order to make it easier for your development, we added a docker dev environment

so that you don't need to install ruby and it's dependencies via rbenv or rvm.

Just do your setup locally by running:

```

./scripts/heartcheck setup

```

Run `./scripts/heartcheck -h` to see options available