telegraf 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f68b6dfd1bcf5659a4ee22bbe80665502a4fc09e55b90834ec85ab09e040893
-  data.tar.gz: d5be579cd9bec77152ef0af33ed0c7040a2f5cfe59923da85f096be604e07ba5
+  metadata.gz: 7c8831d93642d86138aba55b26bfcb5d676bf8d223702f74361716dd2bdbf315
+  data.tar.gz: be3e3b368dbfde682bd1ade3650277119a0302e9d604ebdd920ede401858487c
 SHA512:
-  metadata.gz: c7b349c501e843458c7232f4695638a763927895c4001efe4b23cc76cda6ba4b6143153f0f43a9b037130b192cb1ca8152509488413947ae3de9cd8e120361be
-  data.tar.gz: 88a520e880d0507da05f9af9c58b69288bf59968dc4fc54238f6cdf1a5a8ca92359fe5bf6ab558171cbaf09111e1634a827c0607e1afbcf24c35285e8b8bbe15
+  metadata.gz: 22d42f69c60e4c75c32e76f01113bc1077cc1111deb12d2949ca21c44d04273d84807632f082d0759aba7ce90659ac8d68fcf4a70ad8e5e7bf7879a727dd31df
+  data.tar.gz: e4be9374228b344550962c463ae26283404c2f7701876c785c3b5063d937f6e037f7603e387ec5daf6781c799d2715b415ae899213f8eee0c6ce1da8743407e9

data/CHANGELOG.md

@@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.7.0] - 2020-05-07
+### Added
+- Sidekiq middleware (#8)
 
 ## [0.6.1] - 2020-04-01
 ### Fixed
@@ -18,6 +20,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 - Remove `influxdb` not unnecessarily restrict users needing a specific influxdb client.
 
-[unreleased]: https://github.com/:jgraichen/telegraf-ruby/compare/v0.6.1...HEAD
+[0.7.0]: https://github.com/:jgraichen/telegraf-ruby/compare/v0.6.1...v0.7.0
 [0.6.1]: https://github.com/:jgraichen/telegraf-ruby/compare/v0.6.0...v0.6.1
 [0.6.0]: https://github.com/:jgraichen/telegraf-ruby/compare/v0.5.0...v0.6.0

data/Gemfile

@@ -10,6 +10,7 @@ gem 'rubocop', '~> 0.80.0'
 
 gem 'rack'
 gem 'railties'
+gem 'sidekiq', '~> 6.0'
 
 # Specify your gem's dependencies in telegraf.gemspec
 gemspec

data/README.md

@@ -2,7 +2,7 @@
 
 Send events to a local [Telegraf](https://github.com/influxdata/telegraf) agent or anything that can receive the InfluxDB line protocol.
 
-It further includes plugins for Rack and Rails to collect request events. See plugin usage details below.
+It further includes plugins for Rack, Rails and Sidekiq to collect request events. See plugin usage details below.
 
 This gem only uses the line protocol from the `influxdb` gem and does not depend on any specific version. This may break in the future but does not restrict you in using a your preferred `influxdb` gem version.
 
@@ -51,7 +51,7 @@ There is no exception handling.
 
 ## Using the Rack and Rails plugins
 
-This gem include a Rails plugin and a rack middleware to collect request events. They need to be explicitly required to be used:
+This gem include a Rails plugin and middlewares for Rack and Sidekiq to collect request events. They need to be explicitly required to be used:
 
 ### Rack
 
@@ -68,7 +68,7 @@ The Rack middleware supports parsing the `X-Request-Start: t=<timestamp>` header
 
 ### Rails
 
-The Rails plugin needs to required too but by default automatically installs required components.
+The Rails plugin needs to required, too, but by default automatically installs required components (Rack, Sidekiq and Rails-specific instrumentation).
 
 ```ruby
 # e.g. in application.rb
@@ -84,6 +84,11 @@ class MyApplication > ::Rails::Application
   config.telegraf.rack.series = "requests"
   config.telegraf.rack.tags = {}
 
+  # These are the default settings when Sidekiq is detected
+  config.telegraf.sidekiq.enabled = true
+  config.telegraf.sidekiq.series = "sidekiq"
+  config.telegraf.sidekiq.tags = {}
+
   # Additionally the application is instrumented to tag events with
   # controller and action as well as to collect app, database and view timings
   config.telegraf.instrumentation = true
@@ -96,7 +101,26 @@ Received event example:
 requests,action=index,controller=TestController,instance=TestController#index,method=GET,status=200 db_ms=0.0,view_ms=2.6217450003969134,action_ms=2.702335,app_ms=4.603561000294576,send_ms=0.09295000018028077,request_ms=4.699011000411701,queue_ms=0.00003000028323014
 ```
 
-See the rack middleware [class documentation](lib/telegraf/rack.rb) and the Rails plugin [class documentation](lib/telegraf/railtie.rb) for more details on  the collected tags and values.
+See the various classes' documentation for more details on the collected tags and values:
+- [Rack middleware](lib/telegraf/rack.rb)
+- [Rails plugin](lib/telegraf/railtie.rb)
+- [Sidekiq middleware](lib/telegraf/sidekiq.rb)
+
+### Sidekiq
+
+```ruby
+require "telegraf/sidekiq"
+
+agent = ::Telegraf::Agent.new
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add ::Telegraf::Sidekiq::Middleware, agent: agent, series: 'background', tags: {global: 'tag'}
+  end
+end
+```
+
+See middleware [class documentation](lib/telegraf/sidekiq.rb) for more details.
+
 
 ## License
 

data/gemfiles/rack_2.0.gemfile

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rubocop", "~> 0.80.0"
+gem "appraisal"
+gem "rake-release", "~> 1.2"
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "appraisal"
+gem "rubocop", "~> 0.80.0"
 gem "rack", "~> 2.0.0"
 gem "railties"
+gem "sidekiq", "~> 6.0"
 
 gemspec path: "../"

data/gemfiles/rack_2.1.gemfile

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rubocop", "~> 0.80.0"
+gem "appraisal"
+gem "rake-release", "~> 1.2"
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "appraisal"
+gem "rubocop", "~> 0.80.0"
 gem "rack", "~> 2.1.0"
 gem "railties"
+gem "sidekiq", "~> 6.0"
 
 gemspec path: "../"

data/gemfiles/rack_2.2.gemfile

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rubocop", "~> 0.80.0"
+gem "appraisal"
+gem "rake-release", "~> 1.2"
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "appraisal"
+gem "rubocop", "~> 0.80.0"
 gem "rack", "~> 2.2.0"
 gem "railties"
+gem "sidekiq", "~> 6.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rubocop", "~> 0.80.0"
+gem "appraisal"
+gem "rake-release", "~> 1.2"
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "appraisal"
+gem "rubocop", "~> 0.80.0"
 gem "rack"
 gem "railties", "~> 5.0.0"
+gem "sidekiq", "~> 6.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rubocop", "~> 0.80.0"
+gem "appraisal"
+gem "rake-release", "~> 1.2"
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "appraisal"
+gem "rubocop", "~> 0.80.0"
 gem "rack"
 gem "railties", "~> 5.1.0"
+gem "sidekiq", "~> 6.0"
 
 gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rubocop", "~> 0.80.0"
+gem "appraisal"
+gem "rake-release", "~> 1.2"
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "appraisal"
+gem "rubocop", "~> 0.80.0"
 gem "rack"
 gem "railties", "~> 5.2.0"
+gem "sidekiq", "~> 6.0"
 
 gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rubocop", "~> 0.80.0"
+gem "appraisal"
+gem "rake-release", "~> 1.2"
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "appraisal"
+gem "rubocop", "~> 0.80.0"
 gem "rack"
 gem "railties", "~> 6.0.0"
+gem "sidekiq", "~> 6.0"
 
 gemspec path: "../"

data/lib/telegraf/railtie.rb

@@ -2,6 +2,7 @@
 
 require 'rails'
 require 'telegraf/rack'
+require 'telegraf/sidekiq'
 
 module Telegraf
   # Telegraf::Railtie
@@ -44,7 +45,7 @@ module Telegraf
     # Connect URI or tuple
     config.telegraf.connect = ::Telegraf::Agent::DEFAULT_CONNECTION
 
-    # Install rackmiddlewares
+    # Install Rack middlewares
     config.telegraf.rack = ::ActiveSupport::OrderedOptions.new
     config.telegraf.rack.enabled = true
     config.telegraf.rack.series = 'requests'
@@ -53,6 +54,12 @@ module Telegraf
     # Install request instrumentation
     config.telegraf.instrumentation = true
 
+    # Install Sidekiq middleware
+    config.telegraf.sidekiq = ::ActiveSupport::OrderedOptions.new
+    config.telegraf.sidekiq.enabled = defined?(::Sidekiq)
+    config.telegraf.sidekiq.series = 'sidekiq'
+    config.telegraf.sidekiq.tags = {}
+
     initializer 'telegraf.agent' do |app|
       app.config.telegraf.agent ||= begin
         ::Telegraf::Agent.new \
@@ -90,5 +97,18 @@ module Telegraf
         point.values[:action_ms] = ((finish - start) * 1000.0) # milliseconds
       end
     end
+
+    initializer 'telegraf.sidekiq' do |app|
+      next unless app.config.telegraf.sidekiq.enabled
+
+      ::Sidekiq.configure_server do |config|
+        config.server_middleware do |chain|
+          chain.add Telegraf::Sidekiq::Middleware, \
+            agent: app.config.telegraf.agent,
+            series: app.config.telegraf.sidekiq.series,
+            tags: app.config.telegraf.sidekiq.tags
+        end
+      end
+    end
   end
 end

data/lib/telegraf/sidekiq.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module Telegraf
+  module Sidekiq
+    # Telegraf::Sidekiq::Middleware
+    #
+    # This Sidekiq middleware collects queue metrics and sends them to telegraf.
+    #
+    #
+    # Tags:
+    #
+    # * `type`:
+    #     One of "job" or "scheduled_job".
+    #
+    # * `queue`:
+    #     The queue this job landed on.
+    #
+    # * `worker`:
+    #     The name of the worker class that was executed.
+    #
+    # * `errors`:
+    #     Whether or not this job errored.
+    #
+    # * `retry`:
+    #     Whether or not this execution was a retry of a previously failed one.
+    #
+    #
+    # Values:
+    #
+    # * `app_ms`:
+    #     Total worker processing time.
+    #
+    # * `queue_ms`:
+    #     How long did this job wait in the queue before being processed?
+    #     Only present for "normal" (async) jobs (with tag `type` of "job").
+    #
+    class Middleware
+      def initialize(agent:, series: 'sidekiq', tags: {})
+        @agent = agent
+        @series = series.to_s.freeze
+        @tags = tags.freeze
+      end
+
+      def call(worker, job, queue)
+        job_start = ::Time.now.utc
+
+        tags = {
+          **@tags,
+          type: 'job',
+          errors: true,
+          retry: job.key?('retried_at'),
+          queue: queue,
+          worker: worker.class.name
+        }
+
+        values = {
+          retry_count: job['retry_count']
+        }.compact
+
+        # The "enqueued_at" key is not present for scheduled jobs.
+        # See https://github.com/mperham/sidekiq/wiki/Job-Format.
+        if job.key?('enqueued_at')
+          enqueued_at = ::Time.at(job['enqueued_at'].to_f).utc
+          values[:queue_ms] = (job_start - enqueued_at) * 1000 # milliseconds
+        end
+
+        # The "at" key is only present for scheduled jobs.
+        tags[:type] = 'scheduled_job' if job.key?('at')
+
+        begin
+          yield
+
+          # If we get here, this was a successful execution
+          tags[:errors] = false
+        ensure
+          job_stop = ::Time.now.utc
+
+          values[:app_ms] = (job_stop - job_start) * 1000 # milliseconds
+
+          @agent.write(
+            @series, tags: tags, values: values
+          )
+        end
+      end
+    end
+  end
+end

data/lib/telegraf/version.rb

@@ -3,8 +3,8 @@
 module Telegraf
   module VERSION
     MAJOR = 0
-    MINOR = 6
-    PATCH = 1
+    MINOR = 7
+    PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegraf
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
@@ -70,6 +70,7 @@ files:
 - lib/telegraf/rack.rb
 - lib/telegraf/rails.rb
 - lib/telegraf/railtie.rb
+- lib/telegraf/sidekiq.rb
 - lib/telegraf/version.rb
 - telegraf.gemspec
 homepage: https://github.com/jgraichen/ruby-telegraf
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Metric Reporter to local telegraf agent