garage_client 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01091c33f1717e47d9c9924aafdf5847b365db08
-  data.tar.gz: ab7c2d9b32b4231d4cb4d94620dc4c0adfc14f7e
+  metadata.gz: 67db70f420fa5fc41a2a070c99dbbd37eb70f909
+  data.tar.gz: a1caece74b9d92acfc6df7a7e5429e330969401f
 SHA512:
-  metadata.gz: 8cbdf835d83bf950e9efa95d38bea94c2df496886fb5495e098e0648fb4092f34faba05acabd7c743e64d0892bcd90f16f9e49119a1115bae926e33091720b25
-  data.tar.gz: 26a64ed17b4ae544897eea66ca80072ec9ec63760c213a4f05b24cc36ed66de55e57488f39c1224adee73625879fd8c93bf23292dcd297aef9af84af56ed2bf4
+  metadata.gz: 323b4e8bab3eca3cafcdffa6c83c5960b745b1ad7827298d79fd59ad7f44df3e29186a0a295766ae5d2864c29c7e593c671302fbc9b06c96a4a1e59ffd0882f7
+  data.tar.gz: e7bf77480f8e5f46f511f7d66ecba31fdc5da866570a16c3fd683eb6d72e7046be0d65bcbc2b521960169e621193e45046891d11556f343dc175b34d3492848a

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.4.0
+- Support distributed tracing.
+
 ## 2.3.3
 - Fix a bug to not resolve application name when garage_client-rails is bundled.
 - Stop to support ruby version < 2.2.2.

data/README.md

@@ -93,10 +93,12 @@ There are the following options:
 - `adapter` - faraday adapter for http client (default: `:net_http`)
 - `cacher` - take a cacher class in which caching logic is defined (default: nil)
 - `name` - Client's application name, which is embedded in User-Agent by default (default: nil. For Rails, `Rails.application.class.parent_name.underscore` is set by default.)
+  - `name` must be configured globally.
 - `headers` - default http headers (default: `{ "Accept" => "application/json", "User-Agent" => "garage_client #{VERSION} #{name}" }`)
 - `endpoint` - Garage application API endpoint (default: nil)
 - `path_prefix` - API path prefix (default: `'/v1'`)
 - `verbose` - Enable verbose http log (default: `false`)
+- `tracing` - (client instance only) Enable distributed tracing and set a logical name of the down stream service. See detail in "Tracing" section below.
 
 You can configure the global settings:
 
@@ -115,7 +117,6 @@ client = GarageClient::Client.new(
   adapter: :test,
   headers: { "Host" => "garage.example.com" },
   endpoint: "http://localhost:3000",
-  name: 'my-awesome-client',
   path_prefix: "/v2",
   verbose: true,
 )
@@ -199,3 +200,17 @@ end
 
 GarageClient::Client.new(cacher: MyCacher)
 ```
+
+## Tracing
+GarageClient supports distributed tracing. To enable tracing, specify `tracing.tracer` option for `GarageClient::Client` instance.
+Choose one of supported tracers from below. If you want to add new tracer, please give us a PR.
+
+### aws-xray
+Bundle [aws-xray](https://github.com/taiki45/aws-xray) gem in your `Gemfile`, then configure `GarageClient::Client` instance with `tracing.service` option:
+
+```ruby
+require 'aws/xray'
+GarageClient::Client.new(..., tracing: { tracer: 'aws-xray', service: 'user' })
+```
+
+`service` will be `name` of the sub segments.

data/garage_client.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "pry"
   # Until bug fixed: https://github.com/colszowka/simplecov/issues/281
   s.add_development_dependency "simplecov", "~> 0.7.1"
+  s.add_development_dependency "aws-xray"
 end

data/lib/garage_client/cachers/base.rb

@@ -11,7 +11,13 @@ module GarageClient
         if response
           # Faraday::Response#marshal_dump is drop request object and url
           # https://github.com/lostisland/faraday/blob/edacd5eb57ea13accab3097649690ae5f48f421a/lib/faraday/response.rb#L74
-          response.env.merge!(@env) {|_, self_val, other_val| self_val || other_val }
+          #
+          # XXX: We can't use #merge! here because Faraday::Env does not implement
+          # the method as same as Hash#merge! with Faraday v0.12.1.
+          @env.each do |k, v|
+            original = response.env[k]
+            response.env[k] = v if !original && v
+          end
         else
           response = yield
           store.write(key, response, options) if written_to_cache?

data/lib/garage_client/client.rb

@@ -20,6 +20,7 @@ module GarageClient
     property :path_prefix
     property :verbose
 
+    # @option opts [Hash] :tracing enable tracing. See README for detail.
     def initialize(options = {})
       require_necessaries(options)
       @options = options
@@ -57,6 +58,17 @@ module GarageClient
 
     def connection
       Faraday.new(headers: headers, url: endpoint) do |builder|
+        if options[:tracing]
+          case options[:tracing][:tracer]
+          when 'aws-xray'
+            service = options[:tracing][:service]
+            raise 'Configure target service name with `tracing.service`' unless service
+            builder.use Aws::Xray::Faraday, service
+          else
+            raise "`tracing` option specified but GarageClient does not support the tracer: #{options[:tracing][:tracer]}"
+          end
+        end
+
         # Response Middlewares
         builder.use Faraday::Response::Logger if verbose
         builder.use FaradayMiddleware::Mashify
@@ -85,9 +97,6 @@ module GarageClient
       if !options[:endpoint] && !default_options.endpoint
         raise "Missing endpoint configuration"
       end
-      if !options[:name] && !default_options.name
-        raise "Missing name configuration"
-      end
     end
 
     def default_options

data/lib/garage_client/version.rb

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

data/spec/features/tracing_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'aws/xray'
+
+RSpec.describe 'Tracing support' do
+  context 'when `tracing` option is specified' do
+    around do |ex|
+      Aws::Xray.config.client_options = { sock: io }
+      Aws::Xray.trace(name: 'test-app') { ex.run }
+    end
+
+    let(:io) { Aws::Xray::TestSocket.new }
+    let(:client) do
+      GarageClient::Client.new(
+        adapter: [:test, stubs],
+        endpoint: 'http://127.0.0.1',
+        tracing: {
+          tracer: 'aws-xray',
+          service: 'target-app',
+        },
+      )
+    end
+    let(:stubs) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('/campain') { |env| [200, {'Content-Type' => 'application/json'}, '{"campain": false}'] }
+      end
+    end
+
+    specify 'client enables tracing and sends trace data to a local agent' do
+      res = client.get('/campain')
+      expect(res.body.campain).to eq(false)
+
+      io.rewind
+      sent_jsons = io.read.split("\n")
+      expect(sent_jsons.size).to eq(2)
+      body = JSON.parse(sent_jsons[1])
+      expect(body['name']).to eq('target-app')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garage_client
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 platform: ruby
 authors:
 - Cookpad Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: aws-xray
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby client library for the Garage API
 email:
 - kaihatsu@cookpad.com
@@ -210,6 +224,7 @@ files:
 - lib/garage_client/response/raise_http_exception.rb
 - lib/garage_client/version.rb
 - spec/features/configuration_spec.rb
+- spec/features/tracing_spec.rb
 - spec/fixtures/example.yaml
 - spec/fixtures/examples.yaml
 - spec/fixtures/examples_dictionary.yaml
@@ -246,12 +261,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the Garage API
 test_files:
 - spec/features/configuration_spec.rb
+- spec/features/tracing_spec.rb
 - spec/fixtures/example.yaml
 - spec/fixtures/examples.yaml
 - spec/fixtures/examples_dictionary.yaml