rpocklin / sidekiq-redislog

Sidekiq redis log monitor

Sidekiq::RedisLog

Displays a monitor window which echos the telnet status log of redis for sidekiq. Autoscrolls.

Installation

NOTE: Doesn't work with Webrick because it uses SSE (server-sent events) and Webrick is single-threaded. Works with Phusion Passenger / Thin / Puma / Rainbows and probably Unicorn.

Add this line to your application's Gemfile:

gem 'sidekiq-redislog'

1. Start up your rails stack
2. Navigate to '/sidekiq' (or your custom remapped route)
3. Click 'redis' tab
4. You will see activity (at the very least 'OK' should appear in the text area.)

Dependencies

Depends on Sidekiq >= 2.2.1

Usage and Modes

• When you run your app you will now see an additional tab 'Redis' in the sidekiq web console.
• You can create activity by opening the other Sidekiq tabs (Dashboard/Workers/etc) in new browser tabs.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

License

Released under the MIT License. See the LICENSE file for further details.

TODO

• Connect/Disconnect buttons since it consumes a thread for the poller.

Notes

If you mount sidekiq to a non-standard route ie. mount Sidekiq::Web => '/admin/sidekiq' it will automatically handle remapping of the stream URI.

sidekiq-redislog's Issues

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.