faraday-tracer 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebb9960d735ab728eeb7ea97317ac3378a4b7111
-  data.tar.gz: b9af0f69baaddb24470e057d34e78fb37d9eaa8d
+  metadata.gz: 432de20c11ea8f776a334a35b499a0167f1dc9c5
+  data.tar.gz: a1aefc8b0851bb24e3712ffba9d121c9231803d1
 SHA512:
-  metadata.gz: 30bd6106865461b9fff352d085ed182fc217b1cb9194d9f717bc3cee8cb7f5aa8165cd163cda261d222b6b791e33d7ef5ca2b44540d36affdaab1d8db8f471b3
-  data.tar.gz: 27192e04ec6ce63b7cea72c362e9321e74b91b089fc813d86aa7df984b4caf5fabf56ea4fc380cd541d99010f3e6b3c75a44ae55af37c3b9438415d932552794
+  metadata.gz: bf1faceda09cf8bcfc3f5d6345b540ca06f88bb8dd64fec1d1ec52b722eed5d14a8b4c7d29cee1d34cee0f393c8c78300072ec27042bfa45a256ca3c61b47a66
+  data.tar.gz: f65ec3f75d87f20fd1a7f6e8b4f417997e51beb8f528f26e1219bd8a5d671a9563ba0c477b1fa2a573519c427c3052cec3fa7cc5aa644aad10e1cc42f17ac37e

data/README.md

@@ -1,6 +1,9 @@
 # Faraday::Tracer
 
-OpenTracing compatible Faraday middleware.
+OpenTracing compatible Faraday middleware:
+
+* It wraps all outgoing requests in spans
+* It adds the trace context to outgoing requests
 
 ## Installation
 
@@ -61,6 +64,11 @@ conn = Faraday.new(url: 'http://localhost:3000/') do |faraday|
 end
 ```
 
+### Span name
+
+By default, all spans are given a default name. You may also override this by
+passing a `:span_name` in the middleware options hash and/or the request
+options.
 
 ### Service name
 

data/faraday-tracer.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'faraday-tracer'
-  spec.version       = '0.5.0'
+  spec.version       = '0.6.0'
   spec.authors       = ['SaleMove TechMovers']
   spec.email         = ['techmovers@salemove.com']
 

data/lib/faraday/tracer.rb

@@ -9,22 +9,31 @@ module Faraday
     # @param span [Span, SpanContext, Proc, nil] SpanContext that acts as a parent to
     #        the newly-started by the middleware Span. If a Proc is provided, its
     #        evaluated during the call method invocation.
+    # @param span_name [String, nil] The name of the span to create.
     # @param service_name [String, nil] Remote service name (for some
     #        unspecified definition of "service")
     # @param tracer [OpenTracing::Tracer] A tracer to be used when start_span, and inject
     #        is called.
     # @param errors [Array<Class>] An array of error classes to be captured by the tracer
     #        as errors. Errors are **not** muted by the middleware.
-    def initialize(app, span: nil, service_name: nil, tracer: OpenTracing.global_tracer, errors: [StandardError])
+    def initialize(
+        app,
+        span: nil,
+        span_name: nil,
+        service_name: nil,
+        tracer: OpenTracing.global_tracer,
+        errors: [StandardError]
+    )
       super(app)
       @tracer = tracer
       @parent_span = span
+      @span_name = span_name
       @service_name = service_name
       @errors = errors
     end
 
     def call(env)
-      span = @tracer.start_span(env[:method].to_s.upcase,
+      span = @tracer.start_span(span_name(env),
         child_of: parent_span(env),
         tags: prepare_tags(env)
       )
@@ -42,6 +51,11 @@ module Faraday
 
     private
 
+    def span_name(env)
+      context = env.request.context
+      context.is_a?(Hash) && context[:span_name] || @span_name || env[:method].to_s.upcase
+    end
+
     def parent_span(env)
       context = env.request.context
       span = context.is_a?(Hash) && context[:span] || @parent_span

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-tracer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - SaleMove TechMovers