telegraf 2.1.1 → 3.1.0

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rspec-github", require: false
+gem "rubocop-config", github: "jgraichen/rubocop-config", tag: "v13"
+
+group :test do
+  gem "rack"
+  gem "rails", "~> 8.0.0"
+  gem "sidekiq"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq_6.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rspec-github", require: false
+gem "rubocop-config", github: "jgraichen/rubocop-config", tag: "v13"
+
+group :test do
+  gem "rack"
+  gem "rails"
+  gem "sidekiq", "~> 6.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq_7.gemfile

@@ -0,0 +1,21 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "rspec", "~> 3.8"
+gem "rspec-github", require: false
+gem "rubocop-config", github: "jgraichen/rubocop-config", tag: "v13"
+
+group :test do
+  gem "rack"
+  gem "rails"
+  gem "sidekiq", "~> 7.0"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/lib/telegraf/active_job.rb

@@ -24,17 +24,16 @@ module Telegraf
   #     Total job processing time.
   #
   class ActiveJob
-    def initialize(agent:, series: 'active_job', tags: {})
-      @agent = agent
-      @series = series.to_s.freeze
-      @tags = tags.freeze
+    include Plugin
+
+    def initialize(series: 'active_job', **kwargs)
+      super
     end
 
     def call(_name, start, finish, _id, payload)
       job = payload[:job]
 
-      @agent.write(
-        @series,
+      point = Point.new(
         tags: {
           **@tags,
           job: job.class.name,
@@ -45,6 +44,8 @@ module Telegraf
           app_ms: ((finish - start) * 1000.0), # milliseconds
         },
       )
+
+      _write(point, before_send_kwargs: {payload: payload})
     end
   end
 end

data/lib/telegraf/agent.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
+require 'uri'
+require 'telegraf/serializer'
+
 module Telegraf
   class Agent
     DEFAULT_CONNECTION = 'udp://localhost:8094'
 
     attr_reader :uri, :logger, :tags
 
-    def initialize(uri = nil, logger: nil, tags: {})
+    def initialize(uri = nil, logger: nil, tags: {}, before_send: nil)
       @uri = URI.parse(uri || DEFAULT_CONNECTION)
       @tags = tags
       @logger = logger
+      @serializer = Serializer.new
+      @before_send = before_send
     end
 
     def write(*args, **kwargs)
@@ -27,20 +32,19 @@ module Telegraf
         data = [{series: series || data.to_s, tags: tags, values: values.dup}]
       end
 
+      if @before_send
+        data = @before_send.call(data)
+        return unless data
+      end
+
       socket = connect @uri
-      socket.write dump data
+      socket.write(@serializer.dump_all(data))
     ensure
       socket&.close
     end
 
     private
 
-    def dump(data)
-      data.each.map do |point|
-        ::InfluxDB::PointValue.new(point).dump
-      end.join("\n")
-    end
-
     def connect(uri)
       case uri.scheme.downcase
         when 'unix'

data/lib/telegraf/plugin.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module Telegraf
+  module Plugin
+    # Warning: `:values` member overrides `Struct#values` and it may be
+    # unexpected, but nothing we can change here as this is an import public API
+    # right now.
+    #
+    # rubocop:disable Lint/StructNewOverride
+    Point = Struct.new(:tags, :values, keyword_init: true) do
+      def initialize(tags: {}, values: {})
+        super
+      end
+    end
+    # rubocop:enable Lint/StructNewOverride
+
+    def initialize(agent:, series:, tags: {}, before_send: nil, **)
+      @agent = agent
+
+      @tags = tags.freeze
+      @series = String(series).freeze
+      @before_send = before_send
+    end
+
+    def _write(point, before_send_kwargs: {})
+      if @before_send
+        point = @before_send.call(point, **before_send_kwargs)
+        return unless point
+      end
+
+      @agent.write(@series, tags: point.tags, values: point.values)
+    end
+  end
+end

data/lib/telegraf/rack.rb

@@ -41,22 +41,15 @@ module Telegraf
   #     contain a floating point timestamp in seconds.
   #
   class Rack
+    include ::Telegraf::Plugin
+
     FIELD_NAME = 'telegraf.rack.point'
     HEADER_REGEX = /t=(\d+(\.\d+)?)/.freeze
 
-    # Warning: `:values` member overrides `Struct#values` and it may be
-    # unexpected, but nothing we can change here as this is an import public API
-    # right now.
-    #
-    # rubocop:disable Lint/StructNewOverride
-    Point = Struct.new(:tags, :values)
-    # rubocop:enable Lint/StructNewOverride
+    def initialize(app, agent:, series: 'rack', tags: {}, logger: nil, before_send: nil) # rubocop:disable Metrics/ParameterLists
+      super(agent: agent, series: series, tags: tags, before_send: before_send)
 
-    def initialize(app, agent:, series: 'rack', tags: {}, logger: nil)
       @app = app
-      @tags = tags.freeze
-      @agent = agent
-      @series = series.to_s.freeze
       @logger = logger
     end
 
@@ -66,7 +59,7 @@ module Telegraf
       end
 
       rack_start = ::Rack::Utils.clock_time
-      point = env[FIELD_NAME] = Point.new(@tags.dup, {})
+      point = env[FIELD_NAME] = Point.new(tags: @tags.dup)
       point.values[:queue_ms] = queue_ms if queue_ms
 
       begin
@@ -74,13 +67,13 @@ module Telegraf
           status, headers, body = @app.call(env)
         ensure
           point.tags[:status] ||= status || -1
-          point.values[:app_ms] = \
+          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] = \
+          point.values[:send_ms] =
             (::Rack::Utils.clock_time - send_start) * 1000 # milliseconds
 
           finish(env, point, rack_start)
@@ -95,10 +88,10 @@ module Telegraf
     private
 
     def finish(env, point, rack_start)
-      point.values[:request_ms] = \
+      point.values[:request_ms] =
         (::Rack::Utils.clock_time - rack_start) * 1000 # milliseconds
 
-      @agent.write(@series, tags: point.tags, values: point.values)
+      _write(point, before_send_kwargs: {request: ::Rack::Request.new(env)})
     rescue StandardError => e
       (@logger || env[::Rack::RACK_LOGGER])&.error(e)
     end

data/lib/telegraf/railtie.rb

@@ -48,12 +48,14 @@ module Telegraf
     # Connect URI or tuple
     config.telegraf.connect = ::Telegraf::Agent::DEFAULT_CONNECTION
     config.telegraf.tags = {}
+    config.telegraf.before_send = nil
 
     # Install Rack middlewares
     config.telegraf.rack = ::ActiveSupport::OrderedOptions.new
     config.telegraf.rack.enabled = true
     config.telegraf.rack.series = 'requests'
     config.telegraf.rack.tags = {}
+    config.telegraf.rack.before_send = nil
 
     # Install request instrumentation
     config.telegraf.instrumentation = true
@@ -67,29 +69,37 @@ module Telegraf
     config.telegraf.active_job.enabled = defined?(::ActiveJob)
     config.telegraf.active_job.series = 'active_job'
     config.telegraf.active_job.tags = {}
+    config.telegraf.active_job.before_send = nil
 
     # Install Sidekiq middleware
     config.telegraf.sidekiq = ::ActiveSupport::OrderedOptions.new
     config.telegraf.sidekiq.enabled = defined?(::Sidekiq)
     config.telegraf.sidekiq.series = 'sidekiq'
     config.telegraf.sidekiq.tags = {}
+    config.telegraf.sidekiq.before_send = nil
 
     initializer 'telegraf.agent' do |app|
-      app.config.telegraf.agent ||= \
-        ::Telegraf::Agent.new \
+      app.config.telegraf.agent ||=
+        ::Telegraf::Agent.new(
           app.config.telegraf.connect,
+          before_send: app.config.telegraf.before_send,
           logger: Rails.logger,
-          tags: app.config.telegraf.tags
+          tags: app.config.telegraf.tags,
+        )
     end
 
     initializer 'telegraf.rack' do |app|
       next unless app.config.telegraf.rack.enabled
 
-      app.config.middleware.insert 0, Telegraf::Rack, \
+      app.config.middleware.insert(
+        0,
+        Telegraf::Rack,
         agent: app.config.telegraf.agent,
+        before_send: app.config.telegraf.rack.before_send,
+        logger: Rails.logger,
         series: app.config.telegraf.rack.series,
         tags: app.config.telegraf.rack.tags,
-        logger: Rails.logger
+      )
     end
 
     initializer 'telegraf.instrumentation' do |app|
@@ -128,6 +138,7 @@ module Telegraf
         'perform.active_job',
         Telegraf::ActiveJob.new(
           agent: app.config.telegraf.agent,
+          before_send: app.config.telegraf.active_job.before_send,
           series: app.config.telegraf.active_job.series,
           tags: app.config.telegraf.active_job.tags,
         ),
@@ -139,9 +150,10 @@ module Telegraf
 
       ::Sidekiq.configure_server do |config|
         config.server_middleware do |chain|
-          chain.add Telegraf::Sidekiq::Middleware, \
+          chain.add Telegraf::Sidekiq::Middleware,
             app.config.telegraf.agent,
             {
+              before_send: app.config.telegraf.sidekiq.before_send,
               series: app.config.telegraf.sidekiq.series,
               tags: app.config.telegraf.sidekiq.tags,
             }

data/lib/telegraf/serializer.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Telegraf
+  class Serializer
+    QUOTE_SERIES = /[ ,]/.freeze
+    QUOTE_TAG_KEY = /[ ,=]/.freeze
+    QUOTE_TAG_VALUE = /[ ,=]/.freeze
+    QUOTE_FIELD_KEY = /[ ,="]/.freeze
+    QUOTE_FIELD_VALUE = /[\\"]/.freeze
+    QUOTE_REPLACE = /[\t\r\n]+/.freeze
+
+    def dump_all(points)
+      points
+        .each
+        .filter_map {|point| dump(point) }
+        .join("\n")
+    end
+
+    def dump(point)
+      series = quote(point[:series], QUOTE_SERIES)
+      return '' if series.empty?
+
+      values = point.fetch(:values).filter_map do |key, value|
+        k = quote(key.to_s, QUOTE_FIELD_KEY)
+        v = encode_value(value)
+        next if k.empty? || v.nil?
+
+        "#{k}=#{v}"
+      end
+      return '' if values.empty?
+
+      tags = point[:tags]&.filter_map do |key, value|
+        k = quote(key.to_s, QUOTE_TAG_KEY)
+        v = quote(value.to_s, QUOTE_TAG_VALUE)
+        next if k.empty? || v.empty?
+
+        "#{k}=#{v}"
+      end
+
+      StringIO.new.tap do |io|
+        io << series
+        io << ',' << tags.sort.join(',') if !tags.nil? && tags.any?
+        io << ' ' << values.sort.join(',')
+      end.string
+    end
+
+    private
+
+    def encode_value(val)
+      if val.nil?
+        nil
+      elsif val.is_a?(Integer)
+        "#{val}i"
+      elsif val.is_a?(Numeric)
+        if val.nan? || val.infinite?
+          nil
+        else
+          val.to_s
+        end
+      else
+        "\"#{quote(val.to_s, QUOTE_FIELD_VALUE)}\""
+      end
+    end
+
+    def quote(str, rule)
+      str
+        .encode('UTF-8', 'UTF-8', invalid: :replace, undef: :replace, replace: '')
+        .gsub(QUOTE_REPLACE, ' ')
+        .gsub(rule) {|c| "\\#{c}" }
+    end
+  end
+end

data/lib/telegraf/sidekiq.rb

@@ -37,51 +37,55 @@ module Telegraf
     #     Only present for "normal" (async) jobs (with tag `type` of "job").
     #
     class Middleware
+      include ::Telegraf::Plugin
+
       def initialize(agent, options = {})
-        @agent = agent
-        @series = options.fetch(:series, 'sidekiq').to_str.freeze
-        @tags = options.fetch(:tags, {}).to_hash.freeze
+        options[:series] ||= 'sidekiq'
+
+        super(
+          **options,
+          agent: agent
+        )
       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
+        point = Point.new(
+          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
+          point.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')
+        point.tags[:type] = 'scheduled_job' if job.key?('at')
 
         begin
           yield
 
           # If we get here, this was a successful execution
-          tags[:errors] = false
+          point.tags[:errors] = false
         ensure
           job_stop = ::Time.now.utc
 
-          values[:app_ms] = (job_stop - job_start) * 1000 # milliseconds
+          point.values[:app_ms] = (job_stop - job_start) * 1000 # milliseconds
 
-          @agent.write(
-            @series, tags: tags, values: values,
-          )
+          _write(point, before_send_kwargs: {worker: worker, job: job, queue: queue})
         end
       end
     end

data/lib/telegraf/version.rb

@@ -2,9 +2,9 @@
 
 module Telegraf
   module VERSION
-    MAJOR = 2
+    MAJOR = 3
     MINOR = 1
-    PATCH = 1
+    PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.').freeze
 

data/lib/telegraf.rb

@@ -2,8 +2,7 @@
 
 require 'telegraf/version'
 
-require 'influxdb'
-
 module Telegraf
   require 'telegraf/agent'
+  require 'telegraf/plugin'
 end

data/renovate.json5

@@ -0,0 +1,6 @@
+{
+  $schema: "https://docs.renovatebot.com/renovate-schema.json",
+  extends: [
+    "local>jgraichen/renovate-config"
+  ]
+}

data/telegraf.gemspec

@@ -27,7 +27,5 @@ 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'
+  spec.required_ruby_version = '>= 2.7'
 end

metadata

@@ -1,43 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegraf
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Jan Graichen
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: influxdb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2025-01-31 00:00:00.000000000 Z
+dependencies: []
 description: Metric Reporter to local telegraf agent
 email:
 - jgraichen@altimos.de
@@ -46,6 +17,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/maintenance-cache-wipe.yml"
+- ".github/workflows/maintenance-workflow-cleanup.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -58,30 +32,45 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/app-perf-dark.png
+- examples/app-perf-light.png
+- examples/controller-dark.png
+- examples/controller-light.png
+- examples/jobs-dark.png
+- examples/jobs-light.png
+- examples/queue-time-dark.png
+- examples/queue-time-light.png
 - gemfiles/rack_2.0.gemfile
 - gemfiles/rack_2.1.gemfile
 - gemfiles/rack_2.2.gemfile
+- gemfiles/rack_3.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
+- gemfiles/sidekiq_6.gemfile
+- gemfiles/sidekiq_7.gemfile
 - lib/telegraf.rb
 - lib/telegraf/active_job.rb
 - lib/telegraf/agent.rb
 - lib/telegraf/grape.rb
+- lib/telegraf/plugin.rb
 - lib/telegraf/rack.rb
 - lib/telegraf/rails.rb
 - lib/telegraf/railtie.rb
+- lib/telegraf/serializer.rb
 - lib/telegraf/sidekiq.rb
 - lib/telegraf/version.rb
-- renovate.json
+- renovate.json5
 - telegraf.gemspec
 homepage: https://github.com/jgraichen/telegraf-ruby
 licenses:
 - LGPLv3
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -89,15 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Metric Reporter to local telegraf agent
 test_files: []

data/renovate.json

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