telegraf 2.1.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2506d8a79e471b78413607796219aa467e330bed37f379482ae51f8b3f41d45
-  data.tar.gz: 30202e32e4584499161208af9d1e355bb6b8770d425675738a7b4a3e4cad553d
+  metadata.gz: 3a3db63f503d4b63bc67c09e19f56ea31ad51a3e11fd6e96bb7d4238c09bc98b
+  data.tar.gz: 8389b82b7ab525740074463d83c835fde5ca5b14934705d990b18cbb1cf321fe
 SHA512:
-  metadata.gz: bac63da09a0586326816bb0bf13ec2ca10900af04be4c058f5dd4b524a579ea5752c02573e8b275030dcba8cd66fbcf8b3b96f0e6e7933068ffaffc49197d8e3
-  data.tar.gz: 261d7ef27d1afa299561581d946d85833a1254835ced37f9cf97d7a01e2364a7d43cd65cdfa1fe616216e75382373dcd840d1089751110549c4eb06d4651cf1d
+  metadata.gz: e8e5fa0337d5b0e6754bf7434b875c6e21f330220f9c0a9d7d75a23d1c2dcb86395fdf40279203bab633703247e3152e717d9209a96736c880040ec064716196
+  data.tar.gz: db3bb1afce88c9ab71e4b3f5c10da06abbf7883553a59fcd9db0252d063c047656588afcffda0a79d94fe08dd9b73a2a3090dfe93926ba401e64b921bda8bdc2

data/.github/workflows/maintenance-cache-wipe.yml

@@ -0,0 +1,13 @@
+---
+name: maintenance-cache-clear
+on:
+  schedule:
+    - cron: "0 0 1 * *"
+  workflow_dispatch:
+
+jobs:
+  cache-clear:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: easimon/wipe-cache@v2

data/.github/workflows/maintenance-workflow-cleanup.yml

@@ -0,0 +1,17 @@
+---
+name: maintenance-workflow-cleanup
+on:
+  schedule:
+    - cron: "0 0 1 * *"
+  workflow_dispatch:
+
+jobs:
+  delete-workflow-runs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: Mattraks/delete-workflow-runs@v2
+        with:
+          token: ${{ github.token }}
+          repository: ${{ github.repository }}
+          retain_days: 180
+          keep_minimum_runs: 50

data/.github/workflows/release.yml

@@ -0,0 +1,38 @@
+# vim: ft=yaml
+
+name: release
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  rubygems:
+    if: github.repository == 'jgraichen/telegraf-ruby'
+    runs-on: ubuntu-24.04
+
+    permissions:
+      contents: write
+      id-token: write
+
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 10
+      BUNDLE_WITHOUT: development test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+
+      - uses: rubygems/release-gem@v1
+
+      - uses: taiki-e/create-gh-release-action@v1
+        with:
+          changelog: CHANGELOG.md
+          draft: true
+          token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -1,36 +1,46 @@
 # vim: ft=yaml
 name: test
-on: [push, pull_request]
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
 jobs:
   rspec:
     name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }}
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     strategy:
       matrix:
         ruby:
+          - "3.4"
+          - "3.3"
+          - "3.2"
           - "3.1"
-          - "3.0"
-          - "2.7"
-          - "2.6"
-          - "2.5"
         gemfile:
-          - rails_5.2.gemfile
-          - rails_6.0.gemfile
-          - rails_6.1.gemfile
+          - rails_8.0.gemfile
+          - rails_7.2.gemfile
+          - rails_7.1.gemfile
           - rails_7.0.gemfile
-          - rack_2.0.gemfile
-          - rack_2.1.gemfile
+          - rails_6.1.gemfile
+          - rack_3.gemfile
           - rack_2.2.gemfile
+          - rack_2.1.gemfile
+          - rack_2.0.gemfile
+          - sidekiq_6.gemfile
+          - sidekiq_7.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"
+          - ruby: "3.4"
             gemfile: rails_7.0.gemfile
+          - ruby: "3.4"
+            gemfile: rails_6.1.gemfile
+          - ruby: "3.4"
+            gemfile: rack_2.1.gemfile
+          - ruby: "3.4"
+            gemfile: rack_2.0.gemfile
+          - ruby: "3.1"
+            gemfile: rails_8.0.gemfile
       fail-fast: false
 
     env:
@@ -51,7 +61,7 @@ jobs:
 
   rubocop:
     name: rubocop
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
 
     env:
       BUNDLE_WITHOUT: development
@@ -62,7 +72,7 @@ jobs:
       - uses: actions/checkout@master
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: '3.4'
           bundler-cache: true
 
       - run: bundle exec rubocop --parallel --color

data/.rubocop.yml

@@ -1,11 +1,11 @@
 # vim: ft=yaml
 
 inherit_gem:
-  my-rubocop: default.yml
+  rubocop-config: default.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: "2.7"
   SuggestExtensions: False
 
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Enabled: False

data/Appraisals

@@ -1,20 +1,20 @@
 # frozen_string_literal: true
 
-appraise 'rails-5.2' do
+appraise 'rails-8.0' do
   group :test do
-    gem 'rails', '~> 5.2.0'
+    gem 'rails', '~> 8.0.0'
   end
 end
 
-appraise 'rails-6.0' do
+appraise 'rails-7.2' do
   group :test do
-    gem 'rails', '~> 6.0.0'
+    gem 'rails', '~> 7.2.0'
   end
 end
 
-appraise 'rails-6.1' do
+appraise 'rails-7.1' do
   group :test do
-    gem 'rails', '~> 6.1.0'
+    gem 'rails', '~> 7.1.0'
   end
 end
 
@@ -24,15 +24,15 @@ appraise 'rails-7.0' do
   end
 end
 
-appraise 'rack-2.0' do
+appraise 'rails-6.1' do
   group :test do
-    gem 'rack', '~> 2.0.0'
+    gem 'rails', '~> 6.1.0'
   end
 end
 
-appraise 'rack-2.1' do
+appraise 'rack-3' do
   group :test do
-    gem 'rack', '~> 2.1.0'
+    gem 'rack', '~> 3.0'
   end
 end
 
@@ -41,3 +41,27 @@ appraise 'rack-2.2' do
     gem 'rack', '~> 2.2.0'
   end
 end
+
+appraise 'rack-2.1' do
+  group :test do
+    gem 'rack', '~> 2.1.0'
+  end
+end
+
+appraise 'rack-2.0' do
+  group :test do
+    gem 'rack', '~> 2.0.0'
+  end
+end
+
+appraise 'sidekiq-6' do
+  group :test do
+    gem 'sidekiq', '~> 6.0'
+  end
+end
+
+appraise 'sidekiq-7' do
+  group :test do
+    gem 'sidekiq', '~> 7.0'
+  end
+end

data/CHANGELOG.md

@@ -4,11 +4,25 @@
 
 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]
 
+## [3.1.0] - 2025-01-31
+
+### Added
+
+- Support for Ruby 3.4, Rails 8.0, Rack 3
+
+## [3.0.0] - 2024-03-11
+
+### Added
+
+- New standalone Influx line protocol serializer
+- `before_send` filter option for agent and all plugins (#27)
+
+### Changed
+
+- Require Ruby 2.7+
+
 ## [2.1.1] - 2022-08-23
 
 ### Fixed
@@ -64,7 +78,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Remove `influxdb` not unnecessarily restrict users needing a specific influxdb client.
 
-[unreleased]: https://github.com/jgraichen/telegraf-ruby/compare/v2.1.1...HEAD
+[Unreleased]: https://github.com/jgraichen/telegraf-ruby/compare/v3.1.0...HEAD
+[3.1.0]: https://github.com/jgraichen/telegraf-ruby/compare/v3.0.0...v3.1.0
+[3.0.0]: https://github.com/jgraichen/telegraf-ruby/compare/v2.1.1...v3.0.0
 [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

data/Gemfile

@@ -5,17 +5,20 @@ 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 'rake-release', '~> 1.2'
+
 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'
+  gem 'sidekiq'
 end
 
 group :development do
   gem 'appraisal'
-  gem 'rake-release', '~> 1.2'
 end

data/README.md

@@ -1,13 +1,52 @@
 # 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)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jgraichen/telegraf-ruby/test.yml?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.
 
-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.
+## Examples
+
+<table cellpadding="0">
+  <tr>
+    <td>
+      <a href="./examples/app-perf-light.png">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="./examples/app-perf-dark.png">
+          <img alt="Screenshot of a Grafana dashboard showing overview metrics about the application controllers performance such as slow actions, controller runtime breakdown, total time consumption" src="./examples/app-perf-light.png">
+        </picture>
+      </a>
+    </td>
+    <td>
+      <a href="./examples/controller-dark.png">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="./examples/controller-dark.png">
+          <img alt="Screenshot of a Grafana dashboard showing detailed metrics about an individual controller actions including a flamegraph for request performance" src="./examples/controller-light.png">
+        </picture>
+      </a>
+    </td>
+  </tr>
+  </tr>
+    <td>
+      <a href="./examples/queue-time-light.png">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="./examples/queue-time-dark.png">
+          <img alt="Screenshot of a Grafana dashboard showing detailed queue time metrics including percentiles and median for multiple applications" src="./examples/queue-time-light.png">
+        </picture>
+      </a>
+    </td>
+    <td>
+      <a href="./examples/jobs-light.png">
+        <picture>
+          <source media="(prefers-color-scheme: dark)" srcset="./examples/jobs-dark.png">
+          <img alt="Screenshot of a Grafana dashboard showing metrics about sidekiq background jobs such as runtime and errors" src="./examples/jobs-light.png">
+        </picture>
+      </a>
+    </td>
+  </tr>
+</table>
 
 ## Installation
 
@@ -17,20 +56,23 @@ gem 'telegraf'
 
 And then execute:
 
-    $ bundle
+```console
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install telegraf
+```ruby
+gem install telegraf
+```
 
 ## Usage as a library
 
 Configure telegraf socket listener e.g.:
 
-```
+```toml
 [[inputs.socket_listener]]
   service_address = "udp://localhost:8094"
-
 ```
 
 ```ruby
@@ -48,13 +90,13 @@ telegraf.write([{
 }])
 ```
 
-There is not buffer or batch handling, nor connection pooling or keep alive. Each `#write` creates a new connection (unless it's a datagram connection).
+There is no buffer or batch handling, nor connection pooling or keep alive. Each `#write` creates a new connection (unless it's a datagram connection).
 
 There is no exception handling.
 
 ## Using the Rack and Rails plugins
 
-This gem include a Rails plugin and middlewares / adapters for Rack, ActiveJob and Sidekiq to collect request and background worker events. They need to be explicitly required to be used:
+This gem includes a Rails plugin and middlewares / adapters for Rack, ActiveJob and Sidekiq, to collect request and background worker events. You need to require them explicitly:
 
 ### Rack
 
@@ -110,11 +152,12 @@ end
 
 Received event example:
 
-```
+```text
 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)
 - [ActiveJob plugin](lib/telegraf/active_job.rb)
@@ -142,17 +185,16 @@ 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: 'sidekiq', tags: {global: 'tag'}
+    chain.add ::Telegraf::Sidekiq::Middleware, agent, series: 'sidekiq', tags: {global: 'tag'}
   end
 end
 ```
 
 See middleware [class documentation](lib/telegraf/sidekiq.rb) for more details.
 
-
 ## License
 
-Copyright (C) 2017-2020 Jan Graichen
+Copyright (C) 2017-2024 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/gemfiles/rack_2.0.gemfile

@@ -4,13 +4,13 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 1.7"
-gem "rubocop-rspec", "~> 1.41"
+gem "rspec-github", require: false
+gem "rubocop-config", github: "jgraichen/rubocop-config", tag: "v13"
 
 group :test do
   gem "rack", "~> 2.0.0"
   gem "rails"
-  gem "sidekiq", "~> 6.0"
+  gem "sidekiq"
 end
 
 group :development do

data/gemfiles/rack_2.1.gemfile

@@ -4,13 +4,13 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 1.7"
-gem "rubocop-rspec", "~> 1.41"
+gem "rspec-github", require: false
+gem "rubocop-config", github: "jgraichen/rubocop-config", tag: "v13"
 
 group :test do
   gem "rack", "~> 2.1.0"
   gem "rails"
-  gem "sidekiq", "~> 6.0"
+  gem "sidekiq"
 end
 
 group :development do

data/gemfiles/rack_2.2.gemfile

@@ -4,13 +4,13 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 1.7"
-gem "rubocop-rspec", "~> 1.41"
+gem "rspec-github", require: false
+gem "rubocop-config", github: "jgraichen/rubocop-config", tag: "v13"
 
 group :test do
   gem "rack", "~> 2.2.0"
   gem "rails"
-  gem "sidekiq", "~> 6.0"
+  gem "sidekiq"
 end
 
 group :development do

data/gemfiles/rack_3.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", "~> 3.0"
+  gem "rails"
+  gem "sidekiq"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -4,13 +4,12 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 1.7"
-gem "rubocop-rspec", "~> 1.41"
+gem "rubocop-config", github: "jgraichen/rubocop-config", ref: "v11"
 
 group :test do
   gem "rack"
   gem "rails", "~> 5.2.0"
-  gem "sidekiq", "~> 6.0"
+  gem "sidekiq"
 end
 
 group :development do

data/gemfiles/rails_6.0.gemfile

@@ -4,13 +4,12 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 1.7"
-gem "rubocop-rspec", "~> 1.41"
+gem "rubocop-config", github: "jgraichen/rubocop-config", ref: "v11"
 
 group :test do
   gem "rack"
   gem "rails", "~> 6.0.0"
-  gem "sidekiq", "~> 6.0"
+  gem "sidekiq"
 end
 
 group :development do

data/gemfiles/rails_6.1.gemfile

@@ -4,13 +4,13 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 1.7"
-gem "rubocop-rspec", "~> 1.41"
+gem "rspec-github", require: false
+gem "rubocop-config", github: "jgraichen/rubocop-config", tag: "v13"
 
 group :test do
   gem "rack"
   gem "rails", "~> 6.1.0"
-  gem "sidekiq", "~> 6.0"
+  gem "sidekiq"
 end
 
 group :development do

data/gemfiles/rails_7.0.gemfile

@@ -4,13 +4,13 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 1.7"
-gem "rubocop-rspec", "~> 1.41"
+gem "rspec-github", require: false
+gem "rubocop-config", github: "jgraichen/rubocop-config", tag: "v13"
 
 group :test do
   gem "rack"
   gem "rails", "~> 7.0.0"
-  gem "sidekiq", "~> 6.0"
+  gem "sidekiq"
 end
 
 group :development do

data/gemfiles/rails_7.1.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", "~> 7.1.0"
+  gem "sidekiq"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"

data/gemfiles/rails_7.2.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", "~> 7.2.0"
+  gem "sidekiq"
+end
+
+group :development do
+  gem "appraisal"
+  gem "rake-release", "~> 1.2"
+end
+
+gemspec path: "../"