telegraf 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 880b5d95e2fb34e2f1f03d8d20b0cb9fca7617ef
-  data.tar.gz: d78b0b208c7c3fe10fa63a9ae99d9ae6cf3c1de1
+SHA256:
+  metadata.gz: d24537357d52b68f806f668f2e356a2272f5a2964050051827fed20afcf775b2
+  data.tar.gz: c6cfdaa89a5cd249dc1533c7aedda8237157e9778a42e501cc7d26b439cdcaef
 SHA512:
-  metadata.gz: 2eb66afb4ab9d6f23107b31f5a2ebe7e669eafd932e582bde65bb4a474f87a061ffd991a913e7177f7bd216386e19da63d470951c42074f66d1aeb1a450faf2c
-  data.tar.gz: 7a00b60bd44a4fb37236a76b4738301ae41b47510a01b5e8d40c9156ad1f4948ab72da1790a8804d5b251005a93fd7c306efd7e801ba6025671b9d2c4e269baf
+  metadata.gz: '085618264388f4883a978265487b0c5c7659297e4db42c04924281ed96e99fabb0ba20f0d4e4294237e5bed48bbae298a40a5c395e8d3b3ed48d9ac1a1db765a'
+  data.tar.gz: 825e81ddf41b25254b1d6a048223dda4e840a42171303a8080ed27e03d250ff5e130c4e6e348472cd6c3618c9eff848f5db1324e7b04df4d62990addfa214577

data/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -1,9 +1,12 @@
+/_yardoc/
 /.bundle/
 /.yardoc
-/Gemfile.lock
-/_yardoc/
 /coverage/
 /doc/
+/Gemfile.lock
+/gemfiles/.bundle/
+/gemfiles/*.lock
+/log/
 /pkg/
 /spec/reports/
 /tmp/

data/.rubocop.yml

@@ -1,53 +1,70 @@
 AllCops:
   Include:
     - '**/*.rb'
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*_spec.rb'
-
-Metrics/LineLength:
-  Exclude:
-    - 'spec/**/*_spec.rb'
 
-Style/AlignParameters:
+Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
-
-Style/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: true
+  SupportedStyles:
+    - case
+    - end
 
-Style/RaiseArgs:
-  EnforcedStyle: compact
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
 
-Style/Documentation:
-  Enabled: false
+Layout/LineLength:
+  Exclude:
+    - spec/**/*_spec.rb
 
-Style/SpaceInsideBlockBraces:
+Layout/SpaceInsideBlockBraces:
   EnforcedStyle: space
   EnforcedStyleForEmptyBraces: no_space
   SpaceBeforeBlockParameters: false
 
-Style/SignalException:
-  EnforcedStyle: only_raise
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
 
-Style/CaseIndentation:
-  EnforcedStyle: end
-  SupportedStyles:
-    - case
-    - end
-  IndentOneStep: true
 
-Style/ClassAndModuleChildren:
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/MethodLength:
   Enabled: false
 
-Style/TrivialAccessors:
-  AllowPredicates: true
 
-Style/FileName:
+Naming/FileName:
   Exclude:
     - Rakefile
     - Gemfile
+
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/RescueModifier:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/.travis.yml

@@ -1,8 +1,15 @@
 sudo: false
-dist: trusty
+dist: bionic
 language: ruby
 rvm:
-- 2.4.1
-- 2.3.4
-before_install:
-- gem install bundler -v 1.15.1
+  - 2.7.0
+  - 2.6.5
+  - 2.5.7
+gemfile:
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_6.0.gemfile
+  - gemfiles/rack_2.0.gemfile
+  - gemfiles/rack_2.1.gemfile
+  - gemfiles/rack_2.2.gemfile

data/Appraisals

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+appraise "rails-5.0" do
+  group :test do
+    gem "rails", "~> 5.0.0"
+  end
+end
+
+appraise "rails-5.1" do
+  group :test do
+    gem "rails", "~> 5.1.0"
+  end
+end
+
+appraise "rails-5.2" do
+  group :test do
+    gem "rails", "~> 5.2.0"
+  end
+end
+
+appraise "rails-6.0" do
+  group :test do
+    gem "rails", "~> 6.0.0"
+  end
+end
+
+appraise "rack-2.0" do
+  group :test do
+    gem "rack", "~> 2.0.0"
+  end
+end
+
+appraise "rack-2.1" do
+  group :test do
+    gem "rack", "~> 2.1.0"
+  end
+end
+
+appraise "rack-2.2" do
+  group :test do
+    gem "rack", "~> 2.2.0"
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+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).
+
+## [0.8.0] - 2020-12-02
+### Added
+- ActiveJob instrumentation (#10)
+
+## [0.7.0] - 2020-05-07
+### Added
+- Sidekiq middleware (#8)
+
+## [0.6.1] - 2020-04-01
+### Fixed
+- Fix type in instrumentation option (#7)
+
+## [0.6.0] - 2020-03-31
+### Added
+- New Rack middleware and Rails plugin to collect request events (#5)
+
+## 0.5.0
+### Changed
+- Remove `influxdb` not unnecessarily restrict users needing a specific influxdb client.
+
+[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

@@ -4,3 +4,18 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in telegraf.gemspec
 gemspec
+
+gem 'rake'
+gem 'rspec', '~> 3.8'
+gem 'rubocop', '~> 0.80.0'
+
+group :test do
+  gem 'rack'
+  gem 'rails'
+  gem 'sidekiq', '~> 6.0'
+end
+
+group :development do
+  gem 'appraisal'
+  gem 'rake-release', '~> 1.2'
+end

data/README.md

@@ -1,6 +1,10 @@
 # Telegraf
 
-Minimal gem to send metrics to a local telegraf agent.
+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, 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.
 
 ## Installation
 
@@ -16,20 +20,19 @@ Or install it yourself as:
 
     $ gem install telegraf
 
-## Usage
+## Usage as a library
 
 Configure telegraf socket listener e.g.:
 
 ```
 [[inputs.socket_listener]]
-  service_address = "unix:/run/telegraf/telegraf.sock"
-  # service_address = "tcp://localhost:8094"
+  service_address = "udp://localhost:8094"
 
 ```
 
 ```ruby
-telegraf = Telegraf::Agent.new 'unix:/run/telegraf/telegraf.sock'
-# telegraf = Telegraf::Agent.new 'tcp://localhost:8094'
+telegraf = Telegraf::Agent.new 'udp://localhost:8094'
+telegraf = Telegraf::Agent.new # default: 'udp://localhost:8094'
 
 telegraf.write('demo',
     tags: {tag_a: 'A', tag_b: 'B'},
@@ -46,9 +49,82 @@ There is not buffer or batch handling, nor connection pooling or keep alive. Eac
 
 There is no exception handling.
 
+## Using the Rack and Rails plugins
+
+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
+
+```ruby
+require "telegraf/rack"
+
+agent = ::Telegraf::Agent.new
+use ::Telegraf::Rack.new(series: 'rack', agent: agent, tags: {global: 'tag'})
+```
+
+See middleware [class documentation](lib/telegraf/rack.rb) for more details.
+
+The Rack middleware supports parsing the `X-Request-Start: t=<timestamp>` header expecting a fractional (UTC) timestamp when the request has been started or first received by e.g. a load balancer. An additional value `queue_ms` with the queue time will be included.
+
+### Rails
+
+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
+
+require "telegraf/rails"
+
+class MyApplication > ::Rails::Application
+  # Configure receiver
+  config.telegraf.connect = "udp://localhost:9084"
+
+  # By default the Rack middleware to collect events is installed
+  config.telegraf.rack.enabled = true
+  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
+end
+```
+
+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 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
 
-Copyright (C) 2017 Jan Graichen
+Copyright (C) 2017-2020 Jan Graichen
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 

data/Rakefile

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
+require 'rake/release/task'
 require 'rspec/core/rake_task'
 
+Rake::Release::Task.new do |spec|
+  spec.sign_tag = true
+end
+
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec

data/gemfiles/rack_2.0.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "~> 0.80.0"
+
+group :test do
+  gem "rack", "~> 2.0.0"
+  gem "rails"
+  gem "sidekiq", "~> 6.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/rack_2.1.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "~> 0.80.0"
+
+group :test do
+  gem "rack", "~> 2.1.0"
+  gem "rails"
+  gem "sidekiq", "~> 6.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/rack_2.2.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "~> 0.80.0"
+
+group :test do
+  gem "rack", "~> 2.2.0"
+  gem "rails"
+  gem "sidekiq", "~> 6.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "~> 0.80.0"
+
+group :test do
+  gem "rack"
+  gem "rails", "~> 5.0.0"
+  gem "sidekiq", "~> 6.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "~> 0.80.0"
+
+group :test do
+  gem "rack"
+  gem "rails", "~> 5.1.0"
+  gem "sidekiq", "~> 6.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "~> 0.80.0"
+
+group :test do
+  gem "rack"
+  gem "rails", "~> 5.2.0"
+  gem "sidekiq", "~> 6.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "~> 0.80.0"
+
+group :test do
+  gem "rack"
+  gem "rails", "~> 6.0.0"
+  gem "sidekiq", "~> 6.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/lib/telegraf/active_job.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Telegraf
+  # Telegraf::ActiveJob
+  #
+  # This class collects ActiveJob queue metrics and sends them to telegraf.
+  #
+  #
+  # Tags:
+  #
+  # * `queue`:
+  #     The queue this job landed on.
+  #
+  # * `job`:
+  #     The name of the job class that was executed.
+  #
+  # * `errors`:
+  #     Whether or not this job errored.
+  #
+  #
+  # Values:
+  #
+  # * `app_ms`:
+  #     Total job processing time.
+  #
+  class ActiveJob
+    def initialize(agent:, series: 'active_job', tags: {})
+      @agent = agent
+      @series = series.to_s.freeze
+      @tags = tags.freeze
+    end
+
+    def call(_name, start, finish, _id, payload)
+      job = payload[:job]
+
+      @agent.write(
+        @series,
+        tags: {
+          **@tags,
+          job: job.class.name,
+          queue: job.queue_name,
+          errors: payload.key?(:exception_object)
+        },
+        values: {
+          app_ms: ((finish - start) * 1000.0) # milliseconds
+        }
+      )
+    end
+  end
+end

data/lib/telegraf/agent.rb

@@ -2,19 +2,19 @@
 
 module Telegraf
   class Agent
-    DEFAULT_URI = 'udp://localhost:8094'
+    DEFAULT_CONNECTION = 'udp://localhost:8094'
 
     attr_reader :uri
     attr_reader :logger
 
-    def initialize(uri = DEFAULT_CONNECTION, logger: nil)
-      @uri = URI.parse(uri)
+    def initialize(uri = nil, logger: nil)
+      @uri = URI.parse(uri || DEFAULT_CONNECTION)
       @logger = logger
     end
 
-    def write(*args)
-      write!(*args)
-    rescue => e
+    def write(*args, **kwargs)
+      write!(*args, **kwargs)
+    rescue StandardError => e
       logger&.error('telegraf') do
         e.to_s + e.backtrace.join("\n")
       end

data/lib/telegraf/rack.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module Telegraf
+  # Telegraf::Rack
+  #
+  # This rack middleware collects request metrics and sends them to the telegraf
+  # agent. A `Point` data structure is added to the Rack environment to assign
+  # custom tags and values. This point can be accessed using the environment key
+  # defined in `::Telegraf::Rack::FIELD_NAME`.
+  #
+  # Example:
+  #
+  #     if (point = request.env[::Telegraf::Rack::FIELD_NAME])
+  #       point.tags[:tag] = 'tag'
+  #       point.values[:value] = 10
+  #     end
+  #
+  #
+  # Tags:
+  #
+  # * `status`:
+  #     Response status unless request errored
+  #
+  #
+  # Values:
+  #
+  # * `request_ms`:
+  #     Total request processing time including response sending.
+  #
+  # * `app_ms`:
+  #     Total application processing time.
+  #
+  # * `send_ms`:
+  #     Time took to send the response body.
+  #
+  # * `queue_ms`:
+  #     Queue time calculated from a `X-Request-Start` header if present. The
+  #     header is expected to be formatted like this `t=<timestamp>` and
+  #     contain a floating point timestamp in seconds.
+  #
+  class Rack
+    FIELD_NAME = 'telegraf.rack.point'
+    HEADER_REGEX = /t=(\d+(\.\d+)?)/.freeze
+
+    Point = Struct.new(:tags, :values)
+
+    def initialize(app, agent:, series: 'rack', tags: {}, logger: nil)
+      @app = app
+      @tags = tags.freeze
+      @agent = agent
+      @series = series.to_s.freeze
+      @logger = logger
+    end
+
+    def call(env)
+      if (request_start = extract_request_start(env))
+        queue_ms = (::Time.now.utc - request_start) * 1000 # milliseconds
+      end
+
+      rack_start = ::Rack::Utils.clock_time
+      point = env[FIELD_NAME] = Point.new(@tags.dup, {})
+      point.values[:queue_ms] = queue_ms if queue_ms
+
+      begin
+        begin
+          status, headers, body = @app.call(env)
+        ensure
+          point.tags[:status] ||= status || -1
+          point.values[:app_ms] = \
+            (::Rack::Utils.clock_time - rack_start) * 1000 # milliseconds
+        end
+
+        send_start = ::Rack::Utils.clock_time
+        proxy = ::Rack::BodyProxy.new(body) do
+          point.values[:send_ms] = \
+            (::Rack::Utils.clock_time - send_start) * 1000 # milliseconds
+
+          finish(env, point, rack_start)
+        end
+
+        [status, headers, proxy]
+      ensure
+        finish(env, point, rack_start) unless proxy
+      end
+    end
+
+    private
+
+    def finish(env, point, rack_start)
+      point.values[:request_ms] = \
+        (::Rack::Utils.clock_time - rack_start) * 1000 # milliseconds
+
+      @agent.write(@series, tags: point.tags, values: point.values)
+    rescue StandardError => e
+      (@logger || env[::Rack::RACK_LOGGER])&.error(e)
+    end
+
+    def extract_request_start(env)
+      return unless env.key?('HTTP_X_REQUEST_START')
+
+      if (m = HEADER_REGEX.match(env['HTTP_X_REQUEST_START']))
+        ::Time.at(m[1].to_f).utc
+      end
+    rescue FloatDomainError
+      # Ignore obscure floats in Time.at (e.g. infinity)
+      false
+    end
+  end
+end

data/lib/telegraf/rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'telegraf/railtie'

data/lib/telegraf/railtie.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'telegraf/active_job'
+require 'telegraf/rack'
+require 'telegraf/sidekiq'
+
+module Telegraf
+  # Telegraf::Railtie
+  #
+  # This Rails plugin installs the rack middleware and adds intrumentation to
+  # enrich the data point with additional tags an values.
+  #
+  # These include the following tags:
+  #
+  # * `action`
+  #     The controller action, e.g. `index`.
+  #
+  # * `controller`
+  #     The controller class name, e.g. `API::UsersController`.
+  #
+  # * `instance`
+  #     A combination of the controller class and the action, e.g.
+  #     `API::UsersController#index`.
+  #
+  # * `method`
+  #     The request method, e.g. `GET`.
+  #
+  # Additional collected values are:
+  #
+  # * `db_ms`
+  #     Time spend with database operations in milliseconds.
+  #
+  # * `view_ms`
+  #     Time spend with rendering views in milliseconds.
+  #
+  # * `action_ms`
+  #     Total time spend in a Rails action in milliseconds.
+  #
+  # These additional tags and values are collection from the
+  # `process_action.action_controller` events usings Rails instrumentation.
+  #
+  class Railtie < ::Rails::Railtie
+    config.telegraf = ::ActiveSupport::OrderedOptions.new
+
+    # Connect URI or tuple
+    config.telegraf.connect = ::Telegraf::Agent::DEFAULT_CONNECTION
+
+    # Install Rack middlewares
+    config.telegraf.rack = ::ActiveSupport::OrderedOptions.new
+    config.telegraf.rack.enabled = true
+    config.telegraf.rack.series = 'requests'
+    config.telegraf.rack.tags = {}
+
+    # Install request instrumentation
+    config.telegraf.instrumentation = true
+
+    # Install ActiveJob instrumentation
+    config.telegraf.active_job = ::ActiveSupport::OrderedOptions.new
+    config.telegraf.active_job.enabled = defined?(::ActiveJob)
+    config.telegraf.active_job.series = 'active_job'
+    config.telegraf.active_job.tags = {}
+
+    # 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 \
+          app.config.telegraf.connect,
+          logger: Rails.logger
+      end
+    end
+
+    initializer 'telegraf.rack' do |app|
+      next unless app.config.telegraf.rack.enabled
+
+      app.config.middleware.insert 0, Telegraf::Rack, \
+        agent: app.config.telegraf.agent,
+        series: app.config.telegraf.rack.series,
+        tags: app.config.telegraf.rack.tags,
+        logger: Rails.logger
+    end
+
+    initializer 'telegraf.instrumentation' do |app|
+      next unless app.config.telegraf.instrumentation
+
+      ActiveSupport::Notifications.subscribe(
+        'process_action.action_controller'
+      ) do |_name, start, finish, _id, payload|
+        point = payload[:headers].env[::Telegraf::Rack::FIELD_NAME]
+        next unless point
+
+        point.tags[:action] = payload[:action]
+        point.tags[:controller] = payload[:controller]
+        point.tags[:instance] = "#{payload[:controller]}##{payload[:action]}"
+        point.tags[:method] = payload[:method]
+
+        point.values[:db_ms] = payload[:db_runtime].to_f
+        point.values[:view_ms] = payload[:view_runtime].to_f
+        point.values[:action_ms] = ((finish - start) * 1000.0) # milliseconds
+      end
+    end
+
+    initializer 'telegraf.active_job' do |app|
+      next unless app.config.telegraf.active_job.enabled
+
+      ActiveSupport::Notifications.subscribe(
+        'perform.active_job',
+        Telegraf::ActiveJob.new(
+          agent: app.config.telegraf.agent,
+          series: app.config.telegraf.active_job.series,
+          tags: app.config.telegraf.active_job.tags
+        )
+      )
+    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,7 +3,7 @@
 module Telegraf
   module VERSION
     MAJOR = 0
-    MINOR = 4
+    MINOR = 8
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze

data/telegraf.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Metric Reporter to local telegraf agent'
   spec.description   = 'Metric Reporter to local telegraf agent'
-  spec.homepage      = 'https://github.com/jgraichen/ruby-telegraf'
+  spec.homepage      = 'https://github.com/jgraichen/telegraf-ruby'
   spec.license       = 'LGPLv3'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -24,9 +24,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'influxdb', '~> 0.3.15'
+  spec.add_dependency 'influxdb'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
 end

metadata

@@ -1,71 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: telegraf
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Metric Reporter to local telegraf agent
 email:
 - jgraichen@altimos.de
@@ -73,21 +45,36 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/rack_2.0.gemfile
+- gemfiles/rack_2.1.gemfile
+- gemfiles/rack_2.2.gemfile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
 - lib/telegraf.rb
+- lib/telegraf/active_job.rb
 - lib/telegraf/agent.rb
+- 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
+homepage: https://github.com/jgraichen/telegraf-ruby
 licenses:
 - LGPLv3
 metadata: {}
@@ -106,8 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Metric Reporter to local telegraf agent