sidekiq-influxdb 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86db3cec30cc69e87ab0faed79f470aad55dc80bff4d9212e949cff105298bf9
-  data.tar.gz: b43207ea0256653a496c916864c15c47be36e387bc80ed2350ffa947f740886c
+  metadata.gz: 16e8eb281a6977df828e98ca93c15c554c7cbb3cee209f8e1f0c708f41eeae0f
+  data.tar.gz: 781c1656c3f3ff13965ca34160c30e0647bfaba79a0568f1072c8947e92b05ed
 SHA512:
-  metadata.gz: 24576df64619787d527e21077567d12d3d75e97639e75c9fa661aabbc2fd3daed52fae4d13f7eb8b1fb580f37e771429e662ffb2175adca2d225157ae30793fc
-  data.tar.gz: 0eb7dabd092930f40b5e359f84e18f951ead507a67310761517287cfca205ae2806a5008e64d0f327c454bdd6ea84429c977297da78c9cfca82c6609165f1a0e
+  metadata.gz: cb6e296fc06c64045795560a9c9c0f06a79f0f1a8df7992cff4212086e54115cc6131e3dc9490c17c95ad8dfe46230ac15f4197aad88302b372b1cb9d963c6b7
+  data.tar.gz: e33436ebba2864a2bb58d8411af97ba1e382682fd746d6da7b48b88d8c2ccc24b071a29b9de1365979300a68a3f07e0c27f8404860b7705c199a35de4e2ffceb

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Sidekiq-InfluxDB Changelog
 
+## 1.4.1 (2021-04-20)
+
+* Ruby 3 support
+
 ## 1.4.0 (2021-03-01)
 
 * Added queue sizes collection class

data/CONTRIBUTING.md

@@ -1,7 +1,13 @@
 # Sidekiq-InfluxDB
 
+## Reference documentation
+
+* [Sidekiq middleware](https://github.com/mperham/sidekiq/wiki/Middleware)
+* [InfluxDB client](https://github.com/influxdata/influxdb-ruby)
+
 ## Contributing Guidelines
 
+1. We welcome addition of useful Sidekiq metrics and optimisations of the existing ones.
 1. All code should be covered by tests. This library is used in high load Sidekiq deployments. Failures are unacceptable.
 1. Code should be easy for an average Rubyist to understand.
 1. Each pull request should contain changes for a single goal.

data/README.md

@@ -4,7 +4,9 @@
 [![Travis CI](https://img.shields.io/travis/com/funbox/sidekiq-influxdb)](https://travis-ci.com/github/funbox/sidekiq-influxdb)
 [![Coveralls](https://img.shields.io/coveralls/funbox/sidekiq-influxdb.svg)](https://coveralls.io/github/funbox/sidekiq-influxdb)
 
-[Sidekiq](https://github.com/mperham/sidekiq/wiki) middleware that writes job lifecycle events as points to an [InfluxDB](http://docs.influxdata.com/influxdb/v1.3/) database.
+[Sidekiq](https://github.com/mperham/sidekiq/wiki) server middleware
+that writes job lifecycle events as points to an [InfluxDB](http://docs.influxdata.com/influxdb/v1.3/) database.
+Also includes classes that write global Sidekiq metrics and queue metrics.
 
 ## Installation
 
@@ -16,7 +18,24 @@ bundle add sidekiq-influxdb
 
 ## Usage
 
-Add included middleware to your application's Sidekiq middleware stack:
+Add included middleware to your application's Sidekiq middleware stack.
+The following examples assume that you already have an InfluxDB client object
+in the `influxdb` variable.
+This will create a middleware with all defaults (suitable for most deployments):
+
+```ruby
+# config/initializers/sidekiq.rb
+
+require "sidekiq/middleware/server/influxdb"
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::Server::InfluxDB, influxdb_client: influxdb
+  end
+end
+```
+
+You can customize the middleware by passing more options:
 
 ```ruby
 # config/initializers/sidekiq.rb
@@ -26,17 +45,20 @@ require "sidekiq/middleware/server/influxdb"
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
     chain.add Sidekiq::Middleware::Server::InfluxDB,
-                influxdb_client: InfluxDB::Client.new(options), # REQUIRED
-                series_name: 'sidekiq_jobs',                    # optional, default shown
-                retention_policy: nil,                          # optional, default nil
-                start_events: true,                             # optional, default true
-                tags: { application: 'MyApp' },                 # optional, default {}
-                except: [UnimportantJob1, UnimportantJob2]      # optional, default []
+                influxdb_client: influxdb,
+                series_name: 'sidekiq_jobs',  # This is the default one.
+                retention_policy: 'rp_name',  # In case you want to write metrics to a non-default RP.
+                start_events: true,           # Whether or not you want to know when jobs started. See `event` tag description below.
+                tags: {application: 'MyApp'}, # Anything you need on top. **Make sure that tag values have low cardinality!**
+                except: [UnimportantJob]      # These job classes will be executed without sending any metrics.
   end
 end
 ```
 
-You can learn how to create a client in [InfluxDB client documentation](https://github.com/influxdata/influxdb-ruby#creating-a-client).
+This library assumes that you already have an InfluxDB client object set up the way you like.
+It does not try to create one for you.
+If that is not the case, you can learn how to create a client
+in [InfluxDB client documentation](https://github.com/influxdata/influxdb-ruby#creating-a-client).
 
 **Warning:** This middleware is going to write _a lot_ of metrics.
 Set up your InfluxDB client accordingly:
@@ -44,7 +66,7 @@ Set up your InfluxDB client accordingly:
 * or install Telegraf, set up aggregation inside it, and set up InfluxDB client to send metrics to it,
 * or both.
 
-When you deploy this code, you will start getting the following series in your InfluxDB database:
+When you deploy this code, you will have the following series in your InfluxDB database:
 
 ```
 > select * from sidekiq_jobs
@@ -95,15 +117,22 @@ Et cetera.
 
 ### Stats and Queues metrics
 
-To collect metrics for task stats and queues, you need to run the following code periodically. For example, you can use the gem `clockwork` for that. You can add settings like this to `clock.rb`:
+To collect metrics for task stats and queues, you need to run the following code periodically.
+For example, you can use [Clockwork](https://rubygems.org/gems/clockwork) for that.
+You can add settings like this to `clock.rb`:
 
 ```ruby
 require "sidekiq/metrics/stats"
 require "sidekiq/metrics/queues"
 
+influx = InfluxDB::Client.new(options)
+
+sidekiq_global_metrics = Sidekiq::Metrics::Stats.new(influxdb_client: influx)
+sidekiq_queues_metrics = Sidekiq::Metrics::Queues.new(influxdb_client: influx)
+
 every(1.minute, 'sidekiq_metrics') do
-  Sidekiq::Metrics::Stats.new(influxdb_client: InfluxDB::Client.new(options)).publish
-  Sidekiq::Metrics::Queues.new(influxdb_client: InfluxDB::Client.new(options)).publish
+  sidekiq_global_metrics.publish
+  sidekiq_queues_metrics.publish
 end
 ```
 
@@ -133,7 +162,7 @@ Sidekiq::Metrics::Queues.new(
 ).publish
 ```
 
-When you run the scripts, you will get the following series in your InfluxDB database:
+When you run the code, you will have the following series in your InfluxDB database:
 
 ```
 > select * from sidekiq_stats
@@ -159,24 +188,10 @@ time                queue             size
 
 ### Grafana
 
-You can import the ready-made dashboard from [grafana_dashboard.json](grafana_dashboard.json).
+You can import a ready-made dashboard from [grafana_dashboard.json](grafana_dashboard.json).
 
 ## Development
 
-* [Sidekiq middleware](https://github.com/mperham/sidekiq/wiki/Middleware)
-* [InfluxDB client](https://github.com/influxdata/influxdb-ruby)
-
-After checking out the repo, run `bin/setup` to install dependencies.
-You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at [github.com/funbox/sidekiq-influxdb](https://github.com/funbox/sidekiq-influxdb).
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## Code of Conduct
-
-Everyone interacting in the `Sidekiq::InfluxDB` project’s codebases, issue trackers,
-chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/funbox/sidekiq-influxdb/blob/master/CODE_OF_CONDUCT.md).
+See [Contributing Guidelines](CONTRIBUTING.md).
 
 [![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)

data/lib/sidekiq/influxdb/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module InfluxDB
-    VERSION = "1.4.0"
+    VERSION = "1.4.1"
   end
 end

data/lib/sidekiq/middleware/server/influxdb.rb

@@ -5,22 +5,14 @@ module Sidekiq
     module Server
       class InfluxDB
 
-        def initialize(
-          influxdb_client:,
-          series_name: 'sidekiq_jobs',
-          retention_policy: nil,
-          start_events: true,
-          tags: {},
-          except: [],
-          clock: -> { Time.now.to_f }
-        )
-          @influxdb = influxdb_client
-          @series = series_name
-          @retention = retention_policy
-          @start_events = start_events
-          @tags = tags
-          @secret_agents = class_names(except)
-          @clock = clock
+        def initialize(options = {})
+          @influxdb = options.fetch(:influxdb_client)
+          @series = options.fetch(:series_name, 'sidekiq_jobs')
+          @retention = options.fetch(:retention_policy, nil)
+          @start_events = options.fetch(:start_events, true)
+          @tags = options.fetch(:tags, {})
+          @secret_agents = class_names(options.fetch(:except, []))
+          @clock = options.fetch(:clock, -> { Time.now.to_f })
         end
 
         def call(_worker, msg, _queue)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-influxdb
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Ilya Vassilevsky
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb