telegraf 1.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1992e9545cbbf54646dec6c4830190258a5756d1c536b71a42378ca5c7717eed
-  data.tar.gz: 6e00f1a167a6ac9663903623317fe1d896b882feb5d866eb52385da54603ed09
+  metadata.gz: f2506d8a79e471b78413607796219aa467e330bed37f379482ae51f8b3f41d45
+  data.tar.gz: 30202e32e4584499161208af9d1e355bb6b8770d425675738a7b4a3e4cad553d
 SHA512:
-  metadata.gz: 949c16ce2e986feef4362d1060290b64efd01ed08a08222129a59577f22c3a4d643dc80324ede1f27f10dee63fcf0519f4c3386547c67c435418e68634644627
-  data.tar.gz: 8eafa264491cff6861f7b346e3548bf51ef5b570f2779a7b3d31e02dc62c2d8c011c9eeaeda6fc6b0e64ff79fba7ccb839615bb43101fa73f0d177600e18f216
+  metadata.gz: bac63da09a0586326816bb0bf13ec2ca10900af04be4c058f5dd4b524a579ea5752c02573e8b275030dcba8cd66fbcf8b3b96f0e6e7933068ffaffc49197d8e3
+  data.tar.gz: 261d7ef27d1afa299561581d946d85833a1254835ced37f9cf97d7a01e2364a7d43cd65cdfa1fe616216e75382373dcd840d1089751110549c4eb06d4651cf1d

data/.github/workflows/test.yml

@@ -1,23 +1,36 @@
-name: Test
-on: [push]
+# vim: ft=yaml
+name: test
+on: [push, pull_request]
 jobs:
-  test:
+  rspec:
     name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }}
     runs-on: ubuntu-20.04
 
     strategy:
       matrix:
         ruby:
-          - '2.7'
-          - '2.6'
-          - '2.5'
+          - "3.1"
+          - "3.0"
+          - "2.7"
+          - "2.6"
+          - "2.5"
         gemfile:
           - rails_5.2.gemfile
           - rails_6.0.gemfile
           - rails_6.1.gemfile
+          - rails_7.0.gemfile
           - rack_2.0.gemfile
           - rack_2.1.gemfile
           - rack_2.2.gemfile
+        exclude:
+          - ruby: "3.1"
+            gemfile: rails_5.2.gemfile
+          - ruby: "3.0"
+            gemfile: rails_5.2.gemfile
+          - ruby: "2.6"
+            gemfile: rails_7.0.gemfile
+          - ruby: "2.5"
+            gemfile: rails_7.0.gemfile
       fail-fast: false
 
     env:
@@ -35,3 +48,21 @@ jobs:
           bundler-cache: true
 
       - run: bundle exec rspec --color --format documentation
+
+  rubocop:
+    name: rubocop
+    runs-on: ubuntu-20.04
+
+    env:
+      BUNDLE_WITHOUT: development
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+
+    steps:
+      - uses: actions/checkout@master
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+
+      - run: bundle exec rubocop --parallel --color

data/.rubocop.yml

@@ -1,75 +1,11 @@
-AllCops:
-  Include:
-    - "**/*.rb"
-  NewCops: enable
-  SuggestExtensions: false
-  TargetRubyVersion: 2.5
-
-
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/CaseIndentation:
-  EnforcedStyle: end
-  IndentOneStep: true
-  SupportedStyles:
-    - case
-    - end
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/LineLength:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Layout/SpaceInsideBlockBraces:
-  EnforcedStyle: space
-  EnforcedStyleForEmptyBraces: no_space
-  SpaceBeforeBlockParameters: false
-
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*_spec.rb
+# vim: ft=yaml
 
-Metrics/MethodLength:
-  Enabled: false
+inherit_gem:
+  my-rubocop: default.yml
 
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: False
 
-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/IfUnlessModifier:
-  Enabled: false
-
-Style/RescueModifier:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Style/TrivialAccessors:
-  AllowPredicates: true
+RSpec/FilePath:
+  Enabled: False

data/Appraisals

@@ -18,6 +18,12 @@ appraise 'rails-6.1' do
   end
 end
 
+appraise 'rails-7.0' do
+  group :test do
+    gem 'rails', '~> 7.0.0'
+  end
+end
+
 appraise 'rack-2.0' do
   group :test do
     gem 'rack', '~> 2.0.0'

data/CHANGELOG.md

@@ -1,4 +1,7 @@
+<!-- markdownlint-disable-file MD024 -->
+
 # 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/)
@@ -6,31 +9,65 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.1.1] - 2022-08-23
+
+### Fixed
+
+- Possible RuntimeError: can't add a new key into hash during iteration (@MrSerth)
+
+## [2.1.0] - 2022-01-24
+
+### Added
+
+- Support for Rails 7.0 and Ruby 3.1
+- Grape API instrumentation (#17)
+
+## [2.0.0] - 2021-09-30
+
+### Changed
+
+- The sidekiq middleware does not use keyword arguments as sidekiq does not handle them correctly on Ruby 3.0 (#14)
+
 ## [1.0.0] - 2021-01-26
+
 ### Added
+
 - Global tags (#6)
 
 ## [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 - undefined
+
 ### Changed
+
 - Remove `influxdb` not unnecessarily restrict users needing a specific influxdb client.
 
-[Unreleased]: https://github.com/jgraichen/telegraf-ruby/compare/v1.0.0...HEAD
+[unreleased]: https://github.com/jgraichen/telegraf-ruby/compare/v2.1.1...HEAD
+[2.1.1]: https://github.com/jgraichen/telegraf-ruby/compare/v2.1.0...v2.1.1
+[2.1.0]: https://github.com/jgraichen/telegraf-ruby/compare/v2.0.0...v2.1.0
+[2.0.0]: https://github.com/jgraichen/telegraf-ruby/compare/v1.0.0...v2.0.0
 [1.0.0]: https://github.com/jgraichen/telegraf-ruby/compare/v0.8.0...v1.0.0
 [0.8.0]: https://github.com/jgraichen/telegraf-ruby/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/jgraichen/telegraf-ruby/compare/v0.6.1...v0.7.0

data/Gemfile

@@ -5,10 +5,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in telegraf.gemspec
 gemspec
 
+gem 'my-rubocop', github: 'jgraichen/my-rubocop', ref: 'v6'
 gem 'rake'
 gem 'rspec', '~> 3.8'
-gem 'rubocop', '~> 1.7'
-gem 'rubocop-rspec', '~> 1.41'
 
 group :test do
   gem 'rack'

data/README.md

@@ -1,5 +1,8 @@
 # Telegraf
 
+[![Gem Version](https://img.shields.io/gem/v/telegraf?logo=ruby)](https://rubygems.org/gems/telegraf)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jgraichen/telegraf-ruby/test?logo=github)](https://github.com/jgraichen/telegraf-ruby/actions)
+
 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, ActiveJob and Sidekiq to collect request events. See plugin usage details below.
@@ -78,7 +81,7 @@ require "telegraf/rails"
 
 class MyApplication > ::Rails::Application
   # Configure receiver
-  config.telegraf.connect = "udp://localhost:9084"
+  config.telegraf.connect = "udp://localhost:8094"
 
   # Global tags added to all events. These will override
   # any local tag with the same name.
@@ -125,7 +128,7 @@ require "telegraf/active_job"
 agent = ::Telegraf::Agent.new
 ActiveSupport::Notifications.subscribe(
   'perform.active_job',
-  Telegraf::ActiveJob.new(agent: agent, series: 'background', tags: {global: 'tag'})
+  Telegraf::ActiveJob.new(agent: agent, series: 'active_job', tags: {global: 'tag'})
 )
 ```
 
@@ -139,7 +142,7 @@ 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'}
+    chain.add ::Telegraf::Sidekiq::Middleware, agent: agent, series: 'sidekiq', tags: {global: 'tag'}
   end
 end
 ```

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rspec", "~> 1.41"
+
+group :test do
+  gem "rack"
+  gem "rails", "~> 7.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

@@ -39,11 +39,11 @@ module Telegraf
           **@tags,
           job: job.class.name,
           queue: job.queue_name,
-          errors: payload.key?(:exception_object)
+          errors: payload.key?(:exception_object),
         },
         values: {
-          app_ms: ((finish - start) * 1000.0) # milliseconds
-        }
+          app_ms: ((finish - start) * 1000.0), # milliseconds
+        },
       )
     end
   end

data/lib/telegraf/agent.rb

@@ -24,7 +24,7 @@ module Telegraf
       tags = tags.merge(@tags) unless @tags.empty?
 
       if values
-        data = [{series: series || data.to_s, tags: tags, values: values}]
+        data = [{series: series || data.to_s, tags: tags, values: values.dup}]
       end
 
       socket = connect @uri

data/lib/telegraf/grape.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Telegraf
+  # Telegraf::Grape
+  #
+  # This class extends requests metrics with details for Grape API endpoints.
+  #
+  #
+  # Tags:
+  #
+  # * `controller`:
+  #     The Grape endpoint class.
+  #
+  # * `instance`:
+  #     The Grape endpoint class.
+  #
+  # * `format`:
+  #     Grape's internal identifier for the response format.
+  #
+  class Grape
+    def call(_name, _start, _finish, _id, payload)
+      point = payload[:env][::Telegraf::Rack::FIELD_NAME]
+      return unless point
+
+      endpoint = payload[:endpoint]
+      return unless endpoint
+
+      point.tags[:controller] = endpoint.options[:for].to_s
+      point.tags[:instance] = point.tags[:controller]
+      point.tags[:format] = payload[:env]['api.format']
+    end
+  end
+end

data/lib/telegraf/railtie.rb

@@ -3,6 +3,7 @@
 require 'rails'
 require 'telegraf'
 require 'telegraf/active_job'
+require 'telegraf/grape'
 require 'telegraf/rack'
 require 'telegraf/sidekiq'
 
@@ -57,6 +58,10 @@ module Telegraf
     # Install request instrumentation
     config.telegraf.instrumentation = true
 
+    # Install Grape instrumentation
+    config.telegraf.grape = ::ActiveSupport::OrderedOptions.new
+    config.telegraf.grape.enabled = defined?(::Grape)
+
     # Install ActiveJob instrumentation
     config.telegraf.active_job = ::ActiveSupport::OrderedOptions.new
     config.telegraf.active_job.enabled = defined?(::ActiveJob)
@@ -70,12 +75,11 @@ module Telegraf
     config.telegraf.sidekiq.tags = {}
 
     initializer 'telegraf.agent' do |app|
-      app.config.telegraf.agent ||= begin
+      app.config.telegraf.agent ||= \
         ::Telegraf::Agent.new \
           app.config.telegraf.connect,
           logger: Rails.logger,
           tags: app.config.telegraf.tags
-      end
     end
 
     initializer 'telegraf.rack' do |app|
@@ -92,7 +96,7 @@ module Telegraf
       next unless app.config.telegraf.instrumentation
 
       ActiveSupport::Notifications.subscribe(
-        'process_action.action_controller'
+        'process_action.action_controller',
       ) do |_name, start, finish, _id, payload|
         point = payload[:headers].env[::Telegraf::Rack::FIELD_NAME]
         next unless point
@@ -108,6 +112,15 @@ module Telegraf
       end
     end
 
+    initializer 'telegraf.grape' do |app|
+      next unless app.config.telegraf.grape.enabled
+
+      ActiveSupport::Notifications.subscribe(
+        'endpoint_run.grape',
+        Telegraf::Grape.new,
+      )
+    end
+
     initializer 'telegraf.active_job' do |app|
       next unless app.config.telegraf.active_job.enabled
 
@@ -116,8 +129,8 @@ module Telegraf
         Telegraf::ActiveJob.new(
           agent: app.config.telegraf.agent,
           series: app.config.telegraf.active_job.series,
-          tags: app.config.telegraf.active_job.tags
-        )
+          tags: app.config.telegraf.active_job.tags,
+        ),
       )
     end
 
@@ -127,9 +140,11 @@ module Telegraf
       ::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
+            app.config.telegraf.agent,
+            {
+              series: app.config.telegraf.sidekiq.series,
+              tags: app.config.telegraf.sidekiq.tags,
+            }
         end
       end
     end

data/lib/telegraf/sidekiq.rb

@@ -37,10 +37,10 @@ module Telegraf
     #     Only present for "normal" (async) jobs (with tag `type` of "job").
     #
     class Middleware
-      def initialize(agent:, series: 'sidekiq', tags: {})
+      def initialize(agent, options = {})
         @agent = agent
-        @series = series.to_s.freeze
-        @tags = tags.freeze
+        @series = options.fetch(:series, 'sidekiq').to_str.freeze
+        @tags = options.fetch(:tags, {}).to_hash.freeze
       end
 
       def call(worker, job, queue)
@@ -52,11 +52,11 @@ module Telegraf
           errors: true,
           retry: job.key?('retried_at'),
           queue: queue,
-          worker: worker.class.name
+          worker: worker.class.name,
         }
 
         values = {
-          retry_count: job['retry_count']
+          retry_count: job['retry_count'],
         }.compact
 
         # The "enqueued_at" key is not present for scheduled jobs.
@@ -80,7 +80,7 @@ module Telegraf
           values[:app_ms] = (job_stop - job_start) * 1000 # milliseconds
 
           @agent.write(
-            @series, tags: tags, values: values
+            @series, tags: tags, values: values,
           )
         end
       end

data/lib/telegraf/version.rb

@@ -2,11 +2,11 @@
 
 module Telegraf
   module VERSION
-    MAJOR = 1
-    MINOR = 0
-    PATCH = 0
+    MAJOR = 2
+    MINOR = 1
+    PATCH = 1
     STAGE = nil
-    STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze
+    STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.').freeze
 
     def self.to_s
       STRING

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

data/telegraf.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'telegraf/version'
 
@@ -16,6 +15,10 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jgraichen/telegraf-ruby'
   spec.license       = 'LGPLv3'
 
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
+
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -24,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.5'
   spec.add_dependency 'influxdb'
-
   spec.add_development_dependency 'bundler'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegraf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
@@ -46,7 +46,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".github/workflows/lint.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -65,19 +64,23 @@ files:
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/telegraf.rb
 - lib/telegraf/active_job.rb
 - lib/telegraf/agent.rb
+- lib/telegraf/grape.rb
 - lib/telegraf/rack.rb
 - lib/telegraf/rails.rb
 - lib/telegraf/railtie.rb
 - lib/telegraf/sidekiq.rb
 - lib/telegraf/version.rb
+- renovate.json
 - telegraf.gemspec
 homepage: https://github.com/jgraichen/telegraf-ruby
 licenses:
 - LGPLv3
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -86,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Metric Reporter to local telegraf agent

data/.github/workflows/lint.yml

@@ -1,20 +0,0 @@
-name: Lint
-on: [push]
-jobs:
-  rubocop:
-    name: rubocop
-    runs-on: ubuntu-20.04
-
-    env:
-      BUNDLE_WITHOUT: development
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
-
-    steps:
-      - uses: actions/checkout@master
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.7
-          bundler-cache: true
-
-      - run: bundle exec rubocop --parallel --color