the_garage 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9ee99351350b8a8ee6000590003952aebc06515
-  data.tar.gz: eba9c748cfe782a481a799857c633d663ac99e54
+  metadata.gz: df6a793861e979f1a7849b0d6ef3ef5764757980
+  data.tar.gz: df87e84d9f87372c8c2061d4aafabd6849d89b52
 SHA512:
-  metadata.gz: 864aaa96191d81364a174f95ac5779578392d928a7c76bb8edefeb7b12df748e2b40cb3aced29415a7eba84520b161ce866dad8fceac143f1d4c0bb38b536afd
-  data.tar.gz: bcd8e23f4aaa5728b6995bb41a83d24ad7420756b206eedee28579253aaebe67812ca26f203ef8fd8a219c4db5f695fece39989e85e9b14b19c1bb6d01fe5fc8
+  metadata.gz: 996522903af5c5b250cb7a99f41a8ed095a23c17b36076cd8bf34409b16d02b4f5ec6196b357238b1726452d8ceba415b481d4f2f56abbc7c19997972a557c97
+  data.tar.gz: c96ace465cac6ade9d7b477ab3c58b457b660e709067490213154f5b017392ca717b87980dd7058ada25ede679ad2de6c2d17ab43b20dbaf9259264c58e5b6a6

data/README.md

@@ -47,9 +47,15 @@ class Employee < ActiveRecord::Base
 end
 ```
 
-In your controller class:
+In your controller classes:
 
 ```ruby
+class ApplicationController < ActionController::Base
+  include Garage::ControllerHelper
+  
+  # ...
+end
+
 class EmployeesController < ApplicationController
   include Garage::RestfulActions
 
@@ -181,6 +187,21 @@ module MyStrategy
 end
 ```
 
+## Distributed tracing
+In case you use auth-server strategy, you can setup distributed tracing for the service communication between garage application and auth server.
+Currently, we support following tracers:
+
+- `aws-xray` using [aws-xray](https://github.com/taiki45/aws-xray) gem.
+  - Bundle `aws-xray` gem in your application.
+  - Configure `service` option for a logical service name of the auth server.
+
+```ruby
+# e.g. aws-xray tracer
+require 'aws/xray'
+Garage::Tracer::AwsXrayTracer.service = 'your-auth-server-name'
+Garage.configuration.tracer = Garage::Tracer::AwsXrayTracer
+```
+
 ## Development
 
 See [DEVELOPMENT.md](DEVELOPMENT.md).

data/lib/garage/config.rb

@@ -36,6 +36,14 @@ module Garage
       instance_variable_defined?(:@strategy) ? @strategy : Garage::Strategy::NoAuthentication
     end
 
+    # Support distributed tracing for auth server accesses.
+    #
+    # @param [Ojbect] tracer an object which implements tracer methods. See Garage::Tracer::NullTracer.
+    attr_writer :tracer
+    def tracer
+      @tracer ||= Garage::Tracer::NullTracer
+    end
+
     def docs
       @docs ||= Docs::Config.new
     end

data/lib/garage/strategy/auth_server.rb

@@ -2,6 +2,8 @@ require 'json'
 require 'net/http'
 require 'uri'
 
+require 'garage/tracer'
+
 module Garage
   module Strategy
     module AuthServer
@@ -71,8 +73,13 @@ module Garage
         private
 
         def get
-          raw = http_client.get(path_with_query, header)
-          Response.new(raw)
+          Tracer.start do |tracer|
+            request_header = tracer.inject_trace_context(header)
+            tracer.record_http_request('GET', uri.to_s, request_header['User-Agent'])
+            raw = http_client.get(path_with_query, request_header)
+            tracer.record_http_response(raw.code.to_i, raw['Content-Length'] || 0)
+            Response.new(raw)
+          end
         end
 
         def header

data/lib/garage/tracer.rb

@@ -0,0 +1,89 @@
+module Garage
+  module Tracer
+    extend self
+    extend Forwardable
+
+    def_delegators :tracer, :start, :inject_trace_context, :record_http_request, :record_http_response
+
+    private
+
+    def tracer
+      Garage.configuration.tracer
+    end
+
+    # Any tracers must have `.start` to start tracing context and:
+    #   - `#inject_trace_context` to add tracing context to the given request header.
+    #   - `#record_http_request` to record http request in tracer.
+    #   - `#record_http_response` to recrod http response in tracer.
+    class NullTracer
+      def self.start(&block)
+        yield new
+      end
+
+      # @param [Hash] header
+      # @return [Hash]
+      def inject_trace_context(header)
+        header
+      end
+
+      # @param [String] method
+      # @param [String] url
+      # @param [String] user_agent
+      # @return [nil]
+      def record_http_request(method, url, user_agent)
+      end
+
+      # @param [Integer] status
+      # @param [Integer] content_length
+      def record_http_response(status, content_length)
+      end
+    end
+
+    class AwsXrayTracer
+      class << self
+        attr_accessor :service
+      end
+
+      def self.start(&block)
+        if Aws::Xray::Context.started?
+          Aws::Xray::Context.current.child_trace(remote: true, name: service) do |sub|
+            yield new(sub)
+          end
+        else
+          yield NullTracer.new
+        end
+      end
+
+      def initialize(sub_segment)
+        @sub = sub_segment
+      end
+
+      def inject_trace_context(header)
+        header.merge('X-Amzn-Trace-Id' => @sub.generate_trace.to_header_value)
+      end
+
+      def record_http_request(method, url, user_agent)
+        request = Aws::Xray::Request.build(method: method.to_s.upcase, url: url, user_agent: user_agent)
+        @sub.set_http_request(request)
+      end
+
+      def record_http_response(status, content_length)
+        @sub.set_http_response(status, content_length || 0)
+
+        case status
+        when 499
+          cause = Aws::Xray::Cause.new(stack: caller, message: 'Got 499', type: 'http_request_error')
+          @sub.set_error(error: true, throttle: true, cause: cause)
+        when 400..498
+          cause = Aws::Xray::Cause.new(stack: caller, message: 'Got 4xx', type: 'http_request_error')
+          @sub.set_error(error: true, cause: cause)
+        when 500..599
+          cause = Aws::Xray::Cause.new(stack: caller, message: 'Got 5xx', type: 'http_request_error')
+          @sub.set_error(fault: true, remote: true, cause: cause)
+        else
+          # pass
+        end
+      end
+    end
+  end
+end

data/lib/garage/version.rb

@@ -1,3 +1,3 @@
 module Garage
-  VERSION = '2.3.3'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_garage
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 platform: ruby
 authors:
 - Tatsuhiko Miyagawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -247,11 +247,13 @@ files:
 - lib/garage/strategy/test.rb
 - lib/garage/test/migrator.rb
 - lib/garage/token_scope.rb
+- lib/garage/tracer.rb
 - lib/garage/utils.rb
 - lib/garage/version.rb
 - lib/the_garage.rb
 homepage: https://github.com/cookpad/garage
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -269,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Garage Platform Engine