puma-plugin-telemetry 1.1.1 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b31aee911567917f13e7f977ddeef8151bf77e0ce4c42c3d55cacb72e484282
-  data.tar.gz: 7d77fce9892123332269b790e99f3304b3ed6f964a2c6693e8490e32b1e90aa7
+  metadata.gz: d8f6637e84f006fba6caefa5187fcd41670978d92272702e70c2f93f4f146660
+  data.tar.gz: 1114593461807d980f4f8070e02d0a9ccafd60be819aae580d33924e3b0617c7
 SHA512:
-  metadata.gz: ab0213de9d5ab7501e073fe4741ab6c2d5d42789ca9373e33833e86312c3414ee22376192d97a7c45d0c84df429202d2ba0feb7f410daf947fdb660e0e5d2322
-  data.tar.gz: 63cb99867fef6f6f5f491bf37634b1dcdf17e5c5f279c9f032c164bb24887f85a193258e88511b7112be9a4539db4460a8910f3f9332d783fb168cf92eab7406
+  metadata.gz: 1b6a6aa3e7bb56b54a40f01ced4d3b228ae0ccd94195a460307b13ebff6a3f4fe3f13ec748d5486d9878691c7696aadd1aeafa84b02baa9b232772e5e21e405b
+  data.tar.gz: fb02f9fc3f1e278ed8e72f745a9153a54537bafd8a1e0e28035caf7ac1dc29102f7c8c66250145b325ec6c0c174de7146ad84451773ca44321f4b086044ef321

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.6
+ruby 2.6.10

data/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.4]
+
+### Changed
+- Updated gems in the lockfile
+
+## [1.1.3]
+
+### Changed
+- Updated gems in the lockfile
+
+### Added
+- Support for Ruby 3.2 and 3.3
+
+### Dropped
+- Check for support for 'ubuntu-18.04'
+
+## [1.1.2]
+
+- Add Puma 6 compatibility
 ## [1.1.1]
 
 Public release.

data/README.md

@@ -2,7 +2,7 @@
 
 Puma plugin which should be able to handle all your metric needs regarding your webserver:
 
-- ability to publish basic puma statistics (like queue backlog) to both logs and datadog
+- ability to publish basic puma statistics (like queue backlog) to both logs and Datadog
 - ability to add custom target whenever you need it
 - ability to monitor puma socket listen queue (!)
 - ability to report requests queue time via custom rack middleware - the time request spent between being accepted by Load Balancer and start of its processing by Puma worker
@@ -17,11 +17,15 @@ gem "puma-plugin-telemetry"
 
 And then execute:
 
-    $ bundle install
+```console
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install puma-plugin-telemetry
+```console
+$ gem install puma-plugin-telemetry
+```
 
 ## Usage
 
@@ -39,15 +43,15 @@ end
 
 ### Basic
 
-Output telemetry as JSON to STDOUT
+Output telemetry as JSON to `STDOUT`
 
 ```ruby
   config.add_target :io
 ```
 
-### Datadog statsd target
+### Datadog StatsD target
 
-Given gem provides built in target for Datadog Statsd client, that uses batch operation to publish metrics.
+Given gem provides built in target for Datadog StatsD client, that uses batch operation to publish metrics.
 
 **NOTE** Be sure to have `dogstatsd` gem installed.
 
@@ -76,7 +80,7 @@ end
 
 ### Custom Targets
 
-Target is a simple object that implements `call` methods that accepts `telemetry` hash object. This means it can be super simple `proc` or some sofisticated class calling some external API.
+Target is a simple object that implements `call` methods that accepts `telemetry` hash object. This means it can be super simple `proc` or some sophisticated class calling some external API.
 
 Just be mindful that if the API takes long to call, it will slow down frequency with which telemetry will get reported.
 
@@ -87,7 +91,7 @@ Just be mindful that if the API takes long to call, it will slow down frequency
 
 ## Extra middleware
 
-This gems comes together with middleware for measuring request queue time, which will be reported in `request.env` and published to given statsd client.
+This gems comes together with middleware for measuring request queue time, which will be reported in `request.env` and published to given StatsD client.
 
 Example configuration:
 
@@ -110,7 +114,7 @@ This will provide proper metric in Datadog and in logs as well. Logs can be tran
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 

data/lib/puma/plugin/telemetry/version.rb

@@ -3,7 +3,7 @@
 module Puma
   class Plugin
     module Telemetry
-      VERSION = '1.1.1'
+      VERSION = '1.1.4'
     end
   end
 end

data/lib/puma/plugin/telemetry.rb

@@ -63,13 +63,14 @@ module Puma
       #
       module PluginInstanceMethods
         def start(launcher)
+          @launcher = launcher
+
           unless Puma::Plugin::Telemetry.config.enabled?
-            launcher.events.log 'plugin=telemetry msg="disabled, exiting..."'
+            log_writer.log 'plugin=telemetry msg="disabled, exiting..."'
             return
           end
 
-          @launcher = launcher
-          @launcher.events.log 'plugin=telemetry msg="enabled, setting up runner..."'
+          log_writer.log 'plugin=telemetry msg="enabled, setting up runner..."'
 
           in_background do
             sleep Puma::Plugin::Telemetry.config.initial_delay
@@ -79,13 +80,13 @@ module Puma
 
         def run!
           loop do
-            @launcher.events.debug 'plugin=telemetry msg="publish"'
+            log_writer.debug 'plugin=telemetry msg="publish"'
 
             call(Puma::Plugin::Telemetry.build(@launcher))
           rescue Errno::EPIPE
             # Occurs when trying to output to STDOUT while puma is shutting down
           rescue StandardError => e
-            @launcher.events.error "plugin=telemetry err=#{e.class} msg=#{e.message.inspect}"
+            log_writer.error "plugin=telemetry err=#{e.class} msg=#{e.message.inspect}"
           ensure
             sleep Puma::Plugin::Telemetry.config.frequency
           end
@@ -96,6 +97,16 @@ module Puma
             target.call(telemetry)
           end
         end
+
+        private
+
+        def log_writer
+          if Puma::Const::PUMA_VERSION.to_i < 6
+            @launcher.events
+          else
+            @launcher.log_writer
+          end
+        end
       end
     end
   end

data/puma-plugin-telemetry.gemspec

@@ -33,11 +33,14 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ spec/ .git .github Gemfile])
+    end
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'puma', '>= 5.0'
+  spec.add_dependency 'puma', '< 7'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puma-plugin-telemetry
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.4
 platform: ruby
 authors:
 - Leszek Zalewski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-22 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
 description: |
   Puma plugin which should be able to handle all your metric needs regarding your webserver:
 
@@ -37,21 +37,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/workflows/build.yml"
-- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - docs/example-datadog_backlog_size.png
 - docs/example-datadog_queue_time.png
 - docs/examples.md
@@ -87,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Puma plugin, adding ability to publish various metrics to your prefered targets.

data/.github/CODEOWNERS

@@ -1,6 +0,0 @@
-# Individuals and teams that are responsible for code in the repository.
-#
-# Read more at https://help.github.com/en/articles/about-code-owners
-
-*   @babbel/tnt
-*   @driv3r

data/.github/workflows/build.yml

@@ -1,63 +0,0 @@
-name: build
-
-on: [push, create]
-
-jobs:
-  build_matrix:
-    strategy:
-      matrix:
-        os: ['ubuntu-18.04', 'ubuntu-20.04']
-        ruby: ['2.6', '2.7', '3.0', '3.1']
-
-    runs-on: ${{ matrix.os }}
-
-    steps:
-      # Environment setup
-      - uses: actions/checkout@v3
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Run rubocop
-        run: |
-          bundle exec rubocop --display-cop-names
-
-      - name: Run tests
-        run: |
-          bundle exec rspec
-
-  build:
-    needs: [build_matrix]
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Dummy for branch status checks
-        run: |
-          echo "build complete"
-
-  release:
-    runs-on: ubuntu-20.04
-
-    needs:
-      - build
-
-    if: github.event_name == 'create' && startsWith(github.ref, 'refs/tags/v')
-
-    steps:
-      - uses: actions/checkout@v3
-      - uses: ruby/setup-ruby@v1
-
-      - name: Create credentials
-        run: |
-          mkdir -p ~/.gem
-          cat << EOF > ~/.gem/credentials
-          ---
-          :rubygems_api_key: ${{ secrets.RUBYGEMS_TOKEN }}
-          EOF
-          chmod 0600 /home/runner/.gem/credentials
-
-      - name: Publish gem
-        run: |
-          gem build puma-plugin-telemetry.gemspec
-          gem push puma-plugin-telemetry-*.gem

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in puma-plugin-telemetry.gemspec
-gemspec
-
-gem 'dogstatsd-ruby'
-
-gem 'rack'
-gem 'rake', '~> 12.0'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.5'
-gem 'rubocop-performance', '~> 1.9'

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    puma-plugin-telemetry (1.1.1)
-      puma (>= 5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.0)
-    dogstatsd-ruby (5.5.0)
-    nio4r (2.5.8)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    puma (5.6.4)
-      nio4r (~> 2.0)
-    rack (2.2.3.1)
-    rainbow (3.1.1)
-    rake (12.3.3)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.30.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.14.2)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  dogstatsd-ruby
-  puma-plugin-telemetry!
-  rack
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.5)
-  rubocop-performance (~> 1.9)
-
-BUNDLED WITH
-   2.1.4

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'puma/plugin/telemetry'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here