rack-server-timing 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c161a8abce8a3ecdee2ba07e7eeeecb3663d4d90c4ac0d399755df9b1b4862bb
+  data.tar.gz: 13ff6d6d9b44386a64a4dba1bfb953e8b23651deaf2312d6f983ec4b01f1f837
+SHA512:
+  metadata.gz: b16d0a90faa4add1a6cca311866e3a3069a92e641ff788db076cc36f46e9be63cad22969b0224361bc7b29d7af361d3fc624a8ea71c94318510b00889e07f27e
+  data.tar.gz: ac7e7003ebd3e2da9131ed846a52ece52a08789ff7261eb0aadf5d53cbdb876d6000ec4fbd71e5b479f2ec2910805618f5c0a5102b9c9310bf61fe6362d59102

data/README.md

@@ -0,0 +1,80 @@
+# Server Timing for Rack
+
+Easily record and emit Server-Timing headers in your Rack applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rack-server-timing"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-server-timing
+
+## Usage in a Rack application
+
+Simply require and add middleware:
+
+```ruby
+# config.ru
+require "rack-server-timing/middleware"
+
+use RackServerTiming::Middleware
+
+run ->(env) {
+  [200, {}, ["It Works!"]]
+}
+```
+
+And then record your metrics:
+
+```ruby
+env["rack.server_timing"].record("DB", 200)
+```
+
+## Usage in a Roda application
+
+Enable the plugin `server_timing` after `render` (if you wish to have the rendering profiled automatically).
+
+```ruby
+class App < Roda
+  plugin :render # Optional
+  plugin :server_timing
+end
+```
+
+A convenient `server_timing` helper is available to quickly `record` or `benchmark`
+timing values.
+
+## Sequel timing
+
+Enable the `server_timing` extension in your database instance. This extension will automatically create a
+null logging instance if there is no logging configured so there _may_ be a small performance hit.
+
+```ruby
+DB = Sequel.connect
+
+DB.extension :server_timing
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adam12/rack-server-timing.
+
+I love pull requests! If you fork this project and modify it, please ping me to see
+if your changes can be incorporated back into this project.
+
+That said, if your feature idea is nontrivial, you should probably open an issue to
+[discuss it](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/)
+before attempting a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/test*.rb"]
+  t.verbose = true
+end
+
+task default: :test

data/lib/rack-server-timing/current.rb

@@ -0,0 +1,16 @@
+# frozen-string-literal: true
+module RackServerTiming
+  module Current
+    def self.clear!
+      Thread.current[:server_timing] = nil
+    end
+
+    def self.recorder=(recorder)
+      Thread.current[:server_timing] = recorder
+    end
+
+    def self.recorder
+      Thread.current[:server_timing]
+    end
+  end
+end

data/lib/rack-server-timing/metric.rb

@@ -0,0 +1,26 @@
+# frozen-string-literal: true
+module RackServerTiming
+  class Metric
+    attr_reader :name
+    attr_reader :duration
+    attr_reader :description
+
+    def initialize(name:, duration: nil, description: nil)
+      @name = name
+      @duration = duration
+      @description = description
+    end
+
+    def increment(delta)
+      @duration += delta
+      self
+    end
+
+    def formatted
+      String.new(name).tap do |output|
+        output << %Q|;dur=#{duration}|       if duration
+        output << %Q|;desc="#{description}"| if description
+      end
+    end
+  end
+end

data/lib/rack-server-timing/middleware.rb

@@ -0,0 +1,26 @@
+# frozen-string-literal: true
+require_relative "recorder"
+require_relative "current"
+
+module RackServerTiming
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      recorder = Recorder.new
+
+      env["rack.server_timing"] = Current.recorder = recorder
+      status, headers, response = @app.call(env)
+
+      if (value = recorder.header_value) and not value.empty?
+        headers[recorder.header_name] ||= value
+      end
+
+      [status, headers, response]
+    ensure
+      Current.clear!
+    end
+  end
+end

data/lib/rack-server-timing/recorder.rb

@@ -0,0 +1,75 @@
+# frozen-string-literal: true
+require "benchmark"
+require_relative "metric"
+
+module RackServerTiming
+  class Recorder
+    attr_reader :metrics
+
+    def initialize
+      @metrics = {}
+    end
+
+    ##
+    # Increment the metric of :name: by :duration:, creating the metric if
+    # it did not already exist.
+    #
+    # Accepts arguments as positional arguments or keyword arguments.
+    def increment(name = nil, duration = nil, description = nil, **kwargs)
+      name = kwargs[:name] if name.nil?
+      duration = kwargs[:duration] if duration.nil?
+      description = kwargs[:description] if description.nil?
+
+      if (metric = metrics[name])
+        metric.increment(duration)
+      else
+        metric = Metric.new(name: name, duration: duration, description: description)
+        metrics[name] = metric
+      end
+    end
+
+    ##
+    # Record the metric of :name: with :duration: and optionally :description:.
+    #
+    # Accepts arguments as positional arguments or keyword arguments.
+    def record(name = nil, duration = nil, description = nil, **kwargs)
+      name ||= kwargs[:name]
+      duration ||= kwargs[:duration]
+      description ||= kwargs[:description]
+
+      metrics[name] = Metric.new(
+        name: name,
+        duration: duration,
+        description: description
+      )
+    end
+
+    ##
+    # Record the metric of :name: with an optional :description:, evaluating the
+    # provided block for :duration:.
+    #
+    # Accepts arguments as positional arguments or keyword arguments.
+    def benchmark(name = nil, description = nil, **kwargs, &block)
+      result = nil
+      name ||= kwargs[:name]
+      description ||= kwargs[:description]
+      duration = Benchmark.realtime { result = block.call }
+
+      metrics[name] = Metric.new(
+        name: name,
+        duration: duration,
+        description: description,
+      )
+
+      result
+    end
+
+    def header_name
+      "Server-Timing"
+    end
+
+    def header_value
+      metrics.map {|_name, metric| metric.formatted }.join(", ")
+    end
+  end
+end

data/lib/roda/plugins/server_timing.rb

@@ -0,0 +1,47 @@
+# frozen-string-literal: true
+
+require "rack-server-timing/middleware"
+
+class Roda
+  module RodaPlugins
+    module ServerTiming
+      module InstanceMethods
+        # Shorthand to the +RackServerTiming::Recorder+ instance
+        def server_timing
+          env["rack.server_timing"]
+        end
+
+        # Benchmark the provided block and return it's result
+        def benchmark(name:, description: nil)
+          result = nil
+
+          server_timing.benchmark(name: name, description: description) do
+            result = yield
+          end
+
+          result
+        end
+      end
+
+      module RenderMethods # :nodoc:
+        def render(*)
+          benchmark(name: "Render") { super }
+        end
+
+        def view(*)
+          benchmark(name: "Render") { super }
+        end
+      end
+
+      def self.configure(app) # :nodoc:
+        app.use RackServerTiming::Middleware
+
+        if app.opts.has_key?(:render)
+          app.send(:include, RenderMethods)
+        end
+      end
+    end
+
+    register_plugin :server_timing, ServerTiming
+  end
+end

data/lib/sequel/extensions/server_timing.rb

@@ -0,0 +1,21 @@
+# frozen-string-literal: true
+require "sequel"
+
+module RackServerTiming
+  module Sequel
+    def log_duration(duration, message)
+      RackServerTiming::Current.recorder.increment("DB", duration, "Database")
+
+      super
+    end
+
+    def self.extended(base)
+      return unless base.loggers.empty?
+
+      require "logger"
+      base.loggers = [Logger.new("/dev/null")]
+    end
+  end
+
+  ::Sequel::Database.register_extension(:server_timing, RackServerTiming::Sequel)
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rack-server-timing
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Adam Daniels
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/rack-server-timing/current.rb
+- lib/rack-server-timing/metric.rb
+- lib/rack-server-timing/middleware.rb
+- lib/rack-server-timing/recorder.rb
+- lib/roda/plugins/server_timing.rb
+- lib/sequel/extensions/server_timing.rb
+homepage: https://github.com/adam12/rack-server-timing
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Server-Timing headers for Rack applications
+test_files: []