yabeda-activerecord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c70f9b0924926fec4e5346d38bc65a9a821260d8904926c88a8584b050c93c7
+  data.tar.gz: 60808116a424d5852d037995bd14040c2f0cc758c242faa4a8e4381898b45685
+SHA512:
+  metadata.gz: a11ba38c80c349b9ad490b1908a7915fb716b9e01a653ad8553bbdcb3738b46e7af71ad6c764b346097d467cdaa5781c33dddf19c4112e410603e7f611148d90
+  data.tar.gz: c31e9c3628b8d19c04b90aaada7bb86f4d9069a75dbde92f5af0ebe7cb4258401efb6939914e5b6cfd77951ec168c239b370f820aa5b1d646fa5ae5ea2f809dc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Metrics/BlockLength:
+  Enabled: false
+
+Bundler/DuplicatedGem:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Unreleased
+
+## 0.1.0 - 2022-05-27
+
+- Initial release: query performance metrics and connection pool stats. [@Envek][]
+
+[@Envek]: https://github.com/Envek/ "Andrey Novikov"

data/Gemfile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yabeda-activerecord.gemspec
+gemspec
+
+yabeda_version = ENV.fetch("YABEDA_VERSION", "~> 0.11")
+
+case yabeda_version
+when "HEAD"
+  gem "yabeda", git: "https://github.com/yabeda-rb/yabeda"
+else
+  yabeda_version = "~> #{yabeda_version}.0" if yabeda_version.match?(/^\d+\.\d+$/)
+  gem "yabeda", yabeda_version
+end
+
+activerecord_version = ENV.fetch("ACTIVERECORD_VERSION", "~> 7.0")
+case activerecord_version
+when "HEAD"
+  git "https://github.com/rails/rails.git" do
+    gem "activerecord"
+    gem "rails"
+  end
+else
+  activerecord_version = "~> #{activerecord_version}.0" if activerecord_version.match?(/^\d+\.\d+$/)
+  gem "activerecord", activerecord_version
+end
+
+gem "sqlite3"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.30"
+
+gem "debug"

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    yabeda-activerecord (0.1.0)
+      activerecord (>= 6.0)
+      yabeda (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    anyway_config (2.3.0)
+      ruby-next-core (>= 0.14.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    debug (1.5.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    diff-lcs (1.5.0)
+    dry-initializer (3.1.1)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.4.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    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.0)
+      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)
+    ruby-next-core (0.15.1)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    yabeda (0.11.0)
+      anyway_config (>= 1.0, < 3)
+      concurrent-ruby
+      dry-initializer
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 7.0)
+  debug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.30)
+  sqlite3
+  yabeda (~> 0.11)
+  yabeda-activerecord!
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Andrey Novikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# ![`Yabeda::ActiveRecord`](./yabeda-activerecord-logo.png)
+
+[![Gem Version](https://badge.fury.io/rb/yabeda-activerecord.svg)](https://rubygems.org/gems/yabeda-activerecord)
+[![Tests status](https://github.com/yabeda-rb/yabeda-activerecord/actions/workflows/test.yml/badge.svg)](https://github.com/yabeda-rb/yabeda-activerecord/actions/workflows/test.yml)
+
+[Yabeda] plugin to collect essential metrics for database query performance and connection pool stats. 
+
+<a href="https://evilmartians.com/?utm_source=yabeda-activerecord">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://evilmartians.com/badges/sponsored-by-evil-martians_v2.0_for-dark-bg@2x.png">
+  <img alt="Sponsored by Evil Martians" src="https://evilmartians.com/badges/sponsored-by-evil-martians_v2.0@2x.png" width="236" height="54">
+</picture>
+</a>
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add yabeda-activerecord
+
+Launch/restart your application and that's it: metrics are being collected.
+
+To expose metrics Don't forget to also add one of [Yabeda adapters](https://github.com/yabeda-rb/yabeda#available-monitoring-system-adapters) to your Gemfile. 
+
+## Metrics
+
+### Query performance 
+| Metric            | Type        | Tags                        | Description                                                        |
+|-------------------|-------------|-----------------------------|--------------------------------------------------------------------|
+| `queries_total`   | counter     | config, kind, cached, async | Total number of SQL queries issued by application via ActiveRecord |
+| `query_duration`  | histogram   | config, kind, cached, async | Duration for SQL queries generated by ActiveRecord                 |
+
+### Connection pool stats
+
+| Metric                             | Type  | Tags   | Description                                                                                                                                                                |
+|------------------------------------|-------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `connection_pool_size`             | gauge | config | Connection pool size                                                                                                                                                       |
+| `connection_pool_connections`      | gauge | config | Total number of connections currently created in the pool (sum of busy, dead, and idle).                                                                                   |
+| `connection_pool_busy`             | gauge | config | Number of connections that has been checked out by some thread and are in use now.                                                                                         |
+| `connection_pool_dead`             | gauge | config | Number of lost connections for the pool. A lost connection can occur if a programmer forgets to checkin a connection at the end of a thread or a thread dies unexpectedly. |
+| `connection_pool_idle`             | gauge | config | Number of free connections, that are available for checkout.                                                                                                               |
+| `connection_pool_waiting`          | gauge | config | Number of threads waiting for a connection to become available for checkout.                                                                                               |
+| `connection_pool_checkout_timeout` | gauge | config | Checkout waiting timeout in seconds                                                                                                                                        |
+
+### Tags
+
+ - `config` — database configuration name in the `database.yml`
+ - `kind` — query kind, usually referring to action over model. E.g. `Post Load`
+ - `cached` — `true` if query wasn't executed against the database, results was retrieved from in-memory cache.
+ - `async` — `true` if query was loaded in background via [`load_async`](https://api.rubyonrails.org/classes/ActiveRecord/Relation.html#method-i-load_async) 
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-activerecord.
+
+### Releasing
+
+1. Bump version number in `lib/yabeda/activerecord/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::ActiveRecord::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/yabeda/active_record/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/active_record/version.rb -e "puts Gem::Version.new(Yabeda::ActiveRecord::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda-rb/yabeda-activerecord.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[Yabeda]: https://github.com/yabeda-rb/yabeda "Extendable framework for collecting and exporting metrics from your Ruby application"

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/yabeda/active_record/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module ActiveRecord
+    VERSION = "0.1.0"
+  end
+end

data/lib/yabeda/active_record.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "yabeda"
+require "active_record"
+
+require_relative "active_record/version"
+
+module Yabeda
+  # ActiveRecord Yabeda plugin to collect metrics for query performance, connection pool stats, etc
+  module ActiveRecord
+    class Error < StandardError; end
+
+    LONG_RUNNING_QUERY_RUNTIME_BUCKETS = [
+      0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard (from Prometheus)
+      30, 60, 120, 300, 1800, 3600, 21_600, # Well, sometime queries can execute way too long
+    ].freeze
+
+    # rubocop: disable Layout/LineLength
+    Yabeda.configure do
+      group :activerecord do
+        counter   :queries_total, tags: %i[config kind cached async],
+                                  comment: "Total number of SQL queries issued by application via ActiveRecord"
+        histogram :query_duration, tags: %i[config kind cached async],
+                                   unit: :seconds, buckets: LONG_RUNNING_QUERY_RUNTIME_BUCKETS,
+                                   comment: "Duration of SQL queries generated by ActiveRecord"
+
+        gauge :connection_pool_size,
+              tags: %i[config],
+              comment: "Connection pool size"
+        gauge :connection_pool_connections,
+              tags: %i[config],
+              comment: "Total number of connections currently created in the pool (sum of busy, dead, and idle)."
+        gauge :connection_pool_busy,
+              tags: %i[config],
+              comment: "Number of connections that has been checked out by some thread and are in use now."
+        gauge :connection_pool_dead,
+              tags: %i[config],
+              comment: "Number of lost connections for the pool. A lost connection can occur if a programmer forgets to checkin a connection at the end of a thread or a thread dies unexpectedly."
+        gauge :connection_pool_idle,
+              tags: %i[config],
+              comment: "Number of free connections, that are available for checkout."
+        gauge :connection_pool_waiting,
+              tags: %i[config],
+              comment: "Number of threads waiting for a connection to become available for checkout."
+        gauge :connection_pool_checkout_timeout,
+              tags: %i[config],
+              unit: :seconds,
+              comment: "Checkout waiting timeout in seconds"
+      end
+      # rubocop: enable Layout/LineLength
+
+      # Query performance metrics collection
+      ActiveSupport::Notifications.subscribe "sql.active_record" do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+
+        pool = event.payload[:connection].pool
+        next if !pool || pool.is_a?(::ActiveRecord::ConnectionAdapters::NullPool)
+
+        db_config_name = pool.respond_to?(:db_config) ? pool.db_config.name : pool.spec.name
+
+        labels = {
+          config: db_config_name,
+          kind: event.payload[:name],
+          cached: !event.payload[:cached].nil?,
+          async: !event.payload[:async].nil?,
+        }
+
+        Yabeda.activerecord.queries_total.increment(labels)
+        Yabeda.activerecord.query_duration.measure(labels, (event.duration.to_f / 1000).round(3))
+      end
+
+      # Connection pool metrics collection
+      collect do
+        connection_pools = ::ActiveRecord::Base.connection_handler.connection_pool_list
+
+        connection_pools.each do |connection_pool|
+          stats = connection_pool.stat
+          name =
+            if connection_pool.respond_to?(:db_config)
+              connection_pool.db_config.name
+            else
+              connection_pool.spec.name
+            end
+
+          tags = { config: name }
+          Yabeda.activerecord.connection_pool_size.set(tags, stats[:size])
+          Yabeda.activerecord.connection_pool_connections.set(tags, stats[:connections])
+          Yabeda.activerecord.connection_pool_busy.set(tags, stats[:busy])
+          Yabeda.activerecord.connection_pool_dead.set(tags, stats[:dead])
+          Yabeda.activerecord.connection_pool_idle.set(tags, stats[:idle])
+          Yabeda.activerecord.connection_pool_waiting.set(tags, stats[:waiting])
+          Yabeda.activerecord.connection_pool_checkout_timeout.set(tags, stats[:checkout_timeout])
+        end
+      end
+    end
+  end
+end

data/lib/yabeda/activerecord.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "active_record"

data/sig/yabeda/activerecord.rbs

@@ -0,0 +1,6 @@
+module Yabeda
+  module ActiveRecord
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: yabeda-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: yabeda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: 'Yabeda plugin for easy collection of ActiveRecord metrics: query performance,
+  connection pool stats, etc.
+
+  '
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yabeda/active_record.rb
+- lib/yabeda/active_record/version.rb
+- lib/yabeda/activerecord.rb
+- sig/yabeda/activerecord.rbs
+- tmp/.keep
+- yabeda-activerecord-logo.png
+homepage: https://github.com/yabeda-rb/yabeda-activerecord
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yabeda-rb/yabeda-activerecord
+  source_code_uri: https://github.com/yabeda-rb/yabeda-activerecord
+  changelog_uri: https://github.com/yabeda-rb/yabeda-activerecord/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: 'Yabeda plugin to collect ActiveRecord metrics: query performance, connection
+  pool stats, etc.'
+test_files: []