telegraf 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d24537357d52b68f806f668f2e356a2272f5a2964050051827fed20afcf775b2
-  data.tar.gz: c6cfdaa89a5cd249dc1533c7aedda8237157e9778a42e501cc7d26b439cdcaef
+  metadata.gz: 1992e9545cbbf54646dec6c4830190258a5756d1c536b71a42378ca5c7717eed
+  data.tar.gz: 6e00f1a167a6ac9663903623317fe1d896b882feb5d866eb52385da54603ed09
 SHA512:
-  metadata.gz: '085618264388f4883a978265487b0c5c7659297e4db42c04924281ed96e99fabb0ba20f0d4e4294237e5bed48bbae298a40a5c395e8d3b3ed48d9ac1a1db765a'
-  data.tar.gz: 825e81ddf41b25254b1d6a048223dda4e840a42171303a8080ed27e03d250ff5e130c4e6e348472cd6c3618c9eff848f5db1324e7b04df4d62990addfa214577
+  metadata.gz: 949c16ce2e986feef4362d1060290b64efd01ed08a08222129a59577f22c3a4d643dc80324ede1f27f10dee63fcf0519f4c3386547c67c435418e68634644627
+  data.tar.gz: 8eafa264491cff6861f7b346e3548bf51ef5b570f2779a7b3d31e02dc62c2d8c011c9eeaeda6fc6b0e64ff79fba7ccb839615bb43101fa73f0d177600e18f216

data/.github/workflows/lint.yml

@@ -0,0 +1,20 @@
+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

data/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Test
+on: [push]
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} / ${{ matrix.gemfile }}
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        ruby:
+          - '2.7'
+          - '2.6'
+          - '2.5'
+        gemfile:
+          - rails_5.2.gemfile
+          - rails_6.0.gemfile
+          - rails_6.1.gemfile
+          - rack_2.0.gemfile
+          - rack_2.1.gemfile
+          - rack_2.2.gemfile
+      fail-fast: false
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
+      BUNDLE_WITHOUT: development
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rspec --color --format documentation

data/.rubocop.yml

@@ -1,6 +1,8 @@
 AllCops:
   Include:
-    - '**/*.rb'
+    - "**/*.rb"
+  NewCops: enable
+  SuggestExtensions: false
   TargetRubyVersion: 2.5
 
 
@@ -62,6 +64,9 @@ Style/HashTransformKeys:
 Style/HashTransformValues:
   Enabled: false
 
+Style/IfUnlessModifier:
+  Enabled: false
+
 Style/RescueModifier:
   Exclude:
     - spec/**/*_spec.rb

data/Appraisals

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

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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]
+
+## [1.0.0] - 2021-01-26
+### Added
+- Global tags (#6)
+
 ## [0.8.0] - 2020-12-02
 ### Added
 - ActiveJob instrumentation (#10)
@@ -20,10 +26,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 - New Rack middleware and Rails plugin to collect request events (#5)
 
-## 0.5.0
+## 0.5.0 - undefined
 ### 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
+[Unreleased]: https://github.com/jgraichen/telegraf-ruby/compare/v1.0.0...HEAD
+[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
+[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

@@ -7,7 +7,8 @@ gemspec
 
 gem 'rake'
 gem 'rspec', '~> 3.8'
-gem 'rubocop', '~> 0.80.0'
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-rspec', '~> 1.41'
 
 group :test do
   gem 'rack'

data/README.md

@@ -2,7 +2,7 @@
 
 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.
+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.
 
@@ -51,7 +51,7 @@ 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:
+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:
 
 ### Rack
 
@@ -68,22 +68,32 @@ The Rack middleware supports parsing the `X-Request-Start: t=<timestamp>` header
 
 ### Rails
 
-The Rails plugin needs to required, too, but by default automatically installs required components (Rack, Sidekiq and Rails-specific instrumentation).
+The Rails plugin needs to be required, too, but will automatically install additional components (Rack, ActiveJob, Sidekiq and Rails-specific instrumentation).
 
 ```ruby
 # e.g. in application.rb
 
+# Load rails plugin (!) or add `require: 'telegraf/rails'` to Gemfile
 require "telegraf/rails"
 
 class MyApplication > ::Rails::Application
   # Configure receiver
   config.telegraf.connect = "udp://localhost:9084"
 
+  # Global tags added to all events. These will override
+  # any local tag with the same name.
+  config.telegraf.tags = {}
+
   # 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 ActiveJob is detected
+  config.telegraf.active_job.enabled = true
+  config.telegraf.active_job.series = "active_job"
+  config.telegraf.active_job.tags = {}
+
   # These are the default settings when Sidekiq is detected
   config.telegraf.sidekiq.enabled = true
   config.telegraf.sidekiq.series = "sidekiq"
@@ -104,8 +114,23 @@ requests,action=index,controller=TestController,instance=TestController#index,me
 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)
 - [Sidekiq middleware](lib/telegraf/sidekiq.rb)
 
+### ActiveJob
+
+```ruby
+require "telegraf/active_job"
+
+agent = ::Telegraf::Agent.new
+ActiveSupport::Notifications.subscribe(
+  'perform.active_job',
+  Telegraf::ActiveJob.new(agent: agent, series: 'background', tags: {global: 'tag'})
+)
+```
+
+See plugin [class documentation](lib/telegraf/active_job.rb) for more details.
+
 ### Sidekiq
 
 ```ruby

data/gemfiles/rack_2.0.gemfile

@@ -4,7 +4,8 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 0.80.0"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rspec", "~> 1.41"
 
 group :test do
   gem "rack", "~> 2.0.0"

data/gemfiles/rack_2.1.gemfile

@@ -4,7 +4,8 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 0.80.0"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rspec", "~> 1.41"
 
 group :test do
   gem "rack", "~> 2.1.0"

data/gemfiles/rack_2.2.gemfile

@@ -4,7 +4,8 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 0.80.0"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rspec", "~> 1.41"
 
 group :test do
   gem "rack", "~> 2.2.0"

data/gemfiles/rails_5.2.gemfile

@@ -4,7 +4,8 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 0.80.0"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rspec", "~> 1.41"
 
 group :test do
   gem "rack"

data/gemfiles/rails_6.0.gemfile

@@ -4,7 +4,8 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 0.80.0"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rspec", "~> 1.41"
 
 group :test do
   gem "rack"

data/gemfiles/{rails_5.0.gemfile → rails_6.1.gemfile}

@@ -4,11 +4,12 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "rspec", "~> 3.8"
-gem "rubocop", "~> 0.80.0"
+gem "rubocop", "~> 1.7"
+gem "rubocop-rspec", "~> 1.41"
 
 group :test do
   gem "rack"
-  gem "rails", "~> 5.0.0"
+  gem "rails", "~> 6.1.0"
   gem "sidekiq", "~> 6.0"
 end
 

data/lib/telegraf/agent.rb

@@ -4,11 +4,11 @@ module Telegraf
   class Agent
     DEFAULT_CONNECTION = 'udp://localhost:8094'
 
-    attr_reader :uri
-    attr_reader :logger
+    attr_reader :uri, :logger, :tags
 
-    def initialize(uri = nil, logger: nil)
+    def initialize(uri = nil, logger: nil, tags: {})
       @uri = URI.parse(uri || DEFAULT_CONNECTION)
+      @tags = tags
       @logger = logger
     end
 
@@ -21,6 +21,8 @@ module Telegraf
     end
 
     def write!(data, series: nil, tags: nil, values: nil)
+      tags = tags.merge(@tags) unless @tags.empty?
+
       if values
         data = [{series: series || data.to_s, tags: tags, values: values}]
       end

data/lib/telegraf/rack.rb

@@ -44,7 +44,13 @@ module Telegraf
     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)
       @app = app

data/lib/telegraf/railtie.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rails'
+require 'telegraf'
 require 'telegraf/active_job'
 require 'telegraf/rack'
 require 'telegraf/sidekiq'
@@ -45,6 +46,7 @@ module Telegraf
 
     # Connect URI or tuple
     config.telegraf.connect = ::Telegraf::Agent::DEFAULT_CONNECTION
+    config.telegraf.tags = {}
 
     # Install Rack middlewares
     config.telegraf.rack = ::ActiveSupport::OrderedOptions.new
@@ -71,7 +73,8 @@ module Telegraf
       app.config.telegraf.agent ||= begin
         ::Telegraf::Agent.new \
           app.config.telegraf.connect,
-          logger: Rails.logger
+          logger: Rails.logger,
+          tags: app.config.telegraf.tags
       end
     end
 

data/lib/telegraf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegraf
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
@@ -46,10 +46,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -61,10 +62,9 @@ files:
 - 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
+- gemfiles/rails_6.1.gemfile
 - lib/telegraf.rb
 - lib/telegraf/active_job.rb
 - lib/telegraf/agent.rb
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.4
 signing_key: 
 specification_version: 4
 summary: Metric Reporter to local telegraf agent

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false
-dist: bionic
-language: ruby
-rvm:
-  - 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/gemfiles/rails_5.1.gemfile

@@ -1,20 +0,0 @@
-# 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: "../"