request_trail 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 954b1805423f92d59582e41e86d55ac489577ef5c76d20701c0fbcd76956f2a8
-  data.tar.gz: 8464e352949c6eb14636ead83e5f0a556b8eb7dcabfd35186f35b3749ae8ac0a
+  metadata.gz: ad0751f86ff717630ea62f478707c758fc9d45540721c54016a55e19c86030be
+  data.tar.gz: 6192f331657a761ee7d537c29ded481629cfedfb1da74eb819e9181677010036
 SHA512:
-  metadata.gz: 2c75f6813431fe8922454592a7dfb170fbddab4258a696901e79d0e1ec56699834cd7d9d0200d8eef1a7a3067dc95988e7bd0419b66b0ee6566bf0f342301dfd
-  data.tar.gz: 7054bee0d5f25f35513c9697bfe5000128d7932df335beae13acaeb43af5522fde160c045554526a505efacbe326d9892689756b4ea8b289d04869d7c73fc565
+  metadata.gz: 45d23c714ab2cebe3d5d33db4e8832301e69e496d3cd27419c370eef734bf8581c7d9f815485ab595acf7ce95d9c82c07d580eca805386526edbcd21bfffc74b
+  data.tar.gz: da3154bce7516976fdbff6437b877d639cf9b235a3308cb7101462d63e368b5b64530b932f101975f785cbb18365448e0ef18fbad84c2a5e2d8a3c9db126249c

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.4.0] - 2026-06-12
+
+### Added
+
+- `RequestTrail::Formatters::FlameGraph` — opt-in ASCII flame-graph formatter with proportional `█` bars and per-layer ANSI colour (auto-detected via TTY)
+- Opt in via `config.formatter = RequestTrail::Formatters::FlameGraph.new`
+
 ## [0.3.0] - 2026-06-12
 
 ### Added
@@ -33,7 +40,8 @@
 - `RequestTrail::Subscriber` — attach/detach API for notification subscriptions
 - `RequestTrail::Collector` — thread-safe per-request event accumulator
 
-[Unreleased]: https://github.com/eclectic-coding/request-trail/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/eclectic-coding/request-trail/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/eclectic-coding/request-trail/releases/tag/v0.4.0
 [0.3.0]: https://github.com/eclectic-coding/request-trail/releases/tag/v0.3.0
 [0.2.0]: https://github.com/eclectic-coding/request-trail/releases/tag/v0.2.0
 [0.1.0]: https://github.com/eclectic-coding/request-trail/releases/tag/v0.1.0

data/README.md

@@ -54,6 +54,28 @@ Without controller data (plain Rack apps), a single-line summary is emitted:
 [RequestTrail] GET /orders 142ms | SQL: 7/38.3ms | Cache: 4 hits, 1 miss, 2.0ms
 ```
 
+### Flame graph formatter
+
+Opt into the ASCII flame-graph formatter for a visual proportional breakdown:
+
+```ruby
+RequestTrail.configure do |config|
+  config.formatter = RequestTrail::Formatters::FlameGraph.new
+end
+```
+
+Output (with ANSI colour when stdout is a TTY):
+
+```
+[RequestTrail] GET /orders 142ms ████████████████████████████████████
+  controller   104ms ████████████████████████████
+    sql         38ms █████████
+    cache        2ms
+    view        22ms █████
+```
+
+Colour scheme: controller = blue, sql = yellow, cache = green, view = magenta. Plain bars are emitted when stdout is not a TTY (e.g. log files, CI).
+
 ### Configuration
 
 Add an initializer to customize behavior:
@@ -65,6 +87,7 @@ RequestTrail.configure do |config|
   config.log_level     = :info     # Rails logger level (:debug, :info, :warn)
   config.threshold_ms  = 200       # only log requests slower than this (0 = log all)
   config.logger        = nil       # defaults to Rails.logger
+  config.formatter     = RequestTrail::Formatters::FlameGraph.new  # optional
 end
 ```
 

data/ROADMAP.md

@@ -2,26 +2,13 @@
 
 `request_trail` traces a Rails request through every processing layer — middleware, controller, ActiveRecord, cache — and emits a flame-graph-style summary to the log. This roadmap describes the incremental path to a stable 1.0.0.
 
-## 0.4.0 — Flame Graph Output
-
-- Indented ASCII flame-graph renderer with proportional timing bars
-- Optional ANSI colour with automatic TTY detection
-- Ships as `Request::Trail::Formatters::FlameGraph` alongside the existing plain-text formatter:
-  ```
-  [RequestTrail] GET /orders 142ms ████████████████████████████████████
-    middleware   4ms  █
-    controller 100ms  ████████████████████████
-      sql       38ms    █████████
-      cache      2ms
-      view      22ms    █████
-  ```
-
 ## 0.5.0 — Filtering & Sampling
 
 - Path filters: skip tracing for `/assets`, `/health`, or custom regex patterns
 - Slow-request mode: only emit summaries above `threshold_ms`
 - Sampling: trace only N% of requests (useful in production)
 - Custom formatter API: `config.formatter = MyFormatter`
+- FlameGraph colour overrides: `FlameGraph.new(colorize: true, colors: { controller: "\e[36m" })`
 - Rails generator to scaffold the config initializer (`rails generate request_trail:install`)
 
 ## 0.6.0 — Structured Output & Integrations

data/lib/request_trail/configuration.rb

@@ -4,7 +4,7 @@ require "logger"
 
 module RequestTrail
   class Configuration
-    attr_writer :logger
+    attr_writer :logger, :formatter
     attr_accessor :enabled, :log_level, :threshold_ms
 
     def initialize
@@ -17,6 +17,10 @@ module RequestTrail
       @logger ||= rails_logger || Logger.new($stdout)
     end
 
+    def formatter
+      @formatter ||= RequestTrail::Formatter.new
+    end
+
     private
 
     def rails_logger

data/lib/request_trail/formatters/flame_graph.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RequestTrail
+  module Formatters
+    class FlameGraph
+      BAR_WIDTH = 36
+      BAR_CHAR  = "█"
+
+      COLORS = {
+        header: "\e[1m",
+        controller: "\e[34m",
+        sql: "\e[33m",
+        cache: "\e[32m",
+        view: "\e[35m"
+      }.freeze
+      RESET = "\e[0m"
+
+      def initialize(colorize: false)
+        @colorize = colorize
+      end
+
+      def format(request, collector)
+        total = collector.elapsed_ms.to_f
+        lines = [header_line(request, collector)] + detail_rows(collector, total)
+        lines.join("\n")
+      end
+
+      private
+
+      def detail_rows(collector, total)
+        return tiered_rows(collector, total) if collector.action_duration_ms.positive?
+
+        flat_rows(collector, total)
+      end
+
+      def tiered_rows(collector, total)
+        [
+          row("  ", "controller", collector.action_duration_ms, total, :controller),
+          row("    ", "sql",      collector.sql_duration_ms,    total, :sql),
+          row("    ", "cache",    collector.cache_duration_ms,  total, :cache),
+          row("    ", "view",     collector.view_duration_ms,   total, :view)
+        ]
+      end
+
+      def flat_rows(collector, total)
+        [
+          row("  ", "sql",   collector.sql_duration_ms,   total, :sql),
+          row("  ", "cache", collector.cache_duration_ms, total, :cache)
+        ]
+      end
+
+      def header_line(request, collector)
+        elapsed = collector.elapsed_ms.round
+        bar = BAR_CHAR * BAR_WIDTH
+        line = "[RequestTrail] #{request.request_method} #{request.path} #{elapsed}ms #{bar}"
+        return line unless colorize?
+
+        "#{COLORS[:header]}#{line}#{RESET}"
+      end
+
+      def row(indent, label, duration_ms, total_ms, color_key)
+        ms = duration_ms.round
+        bar = colorized_bar(duration_ms, total_ms, color_key)
+        "#{indent}#{label.ljust(11)}#{ms.to_s.rjust(4)}ms #{bar}"
+      end
+
+      def colorized_bar(duration_ms, total_ms, color_key)
+        width = total_ms.positive? ? ((duration_ms.to_f / total_ms) * BAR_WIDTH).round : 0
+        bar = BAR_CHAR * width
+        return bar unless colorize? && width.positive?
+
+        "#{COLORS[color_key]}#{bar}#{RESET}"
+      end
+
+      def colorize?
+        @colorize
+      end
+    end
+  end
+end

data/lib/request_trail/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RequestTrail
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/request_trail.rb

@@ -5,6 +5,7 @@ require_relative "request_trail/configuration"
 require_relative "request_trail/collector"
 require_relative "request_trail/subscriber"
 require_relative "request_trail/formatter"
+require_relative "request_trail/formatters/flame_graph"
 require_relative "request_trail/middleware"
 require_relative "request_trail/railtie" if defined?(Rails::Railtie)
 
@@ -21,12 +22,11 @@ module RequestTrail
     end
 
     def formatter
-      @formatter ||= Formatter.new
+      configuration.formatter
     end
 
     def reset!
       @configuration = nil
-      @formatter = nil
     end
   end
 end

data/sig/request_trail/configuration.rbs

@@ -1,11 +1,13 @@
 module RequestTrail
   class Configuration
     attr_writer logger: ::Logger
+    attr_writer formatter: untyped
     attr_accessor enabled: bool
     attr_accessor log_level: Symbol
     attr_accessor threshold_ms: Numeric
 
     def initialize: () -> void
     def logger: () -> ::Logger
+    def formatter: () -> untyped
   end
 end

data/sig/request_trail/formatters/flame_graph.rbs

@@ -0,0 +1,23 @@
+module RequestTrail
+  module Formatters
+    class FlameGraph
+      BAR_WIDTH: Integer
+      BAR_CHAR: String
+      COLORS: Hash[Symbol, String]
+      RESET: String
+
+      def initialize: (?colorize: bool) -> void
+      def format: (::Rack::Request request, Collector collector) -> String
+
+      private
+
+      def detail_rows: (Collector collector, Float total) -> Array[String]
+      def tiered_rows: (Collector collector, Float total) -> Array[String]
+      def flat_rows: (Collector collector, Float total) -> Array[String]
+      def header_line: (::Rack::Request request, Collector collector) -> String
+      def row: (String indent, String label, Float duration_ms, Float total_ms, Symbol color_key) -> String
+      def colorized_bar: (Float duration_ms, Float total_ms, Symbol color_key) -> String
+      def colorize?: () -> bool
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: request_trail
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -58,6 +58,7 @@ files:
 - lib/request_trail/collector.rb
 - lib/request_trail/configuration.rb
 - lib/request_trail/formatter.rb
+- lib/request_trail/formatters/flame_graph.rb
 - lib/request_trail/middleware.rb
 - lib/request_trail/railtie.rb
 - lib/request_trail/subscriber.rb
@@ -66,6 +67,7 @@ files:
 - sig/request_trail/collector.rbs
 - sig/request_trail/configuration.rbs
 - sig/request_trail/formatter.rbs
+- sig/request_trail/formatters/flame_graph.rbs
 - sig/request_trail/middleware.rbs
 - sig/request_trail/subscriber.rbs
 homepage: https://github.com/eclectic-coding/request-trail