activerecord-connection_pool_instrumenter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd5d23f327f81d5a1f2cae36bc88b7a65c86816e792d0405f4ce36f2fd3427ef
-  data.tar.gz: 8f9d3356d36c370a54c753358dba6379d9780c2ed42f18460b20944ac8042449
+  metadata.gz: 118b1e8a5cf9c83767e96e24d40e480c5ce2c28df6975e4d81b2407041cd5ec4
+  data.tar.gz: f7246ca731a40be3845f3febaaf6a788cca80363788afe124368bc9ad07ddd1e
 SHA512:
-  metadata.gz: 3d5ad9fb65cec3e256af887ccda58d95d4b6db3e97b1f06a535a44be522d6fd41f6d1d75f4ec399eaff5d2ec4643e75862419c688ea1a13ccda4944bd898c137
-  data.tar.gz: 278b9044823659f706b591f03611263ac139f2fd1934af00dc585dcaa142049a6404fa0c6e62272f0f08bee3dbcd093ac4e4d7ea02177436294e9bbbe7eadae5
+  metadata.gz: 18bdd9ac3f018f8c976b81a3e93a07caa1f743caab42c24907fa117b6b4449ee63ce5a5c2792a2304a854af7edfc00aedd259284e796135a4af753d9e1656c25
+  data.tar.gz: ce84ece3337bba6463d5ea46ecb57987779b73deba33ee0ed80da8f71cf6bd80cfc25691d5ff298a1c5950895d94b0d12fde7d4cda60d12401a56a35683f08ea

data/README.md

@@ -1,4 +1,4 @@
-# Activerecord::ConnectionPoolInstrumenter
+# ActiveRecord::ConnectionPoolInstrumenter
 
 ## Installation
 
@@ -15,8 +15,8 @@ And then execute `bundle install`
 Include in your application:
 
 ```
-require 'activerecord/connection_pool_instrumenter'
-Activerecord::ConnectionPoolInstrumenter.instrument(statsd: statsd, prefix: 'your_app.db.connection_pool')
+require 'active_record/connection_pool_instrumenter'
+ActiveRecord::ConnectionPoolInstrumenter.instrument(statsd: statsd, prefix: 'your_app.db.connection_pool')
 ```
 
 ## Development

data/Rakefile

@@ -1,2 +1,6 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activerecord-connection_pool_instrumenter.gemspec

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative 'lib/activerecord/connection_pool_instrumenter/version'
+require_relative 'lib/active_record/connection_pool_instrumenter/version'
 
 Gem::Specification.new do |spec|
   spec.name     = 'activerecord-connection_pool_instrumenter'
-  spec.version  = Activerecord::ConnectionPoolInstrumenter::VERSION
+  spec.version  = ActiveRecord::ConnectionPoolInstrumenter::VERSION
   spec.authors  = ['Glia TechMovers']
   spec.email    = ['techmovers@glia.com']
   spec.summary  = 'Metrics about the activerecord connection pool usage'
@@ -15,5 +15,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activerecord'
   spec.add_dependency 'concurrent-ruby', '~> 1.1'
+
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'statsd-ruby', '~> 1.4'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
 end

data/lib/{activerecord → active_record}/connection_pool_instrumenter.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'activerecord/connection_pool_instrumenter/version'
+require 'active_record/connection_pool_instrumenter/version'
 
-module Activerecord
+module ActiveRecord
   module ConnectionPoolInstrumenter
     def self.instrument(
       statsd:,
@@ -13,7 +13,8 @@ module Activerecord
     )
       Concurrent::TimerTask.execute(
         execution_interval: execution_interval,
-        timeout_interval: execution_timeout
+        timeout_interval: execution_timeout,
+        run_now: true
       ) do
         # ActiveRecord::Base.connection_pool.stat returns
         # { size: 15, connections: 1, busy: 1, dead: 0, idle: 0, waiting: 0, checkout_timeout: 5 }

data/lib/{activerecord → active_record}/connection_pool_instrumenter/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module Activerecord
+module ActiveRecord
   module ConnectionPoolInstrumenter
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/spec/active_record/connection_pool_instrumenter_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_record/connection_pool_instrumenter'
+require 'statsd'
+
+RSpec.describe ActiveRecord::ConnectionPoolInstrumenter do
+  let(:prefix) { 'db.test.pool' }
+  let(:connection_pool) { ActiveRecord::Base.connection_pool }
+  let(:statsd) { instance_spy(Statsd) }
+
+  before do
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: 'test.sqlite3')
+  end
+
+  it 'sends DB connection pool metrics as gauges' do
+    %i[size connections busy dead idle waiting].each do |metric|
+      expect(statsd).to receive(:gauge).with("#{prefix}.#{metric}", instance_of(Integer))
+    end
+
+    task = described_class.instrument(
+      connection_pool: connection_pool,
+      statsd: statsd,
+      prefix: prefix,
+      execution_interval: 10.seconds
+    )
+
+    # Small sleep to allow timer thread to execute its code
+    sleep 0.01
+
+    task.shutdown
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-connection_pool_instrumenter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: statsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: 
 email:
 - techmovers@glia.com
@@ -36,8 +92,9 @@ files:
 - README.md
 - Rakefile
 - activerecord-connection_pool_instrumenter.gemspec
-- lib/activerecord/connection_pool_instrumenter.rb
-- lib/activerecord/connection_pool_instrumenter/version.rb
+- lib/active_record/connection_pool_instrumenter.rb
+- lib/active_record/connection_pool_instrumenter/version.rb
+- spec/active_record/connection_pool_instrumenter_spec.rb
 homepage: https://github.com/salemove/activerecord-connection_pool_instrumenter
 licenses: []
 metadata: {}
@@ -60,4 +117,5 @@ rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Metrics about the activerecord connection pool usage
-test_files: []
+test_files:
+- spec/active_record/connection_pool_instrumenter_spec.rb