gruf-zipkin 0.10.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 689a4f4eb5b71ae46c6c5ccc40859e3ab8de4d2e
-  data.tar.gz: 0ea5e97b910428e0aa01200b5eae9358a473822f
+  metadata.gz: 081c50dadfb6eba85262365f7b2f073fa541ad3f
+  data.tar.gz: 57d74e314465b774ffff74b74af04b607c567f1d
 SHA512:
-  metadata.gz: 085309d83c7684b359b95d3975671170be17faab92106bae9f35924e8986d2ee0b11a5adde3b872dfb53c09f9c5d449e54c843d16f264a5b48ddd53396a6b35d
-  data.tar.gz: 4a6613b0b14e97ccb83f44ce119b7526701bb127723fd1012784499f0a5c3d9c6555ec81c1a0de305ecc180399ad6f994923c4b47e5e86f9cdca83a7f64da58c
+  metadata.gz: 64d5c4cece14c36b01fabefca98808d498edba216116dafe197761e4ad32de90befd4bfed5f5e68dd04435f1c391c9be2493399eb5e02c754464ff76dae0129b
+  data.tar.gz: c2e5b669752cc72c7b010b360af15999dc6d60b151e61a8e584b065e9296b6df8701f4403601c4a761d30c3ead23d85bdb2f9c16c71b6d3a68f4a5d614e98f6c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 Changelog for the gruf-zipkin gem.
 
+h3. 1.0.0
+
+- Support for gruf 2.0.0
+
 h3. 0.10.3
 
 - Update to 0.10.3, add rubocop+bundler-audit

data/README.md

@@ -1,8 +1,8 @@
 # gruf-zipkin - Zipkin tracing for gruf
 
-[![Build Status](https://travis-ci.org/bigcommerce/gruf-zipkin.svg?branch=master)](https://travis-ci.org/bigcommerce/gruf-zipkin)
+[![Build Status](https://travis-ci.org/bigcommerce/gruf-zipkin.svg?branch=master)](https://travis-ci.org/bigcommerce/gruf-zipkin) [![Gem Version](https://badge.fury.io/rb/gruf-zipkin.svg)](https://badge.fury.io/rb/gruf-zipkin) [![Inline docs](http://inch-ci.org/github/bigcommerce/gruf-zipkin.svg?branch=master)](http://inch-ci.org/github/bigcommerce/gruf-zipkin)
 
-Adds Zipkin tracing support for [gruf](https://github.com/bigcommerce/gruf) 1.0.0 or later.
+Adds Zipkin tracing support for [gruf](https://github.com/bigcommerce/gruf) 2.0.0+.
 
 ## Installation
 
@@ -25,9 +25,8 @@ Rails.application.config.zipkin_tracer = {
   sample_rate: 0.1 # 0.0 to 1.0, where 1.0 => 100% of requests 
 }
 Gruf.configure do |c|
-  c.hook_options[:zipkin] = Rails.application.config.zipkin_tracer
+  c.interceptors.use(Gruf::Zipkin::Interceptor, Rails.application.config.zipkin_tracer)
 end
-Gruf::Hooks::Registry.add(:zipkin, Gruf::Zipkin::Hook)
 ```
 
 This assumes you have Zipkin already setup in your Ruby/Rails app via the installation 
@@ -47,9 +46,10 @@ You can further customize the tracing of gruf services via the configuration:
 
 ```ruby
 Gruf.configure do |c|
-  c.hook_options[:zipkin] = {
+  c.interceptors.use(
+    Gruf::Zipkin::Interceptor,
     span_prefix: 'myapp'
-  }
+  )
 end
 ```
 

data/gruf-zipkin.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -26,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Plugin for zipkin tracing for gruf}
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/bigcommerce/gruf-zipkin'
+  spec.license       = 'MIT'
 
   spec.files         = Dir['README.md', 'CHANGELOG.md', 'CODE_OF_CONDUCT.md', 'lib/**/*', 'gruf-zipkin.gemspec']
   spec.require_paths = ['lib']

data/lib/gruf/zipkin.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -19,9 +18,14 @@ require_relative 'zipkin/version'
 require_relative 'zipkin/headers'
 require_relative 'zipkin/method'
 require_relative 'zipkin/trace'
-require_relative 'zipkin/hook'
+require_relative 'zipkin/interceptor'
 
+##
+# Gruf main base module
 module Gruf
+  ##
+  # Zipkin gruf module
+  #
   module Zipkin
   end
 end

data/lib/gruf/zipkin/headers.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -26,11 +25,11 @@ module Gruf
       # @property [Hash<Symbol|Array<String>>] Hash mapping of metadata keys
       #
       ZIPKIN_KEYS = {
-          parent_span_id: %w(x-b3-parentspanid X-B3-ParentSpanId HTTP_X_B3_PARENTSPANID),
-          span_id: %w(x-b3-spanid X-B3-SpanId HTTP_X_B3_SPANID),
-          trace_id: %w(x-b3-traceid X-B3-TraceId HTTP_X_B3_TRACEID),
-          sampled: %w(x-b3-sampled X-B3-Sampled HTTP_X_B3_SAMPLED),
-          flags: %w(x-b3-flags X-B3-Flags HTTP_X_B3_FLAGS)
+        parent_span_id: %w(x-b3-parentspanid X-B3-ParentSpanId HTTP_X_B3_PARENTSPANID),
+        span_id: %w(x-b3-spanid X-B3-SpanId HTTP_X_B3_SPANID),
+        trace_id: %w(x-b3-traceid X-B3-TraceId HTTP_X_B3_TRACEID),
+        sampled: %w(x-b3-sampled X-B3-Sampled HTTP_X_B3_SAMPLED),
+        flags: %w(x-b3-flags X-B3-Flags HTTP_X_B3_FLAGS)
       }.freeze
 
       ##

data/lib/gruf/zipkin/{hook.rb → interceptor.rb}

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -16,30 +15,22 @@
 #
 module Gruf
   module Zipkin
-    class Hook < Gruf::Hooks::Base
-
-      ##
-      # Sets up the tracing hook
-      #
-      def setup
-        @config = ::ZipkinTracer::Config.new(nil, options).freeze
-        @tracer = ::ZipkinTracer::TracerFactory.new.tracer(@config)
-      end
-
+    ##
+    # Intercepts calls to provide Zipkin tracing
+    #
+    class Interceptor < Gruf::Interceptors::ServerInterceptor
       ##
       # Handle the gruf around hook and trace sampled requests
       #
-      # @param [Symbol] call_signature
-      # @param [Object] request
-      # @param [GRPC::ActiveCall] active_call
-      #
-      def around(call_signature, request, active_call, &block)
-        trace = build_trace(call_signature, request, active_call)
+      def call(&block)
+        # do this here to ensure the tracer is initialized before the trace block. Zipkin's library has poor OOE support
+        tr = tracer
 
-        if trace.sampled?
+        trace = build_trace
+        if trace && trace.sampled?
           result = nil
           ::ZipkinTracer::TraceContainer.with_trace_id(trace.trace_id) do
-            result = trace.trace!(@tracer, &block)
+            result = trace.trace!(tr, &block)
           end
         else
           result = yield
@@ -47,31 +38,31 @@ module Gruf
         result
       end
 
+      private
+
       ##
-      # @return [String]
+      # @return [ZipkinTracer::Config]
       #
-      def service_key
-        service.class.name.underscore.tr('/', '.')
+      def config
+        @config ||= ::ZipkinTracer::Config.new(nil, { sampled_as_boolean: false }.merge(options)).freeze
       end
 
       ##
-      # @return [Hash]
+      # @return [Trace::ZipkinTracerBase]
       #
-      def options
-        @options.fetch(:zipkin, {})
+      def tracer
+        @tracer ||= ::ZipkinTracer::TracerFactory.new.tracer(config)
       end
 
-      private
-
       ##
-      # @param [Symbol] call_signature
-      # @param [Object] request
-      # @param [GRPC::ActiveCall] active_call
       # @return [Gruf::Zipkin::Trace]
       #
-      def build_trace(call_signature, request, active_call)
-        method = Gruf::Zipkin::Method.new(active_call, call_signature, request)
-        Gruf::Zipkin::Trace.new(method, service_key, options)
+      def build_trace
+        method = Gruf::Zipkin::Method.new(request.active_call, request.method_key, request.message)
+        Gruf::Zipkin::Trace.new(method, request.service_key, options)
+      rescue StandardError => e # catchall for zipkin failure
+        Gruf.logger.error "Failed to build zipkin trace: #{e.message}"
+        nil
       end
     end
   end

data/lib/gruf/zipkin/method.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -29,7 +28,7 @@ module Gruf
       #
       def initialize(active_call, signature, request)
         @active_call = active_call
-        @signature = signature.to_s.gsub('_without_intercept', '')
+        @signature = signature.to_s
         @request = request
       end
 

data/lib/gruf/zipkin/trace.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -71,7 +70,7 @@ module Gruf
           begin
             result = block.call(method.request, method.active_call)
             span.record(::Trace::Annotation::SERVER_SEND)
-          rescue => e
+          rescue StandardError => e
             if e.is_a?(::GRPC::BadStatus)
               span.record_tag(METADATA_KEYS[:error], true)
               span.record_tag(METADATA_KEYS[:grpc][:error], true)

data/lib/gruf/zipkin/version.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # Copyright (c) 2017-present, BigCommerce Pty. Ltd. All rights reserved
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
@@ -16,6 +15,6 @@
 #
 module Gruf
   module Zipkin
-    VERSION = '0.10.3'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf-zipkin
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,12 +93,13 @@ files:
 - gruf-zipkin.gemspec
 - lib/gruf/zipkin.rb
 - lib/gruf/zipkin/headers.rb
-- lib/gruf/zipkin/hook.rb
+- lib/gruf/zipkin/interceptor.rb
 - lib/gruf/zipkin/method.rb
 - lib/gruf/zipkin/trace.rb
 - lib/gruf/zipkin/version.rb
 homepage: https://github.com/bigcommerce/gruf-zipkin
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []