io_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55da4008002fc3ddd2846fda47f10c76910a29b370754f02772e33635c73d156
+  data.tar.gz: be06ae7bf31a7051a7e0e113cf16f1c2a55300bf4519d083d400e948e2b4a760
+SHA512:
+  metadata.gz: 4120f7fad9b19fe8ef2be71a5c14fd54fca42141ed205cdd468086956b4232bb401fca94d47c906fa2fc371df3288f16b6b46ee2a520ef023d9fdf9fbe61a7d2
+  data.tar.gz: 5eab6fe8f0e5eb4072d8c9e092259896cadb8034dbf4baf8ec99460febbc0fe3bb592f7e0f120e14fdf6f1ed0e4f2684df54b2cd27830281b37eabe36c31a3d4

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change log
+
+## main
+
+## 0.1.0 (2022-05-24)
+
+- [PR#7](https://github.com/DmitryTsepelev/io_monitor/pull/7) Add HTTP adapter ([@maxshend])
+- [PR#6](https://github.com/DmitryTsepelev/io_monitor/pull/6) Add support for ActiveRecord::Relation#load_async method ([@maxshend])
+- [PR#5](https://github.com/DmitryTsepelev/io_monitor/pull/5) Use ActiveSupport::CurrentAttributes to store input payload ([@maxshend])
+- [PR#2](https://github.com/DmitryTsepelev/io_monitor/pull/2), [PR#3](https://github.com/DmitryTsepelev/io_monitor/pull/3), [PR#4](https://github.com/DmitryTsepelev/io_monitor/pull/4) Initial implementation ([@prog-supdex], [@maxshend], [@baygeldin])
+
+[@baygeldin]: https://github.com/baygeldin
+[@prog-supdex]: https://github.com/prog-supdex
+[@maxshend]: https://github.com/maxshend

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 DmitryTsepelev
+
+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,121 @@
+# IoMonitor
+
+A gem that helps to detect potential memory bloats.
+
+When your controller loads a lot of data to the memory but returns a small response to the client it might mean that you're using the IO in the non–optimal way. In this case, you'll see the following message in your logs:
+
+```
+Completed 200 OK in 349ms (Views: 2.1ms | ActiveRecord: 38.7ms | ActiveRecord Payload: 866.00 B | Response Payload: 25.00 B | Allocations: 72304)
+```
+
+<p align="center">
+  <a href="https://evilmartians.com/?utm_source=io_monitor">
+    <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+  </a>
+</p>
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'io_monitor'
+```
+
+Change configuration in an initializer if you need:
+
+```ruby
+IoMonitor.configure do |config|
+  config.publish = :notifications # defaults to :logs
+  config.warn_threshold = 0.8 # defaults to 0
+  config.adapters = [:active_record, :net_http] # defaults to [:active_record]
+end
+```
+
+Then include the concern into your controller:
+
+```ruby
+class MyController < ApplicationController
+  include IoMonitor::Controller
+end
+```
+
+Depending on configuration when IO payload size to response payload size ratio reaches the threshold either a `warn_threshold_reached.io_monitor` notification will be sent or a following warning will be logged:
+
+```
+ActiveRecord I/O to response payload ratio is 0.1, while threshold is 0.8
+```
+
+In addition, if `publish` is set to logs, additional data will be logged on each request:
+
+```
+Completed 200 OK in 349ms (Views: 2.1ms | ActiveRecord: 38.7ms | ActiveRecord Payload: 866.00 B | Response Payload: 25.00 B | Allocations: 72304)
+```
+
+If you want to inspect payload sizes, check out payload data for the `process_action.action_controller` event:
+
+```ruby
+ActiveSupport::Notifications.subscribe("process_action.action_controller") do |name, start, finish, id, payload|
+  payload[:io_monitor] # { active_record: 866, response: 25 }
+end
+```
+
+## Custom publishers
+
+Implement your custom publisher by inheriting from `BasePublisher`:
+
+```ruby
+class MyPublisher < IoMonitor::BasePublisher
+  def publish(source, ratio)
+    puts "Warn threshold reched for #{source} at #{ratio}!"
+  end
+end
+```
+
+Then specify it in the configuration:
+
+```ruby
+IoMonitor.configure do |config|
+  config.publish = MyPublisher.new
+end
+```
+
+## Custom adapters
+
+Implement your custom adapter by inheriting from `BaseAdapter`:
+
+```ruby
+class MyAdapter < IoMonitor::BaseAdapter
+  def self.kind
+    :my_source
+  end
+
+  def initialize!
+    # Take a look at `AbstractAdapterPatch` for an example.
+  end
+end
+```
+
+Then specify it in the configuration:
+
+```ruby
+IoMonitor.configure do |config|
+  config.adapters = [:active_record, MyAdapter.new]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryTsepelev/io_monitor.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Thanks to [@prog-supdex](https://github.com/prog-supdex) and [@maxshend](https://github.com/maxshend) for building the initial implementations (see [PR#2](https://github.com/DmitryTsepelev/io_monitor/pull/2) and [PR#3](https://github.com/DmitryTsepelev/io_monitor/pull/3)).

data/lib/io_monitor/adapters/active_record_adapter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "io_monitor/patches/abstract_adapter_patch"
+require "io_monitor/patches/future_result_patch"
+
+module IoMonitor
+  class ActiveRecordAdapter < BaseAdapter
+    class << self
+      def kind
+        :active_record
+      end
+
+      def aggregate_result(rows:)
+        return unless IoMonitor.aggregator.active?
+
+        # `.flatten.join.bytesize` would look prettier,
+        # but it makes a lot of unnecessary allocations.
+        io_payload_size = rows.sum(0) do |row|
+          row.sum(0) do |val|
+            (String === val ? val : val.to_s).bytesize
+          end
+        end
+
+        IoMonitor.aggregator.increment(kind, io_payload_size)
+      end
+    end
+
+    def initialize!
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(AbstractAdapterPatch)
+
+        if Rails::VERSION::MAJOR >= 7
+          ActiveRecord::FutureResult.prepend(FutureResultPatch)
+        end
+      end
+    end
+  end
+end

data/lib/io_monitor/adapters/base_adapter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  class BaseAdapter
+    # :nocov:
+    def self.kind
+      raise NotImplementedError
+    end
+
+    def initialize!
+      raise NotImplementedError
+    end
+    # :nocov:
+  end
+end

data/lib/io_monitor/adapters/net_http_adapter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "io_monitor/patches/net_http_adapter_patch"
+
+module IoMonitor
+  class NetHttpAdapter < BaseAdapter
+    def self.kind
+      :net_http
+    end
+
+    def initialize!
+      ActiveSupport.on_load(:after_initialize) do
+        Net::HTTP.prepend(NetHttpAdapterPatch)
+
+        if defined?(::WebMock)
+          WebMock::HttpLibAdapters::NetHttpAdapter
+            .instance_variable_get(:@webMockNetHTTP)
+            .prepend(NetHttpAdapterPatch)
+        end
+      end
+    end
+  end
+end

data/lib/io_monitor/aggregator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  # Thread-safe payload size aggregator.
+  class Aggregator
+    def initialize(sources)
+      @sources = sources
+    end
+
+    attr_reader :sources
+
+    def active?
+      InputPayload.active.present?
+    end
+
+    def start!
+      InputPayload.active = true
+    end
+
+    def stop!
+      InputPayload.active = false
+    end
+
+    def increment(source, val)
+      return unless active?
+
+      InputPayload.state ||= empty_state
+      InputPayload.state[source.to_sym] += val
+    end
+
+    def get(source)
+      InputPayload.state ||= empty_state
+      InputPayload.state[source.to_sym]
+    end
+
+    private
+
+    def empty_state
+      sources.map { |kind| [kind, 0] }.to_h
+    end
+
+    class InputPayload < ActiveSupport::CurrentAttributes
+      attribute :state, :active
+    end
+  end
+end

data/lib/io_monitor/configuration.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  class Configuration
+    DEFAULT_WARN_THRESHOLD = 0.0
+
+    def initialize
+      @publisher = LogsPublisher.new
+      @adapters = [ActiveRecordAdapter.new]
+      @warn_threshold = DEFAULT_WARN_THRESHOLD
+    end
+
+    attr_reader :publisher, :adapters, :warn_threshold
+
+    def publish=(value)
+      if value.is_a?(BasePublisher)
+        @publisher = value
+      elsif (publisher_type = resolve(IoMonitor::PUBLISHERS, value))
+        @publisher = publisher_type.new
+      else
+        supported = IoMonitor::PUBLISHERS.map(&:kind)
+        raise ArgumentError, "Only the following publishers are supported: #{supported}."
+      end
+    end
+
+    def adapters=(value)
+      @adapters = [*value].map do |adapter|
+        if adapter.is_a?(BaseAdapter)
+          adapter
+        elsif (adapter_type = resolve(IoMonitor::ADAPTERS, adapter))
+          adapter_type.new
+        else
+          supported = IoMonitor::ADAPTERS.map(&:kind)
+          raise ArgumentError, "Only the following adapters are supported: #{supported}."
+        end
+      end
+    end
+
+    def warn_threshold=(value)
+      case value
+      when 0..1
+        @warn_threshold = value.to_f
+      else
+        raise ArgumentError, "Warn threshold should be within 0..1 range."
+      end
+    end
+
+    private
+
+    def resolve(list, kind)
+      list.find { |p| p.kind == kind }
+    end
+  end
+end

data/lib/io_monitor/controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  module Controller
+    extend ActiveSupport::Concern
+
+    def process_action(*)
+      IoMonitor.aggregator.start!
+
+      super
+
+      IoMonitor.aggregator.stop!
+    end
+
+    def append_info_to_payload(payload)
+      super
+
+      data = payload[IoMonitor::NAMESPACE] = {}
+
+      IoMonitor.aggregator.sources.each do |source|
+        data[source] = IoMonitor.aggregator.get(source)
+      end
+
+      data[:response] = payload[:response]&.body&.bytesize || 0
+    end
+  end
+end

data/lib/io_monitor/patches/abstract_adapter_patch.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  module AbstractAdapterPatch
+    def build_result(*args, **kwargs, &block)
+      ActiveRecordAdapter.aggregate_result rows: kwargs[:rows]
+
+      super
+    end
+  end
+end

data/lib/io_monitor/patches/action_controller_base_patch.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  module ActionControllerBasePatch
+    def log_process_action(payload)
+      super.tap do |messages|
+        next unless IoMonitor.config.publisher.is_a?(LogsPublisher)
+
+        data = payload[IoMonitor::NAMESPACE]
+        next unless data
+
+        data.each do |source, bytes|
+          size = ActiveSupport::NumberHelper.number_to_human_size(bytes)
+          messages << "#{source.to_s.camelize} Payload: #{size}"
+        end
+      end
+    end
+  end
+end

data/lib/io_monitor/patches/future_result_patch.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  module FutureResultPatch
+    def result
+      # @event_buffer is used to send ActiveSupport notifications related to async queries
+      return super unless @event_buffer
+
+      res = super
+      ActiveRecordAdapter.aggregate_result rows: res.rows
+
+      res
+    end
+  end
+end

data/lib/io_monitor/patches/net_http_adapter_patch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  module NetHttpAdapterPatch
+    def request(*args, &block)
+      super do |response|
+        if response.body && IoMonitor.aggregator.active?
+          IoMonitor.aggregator.increment(NetHttpAdapter.kind, response.body.bytesize)
+        end
+      end
+    end
+  end
+end

data/lib/io_monitor/publishers/base_publisher.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  class BasePublisher
+    # :nocov:
+    def self.kind
+      raise NotImplementedError
+    end
+
+    def publish(source, ratio)
+      raise NotImplementedError
+    end
+    # :nocov:
+
+    def process_action(payload)
+      (payload.keys - [:response]).each do |source|
+        ratio = ratio(payload[:response], payload[source])
+
+        if ratio < IoMonitor.config.warn_threshold
+          publish(source, ratio)
+        end
+      end
+    end
+
+    private
+
+    def ratio(response_size, io_size)
+      response_size.to_f / io_size.to_f
+    end
+  end
+end

data/lib/io_monitor/publishers/logs_publisher.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  class LogsPublisher < BasePublisher
+    def self.kind
+      :logs
+    end
+
+    def publish(source, ratio)
+      Rails.logger.warn <<~HEREDOC.squish
+        #{source.to_s.camelize} I/O to response payload ratio is #{ratio},
+        while threshold is #{IoMonitor.config.warn_threshold}
+      HEREDOC
+    end
+  end
+end

data/lib/io_monitor/publishers/notifications_publisher.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  class NotificationsPublisher < BasePublisher
+    WARN_THRESHOLD_REACHED_EVENT = "warn_threshold_reached"
+
+    def self.kind
+      :notifications
+    end
+
+    def publish(source, ratio)
+      ActiveSupport::Notifications.instrument(
+        full_event_name(WARN_THRESHOLD_REACHED_EVENT),
+        source: source,
+        ratio: ratio
+      )
+    end
+
+    private
+
+    def full_event_name(event_name)
+      "#{event_name}.#{IoMonitor::NAMESPACE}"
+    end
+  end
+end

data/lib/io_monitor/railtie.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "io_monitor/patches/action_controller_base_patch"
+
+module IoMonitor
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      IoMonitor.config.adapters.each(&:initialize!)
+
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.singleton_class.prepend(ActionControllerBasePatch)
+      end
+
+      ActiveSupport::Notifications.subscribe("process_action.action_controller") do |*args|
+        payload = args.last[IoMonitor::NAMESPACE]
+        next unless payload
+
+        IoMonitor.config.publisher.process_action(payload)
+      end
+    end
+  end
+end

data/lib/io_monitor/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IoMonitor
+  VERSION = "0.1.0"
+end

data/lib/io_monitor.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "io_monitor/version"
+require "io_monitor/configuration"
+require "io_monitor/aggregator"
+require "io_monitor/controller"
+
+require "io_monitor/adapters/base_adapter"
+require "io_monitor/adapters/active_record_adapter"
+require "io_monitor/adapters/net_http_adapter"
+
+require "io_monitor/publishers/base_publisher"
+require "io_monitor/publishers/logs_publisher"
+require "io_monitor/publishers/notifications_publisher"
+
+require "io_monitor/railtie"
+
+module IoMonitor
+  NAMESPACE = :io_monitor
+  ADAPTERS = [ActiveRecordAdapter, NetHttpAdapter].freeze
+  PUBLISHERS = [LogsPublisher, NotificationsPublisher].freeze
+
+  class << self
+    def aggregator
+      @aggregator ||= Aggregator.new(
+        config.adapters.map { |a| a.class.kind }
+      )
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: io_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- baygeldin
+- prog-supdex
+- maxshend
+- DmitryTsepelev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+description:
+email:
+- dmitry.a.tsepelev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/io_monitor.rb
+- lib/io_monitor/adapters/active_record_adapter.rb
+- lib/io_monitor/adapters/base_adapter.rb
+- lib/io_monitor/adapters/net_http_adapter.rb
+- lib/io_monitor/aggregator.rb
+- lib/io_monitor/configuration.rb
+- lib/io_monitor/controller.rb
+- lib/io_monitor/patches/abstract_adapter_patch.rb
+- lib/io_monitor/patches/action_controller_base_patch.rb
+- lib/io_monitor/patches/future_result_patch.rb
+- lib/io_monitor/patches/net_http_adapter_patch.rb
+- lib/io_monitor/publishers/base_publisher.rb
+- lib/io_monitor/publishers/logs_publisher.rb
+- lib/io_monitor/publishers/notifications_publisher.rb
+- lib/io_monitor/railtie.rb
+- lib/io_monitor/version.rb
+homepage: https://github.com/DmitryTsepelev/io_monitor
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/DmitryTsepelev/io_monitor/issues
+  changelog_uri: https://github.com/DmitryTsepelev/io_monitor/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/DmitryTsepelev/io_monitor/blob/master/README.md
+  homepage_uri: https://github.com/DmitryTsepelev/io_monitor
+  source_code_uri: https://github.com/DmitryTsepelev/io_monitor
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: A gem that helps to detect potential memory bloats
+test_files: []