pliny 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 683200fbb66f5d6b6961b584480ce759a6ed08d8
-  data.tar.gz: 49cc9f605818c73a711c442bc3a5315dd3c75ea4
+  metadata.gz: 6b59272bbe834eaf737b9ffe3e4769e54f8897cf
+  data.tar.gz: 13bfa08975ac6f65c74a686e54cf22608bbab639
 SHA512:
-  metadata.gz: 117170ba5de6e6bacc2c6d02c15dae9de1425fdb8be491bac7d60cf123161ce0a15fb77801b0eb83ed14067349adc59c8a4a6e84b8f5bc75e50de68870d55a7f
-  data.tar.gz: 8e94bbf374d67232644e892ede8c2d9c919e58176172158b48be927a106d0502410c4bde61b3a1957327bffdda37796052148e5b36ce8fe927e405f4cefe701a
+  metadata.gz: 1d76b1d6abaf678044111133e3fcb4aa587b88e87c866d8e60adbc03543e77f6e1cb959609eea9b8bb75931ea6f206c49c8447852b4035ca00a6360bd4408e0c
+  data.tar.gz: 8a4e54331f8642b58176358fb3d57845cf623dc93a3d8e0bdd301ea853a84ee29db9c2d1dc5567b6db6cf3fc5f920d8348b419a09f0b3a4ae49593597110b4d6

data/lib/pliny.rb

@@ -2,6 +2,7 @@ require "multi_json"
 require "sinatra/base"
 
 require_relative "pliny/version"
+require_relative "pliny/canonical_log_line_helpers"
 require_relative "pliny/error_reporters"
 require_relative "pliny/errors"
 require_relative "pliny/helpers/encode"
@@ -14,6 +15,7 @@ require_relative "pliny/request_store"
 require_relative "pliny/rollbar_logger"
 require_relative "pliny/router"
 require_relative "pliny/utils"
+require_relative "pliny/middleware/canonical_log_line"
 require_relative "pliny/middleware/cors"
 require_relative "pliny/middleware/instruments"
 require_relative "pliny/middleware/metrics"

data/lib/pliny/canonical_log_line_helpers.rb

@@ -0,0 +1,46 @@
+module Pliny
+  # Helpers to produce a canonical log line. This mostly amounts to a set of
+  # accessors that do basic type checking combined with tracking an internal
+  # schema so that we can produce a hash of everything that's been set so far.
+  module CanonicalLogLineHelpers
+    module ClassMethods
+      def log_field(name, type)
+        unless name.is_a?(Symbol)
+          raise ArgumentError, "Expected first argument to be a symbol"
+        end
+
+        @fields ||= {}
+        @fields[name] = type
+        define_method(:"#{name}=") do |val|
+          set_field(name, val)
+        end
+      end
+    end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    def to_h
+      @values
+    end
+
+    private
+
+    def set_field(name, value)
+      type = self.class.instance_variable_get(:@fields)[name]
+
+      unless type
+        raise ArgumentError, "Field #{name} undefined"
+      end
+
+      if !value.nil? && !value.is_a?(type)
+        raise ArgumentError,
+          "Expected #{name} to be type #{type} (was #{value.class.name})"
+      end
+
+      @values ||= {}
+      @values[name] = value
+    end
+  end
+end

data/lib/pliny/log.rb

@@ -4,6 +4,10 @@ module Pliny
       log_to_stream(stdout || $stdout, merge_log_contexts(data), &block)
     end
 
+    def log_without_context(data, &block)
+      log_to_stream(stdout || $stdout, data, &block)
+    end
+
     def log_exception(e, data = {})
       exception_id = e.object_id
 

data/lib/pliny/middleware/canonical_log_line.rb

@@ -0,0 +1,125 @@
+module Pliny::Middleware
+  # Emits a "canonical log line", i.e. a single log line that contains as much
+  # relevant information about a request as possible and which makes for a
+  # single convenient reference point to understand all the vitals of any
+  # single request.
+  #
+  # This default implementation contains some useful data to get a project
+  # started, but it's usually recommended to vendor this middleware into your
+  # project and start adding some custom fields. Some examples of those might
+  # be:
+  #
+  #     * ID and email of an authenticated user.
+  #     * ID of API key used, OAuth application and scope.
+  #     * Remaining and total rate limits.
+  #     * Name of the service, HEAD revision, release number.
+  #     * Name of the internal system that initiated the request.
+  #
+  class CanonicalLogLine
+    # LogLine is a nested model that allows us to construct a canonical log
+    # line in a way that's reasonably well organized and somewhat type safe.
+    # It's responsible for hashifying its defined fields for emission into a
+    # log stream or elsewhere.
+    class LogLine
+      include Pliny::CanonicalLogLineHelpers
+
+      #
+      # error
+      #
+
+      log_field :error_class, String
+      log_field :error_id, String
+      log_field :error_message, String
+
+      #
+      # request
+      #
+
+      log_field :request_id, String
+      log_field :request_method, String
+      log_field :request_ip, String
+      log_field :request_path, String
+      log_field :request_route_signature, String
+      log_field :request_user_agent, String
+
+      #
+      # response
+      #
+
+      log_field :response_length, Integer
+      log_field :response_status, Integer
+
+      #
+      # timing
+      #
+
+      log_field :timing_total_elapsed, Float
+    end
+
+    def initialize(app, emitter:)
+      @app = app
+      @emitter = emitter
+    end
+
+    def call(env)
+      begin
+        start = Time.now
+        status, headers, response = @app.call(env)
+      ensure
+        begin
+          line = LogLine.new
+
+          #
+          # error
+          #
+
+          if error = env["pliny.error"]
+            line.error_class = error.class.name
+            line.error_message = error.message
+            if error.is_a?(Pliny::Errors::Error)
+              line.error_id = error.id.to_s
+            end
+          end
+
+          #
+          # request
+          #
+
+          request = Rack::Request.new(env)
+          line.request_id = env["REQUEST_ID"]
+          line.request_ip = request.ip
+          line.request_method = request.request_method
+          line.request_path = request.path_info
+          line.request_user_agent = request.user_agent
+          if route = env["sinatra.route"]
+            line.request_route_signature = route.split(" ").last
+          end
+
+          #
+          # response
+          #
+
+          if length = headers["Content-Length"]
+            line.response_length = length.to_i
+          end
+          line.response_status = status
+
+          #
+          # timing
+          #
+
+          line.timing_total_elapsed = (Time.now - start).to_f
+
+          @emitter.call(line.to_h)
+        rescue => e
+          # We hope that a canonical log line never fails, but in case it
+          # does, do not fail the request because it did.
+          Pliny.log(message: "Failed to emit canonical log line")
+          Pliny::ErrorReporters.notify(e, rack_env: env)
+        end
+      end
+
+      [status, headers, response]
+    end
+  end
+end

data/lib/pliny/middleware/rescue_errors.rb

@@ -9,12 +9,20 @@ module Pliny::Middleware
     def call(env)
       @app.call(env)
     rescue Pliny::Errors::Error => e
+      set_error_in_env(env, e)
       Pliny::Errors::Error.render(e)
     rescue => e
+      set_error_in_env(env, e)
       raise if @raise
 
       Pliny::ErrorReporters.notify(e, rack_env: env)
       Pliny::Errors::Error.render(Pliny::Errors::InternalServerError.new(@message))
     end
+
+    # Sets the error in a predefined env key for use by the upstream
+    # CanonicalLogLine middleware.
+    def set_error_in_env(env, e)
+      env["pliny.error"] = e
+    end
   end
 end

data/lib/pliny/version.rb

@@ -1,3 +1,3 @@
 module Pliny
-  VERSION = "0.23.0"
+  VERSION = "0.24.0"
 end

data/lib/template/Gemfile

@@ -4,7 +4,7 @@ ruby "2.3.3"
 gem "multi_json"
 gem "oj"
 gem "pg"
-gem "pliny", "~> 0.23"
+gem "pliny", "~> 0.24"
 gem "pry"
 gem "puma", "~> 3"
 gem "rack-ssl"

data/lib/template/lib/routes.rb

@@ -4,7 +4,10 @@ Routes = Rack::Builder.new do
   use Pliny::Middleware::RequestID
   use Pliny::Middleware::RequestStore::Seed, store: Pliny::RequestStore
   use Pliny::Middleware::Metrics
-  use Pliny::Middleware::Instruments
+  use Pliny::Middleware::CanonicalLogLine,
+      emitter: -> (data) {
+        Pliny.log_without_context({ canonical_log_line: true }.merge(data))
+      }
   use Pliny::Middleware::RescueErrors, raise: Config.raise_errors?
   if Config.timeout.positive?
     use Rack::Timeout,

data/spec/canonical_log_line_helpers_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe Pliny::CanonicalLogLineHelpers do
+  class TestCanonicalLogLine
+    include Pliny::CanonicalLogLineHelpers
+
+    log_field :field_float, Float
+    log_field :field_integer, Integer
+    log_field :field_string, String
+  end
+
+  it "allows a field to be set" do
+    line = TestCanonicalLogLine.new
+    line.field_string = "foo"
+  end
+
+  it "allows nils to be set" do
+    line = TestCanonicalLogLine.new
+    line.field_string = nil
+  end
+
+  it "rejects values that are of the wrong type" do
+    line = TestCanonicalLogLine.new
+    e = assert_raises ArgumentError do
+      line.field_string = true
+    end
+    assert_equal "Expected field_string to be type String (was TrueClass)",
+      e.message
+  end
+
+  it "produces a hash with #to_h" do
+    line = TestCanonicalLogLine.new
+    line.field_float = 3.14
+    line.field_integer = 42
+    line.field_string = "foo"
+    assert_equal({ field_float: 3.14, field_integer: 42, field_string: "foo" },
+      line.to_h)
+  end
+end

data/spec/log_spec.rb

@@ -38,6 +38,12 @@ describe Pliny::Log do
     Pliny.log(foo: "bar")
   end
 
+  it "logs without context" do
+    Pliny.default_context = { app: "pliny" }
+    expect(@io).to receive(:print).with("foo=bar\n")
+    Pliny.log_without_context(foo: "bar")
+  end
+
   it "merges context from RequestStore" do
     Pliny::RequestStore.store[:log_context] = { app: "pliny" }
     expect(@io).to receive(:print).with("app=pliny foo=bar\n")

data/spec/middleware/canonical_log_line_spec.rb

@@ -0,0 +1,88 @@
+require "spec_helper"
+
+describe Pliny::Middleware::CanonicalLogLine do
+  def app
+    Rack::Builder.new do
+      run Sinatra.new {
+        use Pliny::Middleware::RequestID
+
+        use Pliny::Middleware::CanonicalLogLine,
+          emitter: -> (data) { Pliny.log_without_context(data) }
+
+        use Pliny::Middleware::RescueErrors, raise: false
+
+        get "/apps/:id" do
+          status 201
+          "hi"
+        end
+
+        get "/generic-error" do
+          raise ArgumentError, "argument error"
+        end
+
+        get "/pliny-error" do
+          raise Pliny::Errors::NotFound
+        end
+      }
+    end
+  end
+
+  it "emits on a successful request" do
+    data = {}
+    expect(Pliny).to receive(:log_without_context) { |d| data = d }
+
+    header "User-Agent", "rack-test"
+    get "/apps/123"
+
+    assert_match Pliny::Middleware::RequestID::UUID_PATTERN,
+      data[:request_id]
+    assert_equal "127.0.0.1", data[:request_ip]
+    assert_equal "GET", data[:request_method]
+    assert_equal "/apps/123", data[:request_path]
+    assert_equal "/apps/:id", data[:request_route_signature]
+    assert_equal "rack-test", data[:request_user_agent]
+
+    assert_equal 2, data[:response_length]
+    assert_equal 201, data[:response_status]
+  end
+
+  it "never fails a request on failure" do
+    expect(Pliny).to receive(:log).with(
+      message: "Failed to emit canonical log line")
+    expect(Pliny).to receive(:log_without_context) { |d| raise "bang!" }
+
+    get "/apps/123"
+    assert_equal 201, last_response.status
+  end
+
+  it "emits on generic error" do
+    data = {}
+    expect(Pliny).to receive(:log_without_context) { |d| data = d }
+    get "/generic-error"
+
+    assert_equal "ArgumentError", data[:error_class]
+    assert_equal "argument error", data[:error_message]
+
+    assert_equal "GET", data[:request_method]
+    assert_equal "/generic-error", data[:request_path]
+    assert_equal "/generic-error", data[:request_route_signature]
+
+    assert_equal 500, data[:response_status]
+  end
+
+  it "emits on Pliny error" do
+    data = {}
+    expect(Pliny).to receive(:log_without_context) { |d| data = d }
+    get "/pliny-error"
+
+    assert_equal "Pliny::Errors::NotFound", data[:error_class]
+    assert_equal "Not found.", data[:error_message]
+    assert_equal "not_found", data[:error_id]
+
+    assert_equal "GET", data[:request_method]
+    assert_equal "/pliny-error", data[:request_path]
+    assert_equal "/pliny-error", data[:request_route_signature]
+
+    assert_equal 404, data[:response_status]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pliny
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Brandur Leach
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,20 +17,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -376,6 +376,7 @@ files:
 - bin/pliny-new
 - bin/pliny-update
 - lib/pliny.rb
+- lib/pliny/canonical_log_line_helpers.rb
 - lib/pliny/commands/creator.rb
 - lib/pliny/commands/generator.rb
 - lib/pliny/commands/generator/base.rb
@@ -397,6 +398,7 @@ files:
 - lib/pliny/log.rb
 - lib/pliny/metrics.rb
 - lib/pliny/metrics/backends/logger.rb
+- lib/pliny/middleware/canonical_log_line.rb
 - lib/pliny/middleware/cors.rb
 - lib/pliny/middleware/instruments.rb
 - lib/pliny/middleware/metrics.rb
@@ -469,6 +471,7 @@ files:
 - lib/template/spec/spec_support/auto_define_rack_app.rb
 - lib/template/spec/spec_support/coverage.rb
 - lib/template/spec/spec_support/log.rb
+- spec/canonical_log_line_helpers_spec.rb
 - spec/commands/creator_spec.rb
 - spec/commands/generator/base_spec.rb
 - spec/commands/generator/endpoint_spec.rb
@@ -490,6 +493,7 @@ files:
 - spec/log_spec.rb
 - spec/metrics/backends/logger_spec.rb
 - spec/metrics_spec.rb
+- spec/middleware/canonical_log_line_spec.rb
 - spec/middleware/cors_spec.rb
 - spec/middleware/instruments_spec.rb
 - spec/middleware/metrics_spec.rb
@@ -524,7 +528,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Basic tooling to support API apps in Sinatra