sidekiq-influxdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d76699cb80bb321047c37c5549fe38a5b4d22e2e
+  data.tar.gz: 11b159df26e9104c1c8f994c215acc64c594f7b8
+SHA512:
+  metadata.gz: 51bd0670bd6325e9ef2219c0506da5e21e4c2a0d9580c344ad3c74170cd531729985db274889e56aed1cb0de4f5e49a47ca133be59e0470981448a8b1cf21ada
+  data.tar.gz: 112651d4277dc77a77f5cff8523fca3ab66c9bdcf3987252ec4eb0bf49daaeaab3c87a850cad8a3e57755ae0758f0f4f660ed11036c66ad2f0ab81910c45fe50

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vassilevsky@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-influxdb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-influxdb (0.1.0)
+      influxdb (~> 0.0)
+      sidekiq (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
+    influxdb (0.5.1)
+    rack (2.0.3)
+    rack-protection (2.0.0)
+      rack
+    rake (10.5.0)
+    redis (4.0.1)
+    sidekiq (5.0.5)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.4, < 5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  sidekiq-influxdb!
+
+BUNDLED WITH
+   1.16.0

data/Makefile

@@ -0,0 +1,2 @@
+jobs:
+	bundle exec sidekiq --concurrency 1 --require ./test/jobs.rb --verbose

data/README.md

@@ -0,0 +1,96 @@
+# 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.
+
+## Installation
+
+Add this gem to your application's `Gemfile`:
+
+    bundle add sidekiq-influxdb
+
+## Usage
+
+Sidekiq middleware description:
+
+https://github.com/mperham/sidekiq/wiki/Middleware
+
+InfluxDB client description:
+
+https://github.com/influxdata/influxdb-ruby/blob/master/README.md
+
+Add included middleware to your application's Sidekiq middleware stack:
+
+```ruby
+# config/initializers/sidekiq.rb
+
+require "sidekiq/influxdb/server_middleware"
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::InfluxDB::ServerMiddleware,
+                influxdb_client: InfluxDB::Client.new(options), # REQUIRED
+                series_name: 'sidekiq_jobs',                    # optional, default shown
+                retention_policy: nil                           # optional, default nil
+  end
+end
+```
+
+When you deploy this code, you will start getting the following series in your InfluxDB database:
+
+    > select * from sidekiq_jobs
+    name: sidekiq_jobs
+    time                class  creation_time      error         event  jid                      queue   total              waited              worked
+    ----                -----  -------------      -----         -----  ---                      -----   -----              ------              ------
+    1511707465061000000 FooJob 1511707459.0186539               start  51cc82fe75fbeba37b1ff18f default                    6.042410135269165
+    1511707465061000000 FooJob 1511707459.0186539               finish 51cc82fe75fbeba37b1ff18f default 8.046684265136719  6.042410135269165   2.0042741298675537
+    1511707467068000000 BarJob 1511707461.019835                start  3891f241ab84d3aba728822e default                    6.049134016036987
+    1511707467068000000 BarJob 1511707461.019835  NoMethodError error  3891f241ab84d3aba728822e default 8.056788206100464  6.049134016036987   2.0076541900634766
+
+Tags (repetitive, indexed data — for filtering and grouping by):
+
+* `time` — Standard InfluxDB timestamp. Precision of the supplied client is respected. Only `s`, `ms`, and `u` precisions are supported.
+* `queue` — Queue name.
+* `class` — Job class name.
+* `event` — What happened to the job at the specified `time`: `start`, `finish`, or `error`.
+* `error` — If `event=error`, this tag contains the exception class name.
+
+Values (unique, non-indexed data — for aggregation):
+
+* `jid` — Unique job ID.
+* `creation_time` — Job creation time.
+
+_The following timings are calculated by this gem (in seconds):_
+
+* `waited` — How long the job waited in the `queue` until Sidekiq got around to starting it.
+* `worked` — How long it took to perform the job from start to finish or to an exception.
+* `total` — How much time passed from job creation to finish. How long it took to do the job, in total.
+
+This schema allows querying various job metrics effectively.
+
+For example, how many reports have been generated in the last day:
+
+```sql
+SELECT COUNT(jid) FROM sidekiq_jobs WHERE class = 'ReportGeneration' AND time > now() - 1d
+```
+
+How many different jobs were executed with errors in the last day:
+
+```sql
+SELECT COUNT(jid) FROM sidekiq_jobs WHERE event = 'error' AND time > now() - 1d GROUP BY class
+```
+
+Et cetera.
+
+## Development
+
+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.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vassilevsky/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/vassilevsky/sidekiq-influxdb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/sidekiq/influxdb.rb

@@ -0,0 +1,2 @@
+require "sidekiq/influxdb/version"
+require "sidekiq/influxdb/server_middleware"

data/lib/sidekiq/influxdb/server_middleware.rb

@@ -0,0 +1,67 @@
+require 'influxdb'
+
+module Sidekiq
+  module InfluxDB
+    class ServerMiddleware
+      def initialize(
+        influxdb_client:,
+        series_name: 'sidekiq_jobs',
+        retention_policy: nil
+      )
+        @influxdb = influxdb_client
+        @series = series_name
+        @retention = retention_policy
+      end
+
+      def call(worker, msg, queue)
+        t = Time.now.to_f
+        data = {
+          tags: {
+            class: worker.class.name,
+            queue: queue,
+            event: 'start',
+          },
+          values: {
+            jid:           msg['jid'],
+            creation_time: msg['created_at'],
+            waited:    t - msg['created_at'],
+          },
+          timestamp: in_correct_precision(t)
+        }
+        save(data)
+        begin
+          yield
+          data[:tags][:event] = 'finish'
+        rescue => e
+          data[:tags][:event] = 'error'
+          data[:tags][:error] = e.class.name
+        end
+        tt = Time.now.to_f
+        data[:values][:worked] = tt - t
+        data[:values][:total]  = tt - msg['created_at']
+        data[:timestamp] = in_correct_precision(tt)
+        save(data)
+        raise e if e
+      end
+
+      private
+
+      def save(data)
+        @influxdb.write_point(@series, data, precision, @retention)
+      end
+
+      def precision
+        @influxdb.config.time_precision
+      end
+
+      def in_correct_precision(t)
+        case precision
+          # In order of probability in real-world setups
+          when 'ms' then (t * 1000).to_i
+          when 's'  then  t.to_i
+          when 'u'  then (t * 1000000).to_i
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/influxdb/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module InfluxDB
+    VERSION = "0.1.0"
+  end
+end

data/sidekiq-influxdb.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/influxdb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-influxdb"
+  spec.version       = Sidekiq::InfluxDB::VERSION
+  spec.authors       = ["Ilya Vassilevsky"]
+  spec.email         = ["vassilevsky@gmail.com"]
+
+  spec.summary       = "Writes Sidekiq job metrics to InfluxDB"
+  spec.homepage      = "https://github.com/vassilevsky/sidekiq-influxdb"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "influxdb", "~> 0.0"
+  spec.add_runtime_dependency "sidekiq", "~> 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-influxdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ilya Vassilevsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- vassilevsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- Rakefile
+- lib/sidekiq/influxdb.rb
+- lib/sidekiq/influxdb/server_middleware.rb
+- lib/sidekiq/influxdb/version.rb
+- sidekiq-influxdb.gemspec
+homepage: https://github.com/vassilevsky/sidekiq-influxdb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Writes Sidekiq job metrics to InfluxDB
+test_files: []