server_timing 0.1.0.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ec7b0e1bec24e125a1e936ef05bf9388011ce24
-  data.tar.gz: 769e62995b294916c2669daa8ce25f798f39719e
+  metadata.gz: cf99b600497254e308fd74362017f96bdd508a14
+  data.tar.gz: 4d4e0096db8236d9d7bf46e024e5e9bcce8934dc
 SHA512:
-  metadata.gz: 9f039c8146fd49432ab140bf580295efa99bdc072a6c1ccd313f019e0d22b008fb2be285949ba59cc17c68e9b7b6d8e8383789530f02cedd487ad5606da8ea5f
-  data.tar.gz: 51022a32b1e6e208a6a26cea8ce41e767dbb25d2466cc06c795fc285f0a2c15e87bc1065ccef539137c8b9f6f88c1536504a0aacb7ce634cdb01cc8a908e9ff3
+  metadata.gz: be6282053487a8a35044f941af1780930e317a3cf0a19432941774f4558f5e9293fd081a8232cf9ff62eab0b732d26cad6eabe1a3081081a8f68cac69777c003
+  data.tar.gz: 05031e19f2cbfb2baa6eab0c21d734c253050ff3ee9f109f2a229e8e1200a149423a1a4974a80b05c9b490122d470bebe07044a7243516d5fa164fdb23ad19d7

data/README.md

@@ -1,8 +1,12 @@
-# Server Timing Response Headers for Rails & Rack Apps
+# Server Timing Response Headers for Rails
 
-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.
+Bring Ruby on Rails server-side performance metrics 📈 to Chrome's Developer Tools via the `server_timing` gem. 
 
-![server timing screenshot](https://s3-us-west-1.amazonaws.com/scout-blog/ruby_server_timing.png)
+`server_timing` sends server-side Rails app performance metrics collected from the [scout_apm](https://github.com/scoutapp/scout_apm_ruby) gem to the browser via the [Server Timing](https://w3c.github.io/server-timing/) API. Production-safe™. 
+
+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?x)
 
 ## Gem Installation
 
@@ -18,9 +22,7 @@ And then execute:
 
 ## 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`).
+A minimal Scout config file is required. 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:
 
@@ -36,38 +38,26 @@ If you have a Scout account, no extra configuration is required. If you wish to
 
 [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.
+## Browser Support
 
-## Usage
+As of this writing, [Chrome Canary](https://www.google.com/chrome/browser/canary.html) Versions 66+ display this information.
 
-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
 
-### Instrumentation
-
-#### Auto-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
+### 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
+## Security
 
-#### Ruby on Rails
+* Non-Production Environments (ex: development, staging) - Server timing response headers are sent by default. 
+* Production - The headers must be enabled.
 
-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!`:
+Response headers can be enabled in production by calling `ServerTiming::Auth.ok!`:
 
 ```ruby
 # app/controllers/application_controller.rb
@@ -79,14 +69,25 @@ before_action do
 end
 ```
 
-#### Rack
+To only enable response headers in development and for admins in production:
 
-Headers are always sent. To toggle:
+```ruby
+# app/controllers/application_controller.rb
 
+before_action do
+  if current_user && current_user.admin?
+    ServerTiming::Auth.ok!
+  elsif Rails.env.development?
+    ServerTiming::Auth.ok!
+  else
+    ServerTiming::Auth.deny!
+  end
+end
 ```
-ServerTiming::Auth.ok! # enables on this and all future requests
-ServerTiming::Auth.deny! # disables on this and all future requests
-```
+
+## Overhead
+
+`scout_apm` is designed for use in production apps and is engineered for [low overhead](http://blog.scoutapp.com/articles/2016/02/07/overhead-benchmarks-new-relic-vs-scout) instrumentation.
 
 ## Development
 

data/lib/server_timing.rb

@@ -1,9 +1,12 @@
 module ServerTiming
+  def self.rails?
+    defined? Rails::Railtie
+  end
 end
 
 require "server_timing/auth"
 require "server_timing/middleware"
-require "server_timing/railtie"
+require "server_timing/railtie" if ServerTiming.rails?
 require "server_timing/response_manipulator"
 require "server_timing/store"
 require "server_timing/timing_metric"

data/lib/server_timing/auth.rb

@@ -1,30 +1,46 @@
 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.
+    def self.ok!
+      self.state=true
+    end
 
-      false
+    def self.deny!
+      self.state=false
     end
 
-    def self.ok!
-      Thread.current[:server_timing_authorized] = true
+    def self.reset!
+      self.state=nil
     end
 
-    def self.deny!
-      Thread.current[:server_timing_authorized] = nil
+    def self.state=(new_state)
+      Thread.current[:server_timing_authorized] = new_state
     end
 
+    # Can be one of three values:
+    # * true
+    # * false
+    # * nil (default)
     def self.state
       Thread.current[:server_timing_authorized]
     end
 
     def self.permitted?
-      return true unless required?
+      if state
+        return true
+      elsif state.is_a?(FalseClass)
+        return false
+      else # implied access - state has not been set
+        # If not Rails, return true
+        return true if !ServerTiming.rails?
+
+        # If in a non-production environment, permit
+        return true if !Rails.env.production?
+
+        # In production, return false if no state has been set
+        return false if Rails.env.production?
+      end
 
-      state
     end
   end
 end

data/lib/server_timing/middleware.rb

@@ -10,10 +10,11 @@ module ServerTiming
         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}")
+        puts "ServerTiming raised an exception: #{e.message}, #{e.backtrace}"
         rack_response
       ensure
-        ServerTiming::Auth.deny!
+        # Reset auth after each request
+        ServerTiming::Auth.reset!
       end
 
     end

data/lib/server_timing/response_manipulator.rb

@@ -1,4 +1,5 @@
 module ServerTiming
+  # Adds the 'Server-Timing' response header w/metrics from Scout.
   class ResponseManipulator
     attr_reader :rack_response
     attr_reader :rack_status, :rack_headers, :rack_body
@@ -21,7 +22,11 @@ module ServerTiming
       rebuild_rack_response
     end
 
+    # Checks if we should attempt to gather metrics. 
     def preconditions_met?
+      # tracked_request.root_layer is nil for Rack apps ... unsure why.
+      return false unless tracked_request.root_layer
+
       Auth.permitted?
     end
 
@@ -40,6 +45,7 @@ module ServerTiming
     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)

data/lib/server_timing/version.rb

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

data/server_timing.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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.summary       = %q{View server-side performance metrics in your browser.}
   spec.homepage      = "https://github.com/scoutapp/ruby_server_timing"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: server_timing
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Derek Haynes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,15 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 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.
+summary: View server-side performance metrics in your browser.
 test_files: []
 has_rdoc: