server_timing 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ec7b0e1bec24e125a1e936ef05bf9388011ce24
+  data.tar.gz: 769e62995b294916c2669daa8ce25f798f39719e
+SHA512:
+  metadata.gz: 9f039c8146fd49432ab140bf580295efa99bdc072a6c1ccd313f019e0d22b008fb2be285949ba59cc17c68e9b7b6d8e8383789530f02cedd487ad5606da8ea5f
+  data.tar.gz: 51022a32b1e6e208a6a26cea8ce41e767dbb25d2466cc06c795fc285f0a2c15e87bc1065ccef539137c8b9f6f88c1536504a0aacb7ce634cdb01cc8a908e9ff3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in server_timing.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Derek Haynes
+
+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,105 @@
+# Server Timing Response Headers for Rails & Rack Apps
+
+The `server_timing` gem brings server-side performance metrics collected by the [scout_apm gem](https://github.com/scoutapp/scout_apm_ruby) to your browser via the [Server Timing](https://w3c.github.io/server-timing/) API. Works on any Ruby framework supported by `scout_apm`. A [Scout](https://scoutapp.com) account is not required.
+
+![server timing screenshot](https://s3-us-west-1.amazonaws.com/scout-blog/ruby_server_timing.png)
+
+## Gem Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'server_timing'
+```
+
+And then execute:
+
+    $ bundle
+
+## Configuration
+
+### Ruby on Rails
+
+For Rails apps, the only required configuration step is setting up a minimal Scout config file. The `server_timing` gem reports metrics collected by the [scout_apm](https://github.com/scoutapp/scout_apm_ruby) gem (added as a dependency of `server_timing`).
+
+If you don't have a Scout account, copy and paste the following minimal configuration into a `RAILS_ROOT/config/scout_apm.yml` file:
+
+```yaml
+common: &defaults
+  monitor: true
+
+production:
+  <<: *defaults
+```
+
+If you have a Scout account, no extra configuration is required. If you wish to see server timing metrics in development, ensure `monitor: true` is set for the `development` environment in the `scout_apm.yml` file.
+
+[See the scout_apm configuration reference](http://help.apm.scoutapp.com/#ruby-configuration-options) for more information.
+
+### Rack
+
+Use the `ServerTiming::Middleware`:
+
+```ruby
+# config.ru
+require 'server_timing'
+use ServerTiming::Middleware
+```
+
+* Add the minimal Scout config above to `APP_ROOT/scout_apm.yml`.
+* Scout requires additional steps to instrument Rack applications. [See the guide](http://help.apm.scoutapp.com/#rack). Without these steps, the instrumentation will not execute and server timing metrics will not be reported.
+
+## Usage
+
+The `server_timing` gem exposes server-side performance metrics collected by the `scout_apm` gem inside your browser. As of this writing, [Chrome Canary](https://www.google.com/chrome/browser/canary.html) Versions 66+ display this information.
+
+### Instrumentation
+
+#### Auto-Instrumentation
+
+By default, the total time consumed by each of the libraries `scout_apm` instruments is reported. This includes ActiveRecord, HTTP, Redis, and more. [View the full list of supported libraries](http://help.apm.scoutapp.com/#ruby-instrumented-libs). 
+
+#### Custom Instrumentation
+
+Collect performance data on additional method calls by adding custom instrumentation via `scout_apm`. [See the docs for instructions](http://help.apm.scoutapp.com/#ruby-custom-instrumentation).
+
+### Security
+
+#### Ruby on Rails
+
+By default, server timing response times are sent in non-development environments. In production, __the headers must be explicitly enabled__ by calling `ServerTiming::Auth.ok!`:
+
+```ruby
+# app/controllers/application_controller.rb
+
+before_action do
+  if current_user && current_user.admin?
+    ServerTiming::Auth.ok!
+  end
+end
+```
+
+#### Rack
+
+Headers are always sent. To toggle:
+
+```
+ServerTiming::Auth.ok! # enables on this and all future requests
+ServerTiming::Auth.deny! # disables on this and all future requests
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/scoutapp/ruby_server_timing.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "server_timing"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/server_timing.rb

@@ -0,0 +1,10 @@
+module ServerTiming
+end
+
+require "server_timing/auth"
+require "server_timing/middleware"
+require "server_timing/railtie"
+require "server_timing/response_manipulator"
+require "server_timing/store"
+require "server_timing/timing_metric"
+require "server_timing/version"

data/lib/server_timing/auth.rb

@@ -0,0 +1,30 @@
+module ServerTiming
+  # Encapsulates logic that determines whether the user is properly authorized to view server timing response headers.
+  class Auth
+    def self.required?
+      return false unless defined? Rails::Railtie # will send headers by default for Rack apps
+
+      return true if Rails.env.production? # Requires a call to `ServerTiming::Auth.ok!` for Rails apps in the production environment.
+
+      false
+    end
+
+    def self.ok!
+      Thread.current[:server_timing_authorized] = true
+    end
+
+    def self.deny!
+      Thread.current[:server_timing_authorized] = nil
+    end
+
+    def self.state
+      Thread.current[:server_timing_authorized]
+    end
+
+    def self.permitted?
+      return true unless required?
+
+      state
+    end
+  end
+end

data/lib/server_timing/middleware.rb

@@ -0,0 +1,21 @@
+module ServerTiming
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      rack_response = @app.call(env)
+      begin
+        ResponseManipulator.new(env, rack_response).call
+      rescue Exception => e
+        # If anything went wrong at all, just bail out and return the unmodified response.
+        puts("ServerTiming: Raised an exception: #{e.message}, #{e.backtrace}")
+        rack_response
+      ensure
+        ServerTiming::Auth.deny!
+      end
+
+    end
+  end
+end

data/lib/server_timing/railtie.rb

@@ -0,0 +1,7 @@
+module ServerTiming
+  class Railtie < Rails::Railtie
+    initializer "server_timing.configure_rails_initialization" do |app|
+      app.middleware.use ServerTiming::Middleware
+    end
+  end
+end

data/lib/server_timing/response_manipulator.rb

@@ -0,0 +1,68 @@
+module ServerTiming
+  class ResponseManipulator
+    attr_reader :rack_response
+    attr_reader :rack_status, :rack_headers, :rack_body
+    attr_reader :env
+
+    def initialize(env, rack_response)
+      @env = env
+      @rack_response = rack_response
+
+      @rack_status = rack_response[0]
+      @rack_headers = rack_response[1]
+      @rack_body = rack_response[2]
+    end
+
+    def call
+      return rack_response unless preconditions_met?
+
+      store_metrics
+      add_header
+      rebuild_rack_response
+    end
+
+    def preconditions_met?
+      Auth.permitted?
+    end
+
+    def add_header
+      rack_headers['Server-Timing'] = payload
+    end
+
+    def tracked_request
+      @tracked_request ||= ScoutApm::RequestManager.lookup
+    end
+
+    def store
+      @store ||= ServerTiming::Store.new
+    end
+
+    def store_metrics
+      layer_finder = ScoutApm::LayerConverters::FindLayerByType.new(tracked_request)
+      converters = [ScoutApm::LayerConverters::MetricConverter]
+      walker = ScoutApm::LayerConverters::DepthFirstWalker.new(tracked_request.root_layer)
+      converters = converters.map do |klass|
+        instance = klass.new(ScoutApm::Agent.instance.context, tracked_request, layer_finder, store)
+        instance.register_hooks(walker)
+        instance
+      end
+      walker.walk
+      converters.each {|i| i.record! }
+    end
+
+    def server_timing_metrics
+      @server_timing_metrics ||= store.metrics.map { |meta, stats| TimingMetric.from_scout(meta,stats)}
+    end
+
+
+    def payload
+      headers = server_timing_metrics.map(&:to_header)
+      headers << TimingMetric.new('Total', server_timing_metrics.map(&:duration).reduce(0,:+)).to_header
+      headers.join(",")
+    end
+
+    def rebuild_rack_response
+      [rack_status, rack_headers, rack_body]
+    end
+  end
+end

data/lib/server_timing/store.rb

@@ -0,0 +1,12 @@
+module ServerTiming
+  class Store
+    attr_reader :metrics
+
+    def initialize
+    end
+
+    def track!(metrics, options={})
+      @metrics = metrics
+    end
+  end
+end

data/lib/server_timing/timing_metric.rb

@@ -0,0 +1,29 @@
+module ServerTiming
+  # Encapsulates a single metric that should be sent inside the server timing response header.
+  class TimingMetric
+    attr_reader :name
+    attr_reader :duration
+    attr_reader :description
+
+    def self.from_scout(meta,stats)
+      name = meta.type
+      duration = stats.total_exclusive_time*1000
+      new(name, duration)
+    end
+
+    def initialize(name,duration, description: nil)
+      @name        = name
+      @duration    = duration
+      @description = description
+    end
+
+    def to_header
+      "#{name}; dur=#{duration.to_d.truncate(2).to_f}; #{description_to_header}"
+    end
+
+    def description_to_header
+      return unless description
+      "desc='#{description}';"
+    end
+  end
+end

data/lib/server_timing/version.rb

@@ -0,0 +1,3 @@
+module ServerTiming
+  VERSION = "0.1.0.pre"
+end

data/server_timing.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'server_timing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "server_timing"
+  spec.version       = ServerTiming::VERSION
+  spec.authors       = ["Derek Haynes"]
+  spec.email         = ["derek.haynes@gmail.com"]
+
+  spec.summary       = %q{View server-side performance metrics (ActiveRecord, external HTTP calls, Redis, etc) in your browser developer tools via server timing response headers.}
+  spec.homepage      = "https://github.com/scoutapp/ruby_server_timing"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "scout_apm"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: server_timing
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Derek Haynes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: scout_apm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- derek.haynes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/server_timing.rb
+- lib/server_timing/auth.rb
+- lib/server_timing/middleware.rb
+- lib/server_timing/railtie.rb
+- lib/server_timing/response_manipulator.rb
+- lib/server_timing/store.rb
+- lib/server_timing/timing_metric.rb
+- lib/server_timing/version.rb
+- server_timing.gemspec
+homepage: https://github.com/scoutapp/ruby_server_timing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: View server-side performance metrics (ActiveRecord, external HTTP calls,
+  Redis, etc) in your browser developer tools via server timing response headers.
+test_files: []
+has_rdoc: