Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ninech/sidekiq-opentsdb
Sidekiq middleware that sends Sidekiq statistics to OpenTSDB.
https://github.com/ninech/sidekiq-opentsdb
Last synced: about 1 month ago
JSON representation
Sidekiq middleware that sends Sidekiq statistics to OpenTSDB.
- Host: GitHub
- URL: https://github.com/ninech/sidekiq-opentsdb
- Owner: ninech
- License: mit
- Created: 2016-05-23T13:14:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-13T08:13:26.000Z (about 7 years ago)
- Last Synced: 2024-04-29T20:53:14.382Z (8 months ago)
- Language: Ruby
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Sidekiq::Opentsdb
[](https://travis-ci.org/ninech/sidekiq-opentsdb)
Sidekiq middleware that sends useful Sidekiq statistics to OpenTSDB.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'sidekiq-opentsdb'
```
And then execute:
$ bundle
## Usage
You need to add the middleware to your call stack. To do so, put the folllowing code in an initializer (ideally `sidekiq.rb`):
```ruby
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
middleware_options = {
opentsdb_hostname: 'localhost',
opentsdb_port: '4242',
metric_prefix: 'nine',
only: %w(retry_size dead_size)
}
chain.add Sidekiq::Opentsdb::ServerMiddleware, middleware_options
end
end
```
### Available Options
```ruby
opentsdb_hostname: 'localhost' # (required) Hostname of your opentsdb server.
opentsdb_port: '4242' # (required) Port of your opentsdb server.
metric_prefix: 'nine' # (optional) Prefix of the metric keys (default: '').
only: %w(retry_size dead_size) # (optional) Only send the given metrics to OpenTSDB.
except: %w(retry_size dead_size) # (optional) Send all but the given metrics to OpenTSDB.
# Tags
app: 'MyApp' # (optional) Your app name (Rails app name if available)
environment: 'staging' # (optional) Your app environment (default: ENV['RACK_ENV'])
```
## About
This gem is currently maintained and funded by [nine](https://nine.ch).
[](https://www.nine.ch)