telegraf 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 132cb999b16a37b5dbb280da213c44c1a227165c0f28a4dcb568a42c6d149033
-  data.tar.gz: 511605f1d7ed94572d4cce1431cc7c48c82b502154d19a1de63ec098b026c177
+  metadata.gz: b2ee7281b9a2894ca1b68ad84e14cf0ddaf1668d6203df4173438d8c137048c4
+  data.tar.gz: 87b415ca608c3c6d70495f1c7cc013a5720361d68d1baaf86b5366180891d92a
 SHA512:
-  metadata.gz: 570b4cafae14dab8ed1d43072366c4df5a4e2ea37862e3643ebd96cc7f556f7a644c9aa60afb2ce7e3b00d1ec8bee78cd8c525390bcd30d64c310ac79769410e
-  data.tar.gz: f595be285d5edaf4c84ba6ed97be15f6097ba747ea493f6f4fef5f15fa604f9a44392b7794c979da06751df081599cd06b3aee5ec54d328c0067e80e4e1320a2
+  metadata.gz: b5fb0d9e6572edee60f78b3ff9ed6e4345be20fd3440dfdcc5b7b983caaa74ef087014d10395aac65034aac071e7d65e886d3f49ac58e5bb50e69352e1e9199d
+  data.tar.gz: c38898a38963a56f148a43a05e9a29ae42072e434ed48c3e741ef2c834940cb2524ede03734ec66078b3c036b52a37f2dfc4059994fc29416e333bc943f14d63

data/.github/workflows/test.yml

@@ -1,26 +1,36 @@
+# 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:
-          - '3.0'
-          - '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.0'
+          - 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:
@@ -38,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

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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)
@@ -34,7 +39,8 @@ 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/v2.0.0...HEAD
+[Unreleased]: https://github.com/jgraichen/telegraf-ruby/compare/v2.1.0...HEAD
+[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

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/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/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)
@@ -91,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
@@ -107,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
 
@@ -115,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
 
@@ -129,7 +143,7 @@ module Telegraf
             app.config.telegraf.agent,
             {
               series: app.config.telegraf.sidekiq.series,
-              tags: app.config.telegraf.sidekiq.tags
+              tags: app.config.telegraf.sidekiq.tags,
             }
         end
       end

data/lib/telegraf/sidekiq.rb

@@ -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

@@ -3,10 +3,10 @@
 module Telegraf
   module VERSION
     MAJOR = 2
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
     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/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: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-01-24 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,9 +64,11 @@ 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
@@ -77,7 +78,8 @@ files:
 homepage: https://github.com/jgraichen/telegraf-ruby
 licenses:
 - LGPLv3
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -86,14 +88,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.22
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Metric Reporter to local telegraf agent

data/.github/workflows/lint.yml

@@ -1,19 +0,0 @@
-on: [push, pull_request]
-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: 3.0
-          bundler-cache: true
-
-      - run: bundle exec rubocop --parallel --color