rails_api_profiler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1831414415a44ee2a8ca9ae9d1861109ae80a33e7c6b222d9640e2a714f4941e
+  data.tar.gz: b034f5465418ed54d86c0b815d7280e4a8c6ffc77ee770ccc4e8c3723e0d501d
+SHA512:
+  metadata.gz: fe96e39fd05795345a5ba22d1ab3789edc73fae42dfdd3b2649f0fb72ed52586f2f1a160309048fad70b495199112b872580f1494994cc740aee3f7fbbd8e9c7
+  data.tar.gz: 8304743d25e615ba6bd7a04782468d57f12a5f29a3f1db698277d03759b82ad83282217fa28c277342cb8ed5e7a2d968b8d41a67f6b8d40bc9000c34a4c18fc5

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-01-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Sparsh Garg
+
+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,169 @@
+Perfect 👍
+Here’s a **clean, professional, RubyGems-ready README** that fits the quality of the gem you’re building.
+You can copy-paste this directly into `README.md`.
+
+---
+
+# Rails API Profiler
+
+**Rails API Profiler** is a lightweight, middleware-based performance profiling tool for **Rails API applications**.
+It provides request-level insights such as **response time**, **database query count**, and **database execution time** — with **zero changes** to your controllers or business logic.
+
+Designed to be **simple, fast, and production-safe**, it supports **Rails 5 and above**.
+
+---
+
+## ✨ Features
+
+* 🚀 Measures **API request duration**
+* 🗄️ Tracks **ActiveRecord query count**
+* ⏱️ Tracks **total database execution time**
+* ⚙️ Middleware-based (no controller code required)
+* 🔕 Can be enabled/disabled via configuration
+* 🧪 Safe for development, staging, and debugging
+* 🧩 Works with **Rails 5+**
+
+---
+
+## 📦 Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "rails_api_profiler", group: [:development, :staging]
+```
+
+Then install:
+
+```bash
+bundle install
+```
+
+That’s it — no further setup required.
+
+---
+
+## ⚙️ Configuration
+
+You can optionally configure the profiler in an initializer:
+
+```ruby
+# config/initializers/rails_api_profiler.rb
+
+RailsApiProfiler.configure do |config|
+  config.enabled = true
+  config.slow_request_threshold = 500 # milliseconds
+end
+```
+
+### Available Options
+
+| Option                   | Description                              | Default        |
+| ------------------------ | ---------------------------------------- | -------------- |
+| `enabled`                | Enable or disable profiling              | `true`         |
+| `slow_request_threshold` | Threshold for slow request warnings (ms) | `500`          |
+| `logger`                 | Custom logger instance                   | `Rails.logger` |
+
+---
+
+## 📊 Example Log Output
+
+```text
+[RailsApiProfiler] {:method=>"GET",
+:path=>"/api/v1/users",
+:status=>200,
+:duration_ms=>183.21,
+:db_queries=>7,
+:db_time_ms=>41.8}
+```
+
+For slow requests:
+
+```text
+[RailsApiProfiler] SLOW REQUEST {:method=>"POST",
+:path=>"/api/v1/orders",
+:status=>201,
+:duration_ms=>812.44,
+:db_queries=>18,
+:db_time_ms=>220.3}
+```
+
+---
+
+## 🧠 How It Works
+
+* Uses a **Rack middleware** to measure request duration
+* Hooks into **ActiveSupport::Notifications** to track SQL queries
+* Stores per-request stats using **thread-local storage**
+* Automatically attaches via a **Rails Railtie**
+
+No monkey-patching. No controller hooks. No overhead outside requests.
+
+---
+
+## 🧪 Supported Versions
+
+* **Rails:** 5.0+
+* **Ruby:** 2.4+
+
+---
+
+## 🚧 When Should I Use This?
+
+This gem is ideal when you want to:
+
+* Identify slow API endpoints
+* Detect excessive database queries
+* Debug performance regressions
+* Profile APIs in development or staging
+* Keep instrumentation lightweight
+
+---
+
+## 🛑 When NOT to Use This
+
+* As a full APM replacement (Datadog, New Relic, etc.)
+* For deep flamegraph analysis
+* For long-running background jobs
+
+This gem focuses on **request-level clarity**, not heavy analytics.
+
+---
+
+## 🛣️ Roadmap
+
+Planned improvements:
+
+* JSON / structured log formatter
+* N+1 query detection
+* Prometheus exporter
+* Memory usage tracking
+* Optional endpoint filtering
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests
+4. Submit a pull request
+
+Please ensure all specs pass before submitting.
+
+---
+
+## 📄 License
+
+This project is licensed under the **MIT License**.
+
+---
+
+## 👤 Author
+
+**Sparsh Garg**
+GitHub: [https://github.com/sparsh9](https://github.com/sparsh9)
+
+---

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rails_api_profiler/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsApiProfiler
+  class Configuration
+    attr_accessor :enabled,
+                  :slow_request_threshold,
+                  :logger
+
+    def initialize
+      @enabled = true
+      @slow_request_threshold = 500
+      @logger =
+        if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+          Rails.logger
+        else
+          Logger.new($stdout)
+        end
+    end
+  end
+end

data/lib/rails_api_profiler/middleware.rb

@@ -0,0 +1,46 @@
+module RailsApiProfiler
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      config = RailsApiProfiler.configuration
+      return @app.call(env) unless config.enabled
+
+      Subscribers::ActiveRecord.reset!
+
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      status, headers, response = @app.call(env)
+
+      finish = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      duration = ((finish - start) * 1000).round(2)
+
+      db_stats = Subscribers::ActiveRecord.stats
+
+      log(env, status, duration, db_stats, config)
+
+      [status, headers, response]
+    end
+
+    private
+
+    def log(env, status, duration, db, config)
+      payload = {
+        method: env["REQUEST_METHOD"],
+        path: env["PATH_INFO"],
+        status: status,
+        duration_ms: duration,
+        db_queries: db[:queries],
+        db_time_ms: db[:time_ms]
+      }
+
+      if duration >= config.slow_request_threshold
+        config.logger.warn("[RailsApiProfiler] SLOW REQUEST #{payload}")
+      else
+        config.logger.info("[RailsApiProfiler] #{payload}")
+      end
+    end
+  end
+end

data/lib/rails_api_profiler/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+if defined?(Rails)
+  module RailsApiProfiler
+    class Railtie < ::Rails::Railtie
+      initializer "rails_api_profiler.configure" do |app|
+        app.middleware.use RailsApiProfiler::Middleware
+      end
+
+      initializer "rails_api_profiler.active_record" do
+        Subscribers::ActiveRecord.subscribe!
+      end
+    end
+  end
+end

data/lib/rails_api_profiler/subscribers/active_record.rb

@@ -0,0 +1,34 @@
+module RailsApiProfiler
+  module Subscribers
+    class ActiveRecord
+      def self.subscribe!
+        return unless defined?(::ActiveRecord)
+
+        ::ActiveSupport::Notifications.subscribe("sql.active_record") do |*args|
+          event = ::ActiveSupport::Notifications::Event.new(*args)
+
+          Thread.current[:rails_api_profiler_db_queries] ||= 0
+          Thread.current[:rails_api_profiler_db_time] ||= 0.0
+
+          # Skip schema & cached queries
+          next if event.payload[:name] == "SCHEMA"
+
+          Thread.current[:rails_api_profiler_db_queries] += 1
+          Thread.current[:rails_api_profiler_db_time] += event.duration
+        end
+      end
+
+      def self.reset!
+        Thread.current[:rails_api_profiler_db_queries] = 0
+        Thread.current[:rails_api_profiler_db_time] = 0.0
+      end
+
+      def self.stats
+        {
+          queries: Thread.current[:rails_api_profiler_db_queries] || 0,
+          time_ms: (Thread.current[:rails_api_profiler_db_time] || 0.0).round(2)
+        }
+      end
+    end
+  end
+end

data/lib/rails_api_profiler/version.rb

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

data/lib/rails_api_profiler.rb

@@ -0,0 +1,17 @@
+require "rails_api_profiler/version"
+require "rails_api_profiler/configuration"
+require "rails_api_profiler/middleware"
+require "rails_api_profiler/subscribers/active_record"
+require "rails_api_profiler/railtie"
+
+module RailsApiProfiler
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/sig/rails_api_profiler.rbs

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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_profiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sparsh Garg
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Rails API Profiler is a lightweight, middleware-based tool for profiling
+  API requests in Rails applications. It measures request duration, database query
+  count, and database execution time with zero code changes, supporting Rails 5 and
+  above.
+email:
+- sparshgarg2000@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_api_profiler.rb
+- lib/rails_api_profiler/configuration.rb
+- lib/rails_api_profiler/middleware.rb
+- lib/rails_api_profiler/railtie.rb
+- lib/rails_api_profiler/subscribers/active_record.rb
+- lib/rails_api_profiler/version.rb
+- sig/rails_api_profiler.rbs
+homepage: https://github.com/sparsh9/rails-api-profiler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sparsh9/rails-api-profiler
+  source_code_uri: https://github.com/sparsh9/rails-api-profiler
+  changelog_uri: https://github.com/sparsh9/rails-api-profiler/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Lightweight performance profiler for Rails API requests
+test_files: []