gitlab-labkit 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7e7afa0f2bf64760a144d433f5433532c1a08f1157f2ca46f180f13fead059b
-  data.tar.gz: 6647d722dc1ad3835001401ff13be3545649bbbc5847d664678422c3f3bab688
+  metadata.gz: a2d4710034737a40d4a0947d4a59eec42c82ebe95d8e1e77b0f8b6a20afd48d0
+  data.tar.gz: 6870c998273ae0bf10572172304f50335f1597e33970454524b42a7557bb551e
 SHA512:
-  metadata.gz: 1c2a10af3bb8968d523f62a40ef1597af6c26173b7b433c6ed7a1f2f613f76c02008653471dba139a82de7582e564d703da3b28b4bdc10f081c443dd0a41a07d
-  data.tar.gz: 5d38c2ef80073df95a0b3898e324ef7ac7b3e962bb72470833f4b1f0c1d28e64580c164fdcfca5d84f2f2e1579f3bd3b6211996205254be35631f5143787e07f
+  metadata.gz: accd3967431bc14bef4fb1ef747b10ed056da881cdde861fa4d361e0c91bd5f309ef4fa46ff097a8806e17fee431757b1fac2d858d3f3f239c66abe76adb2a45
+  data.tar.gz: f7568c0b0ced1de4d217a66951249900497e8c25babd40c567a54cba0163a4945bc67e1dc41662996a69ab4c77348b54aa1df843d52ebf6ea6d5d72d0499ce51

data/.gitlab-ci.yml

@@ -1,6 +1,7 @@
 .test_template: &test_definition
   stage: test
   script:
+    - gem install bundler
     - bundle install
     - bundle exec rake verify build install
 

data/Rakefile

@@ -34,6 +34,12 @@ namespace :rufo do
   end
 end
 
+desc "Generate test protobuf stubs"
+task :gen_test_proto do
+  system "grpc_tools_ruby_protoc --ruby_out=. --grpc_out=. spec/support/grpc_service/test.proto"
+  Rufo::Command.run(["spec/support/grpc_service/test_pb.rb", "spec/support/grpc_service/test_services_pb.rb"])
+end
+
 task :fix => %w[rufo:run rubocop:auto_correct]
 
 task :verify => %w[spec rufo:check rubocop]

data/gitlab-labkit.gemspec

@@ -17,12 +17,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.4.0"
 
+  # Please maintain alphabetical order for dependencies
   spec.add_runtime_dependency "actionpack", "~> 5"
   spec.add_runtime_dependency "activesupport", "~> 5"
-  spec.add_runtime_dependency "grpc", "~> 1.15"
+  spec.add_runtime_dependency "grpc", "~> 1.19.0" # Be sure to update the "grpc-tools" dev_depenency too
   spec.add_runtime_dependency "jaeger-client", "~> 0.10"
   spec.add_runtime_dependency "opentracing", "~> 0.4"
 
+  # Please maintain alphabetical order for dev dependencies
+  spec.add_development_dependency "grpc-tools", "~> 1.19.0"
   spec.add_development_dependency "rack", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.6.0"

data/lib/labkit/tracing.rb

@@ -6,7 +6,8 @@ module Labkit
   # Tracing provides distributed tracing functionality
   module Tracing
     autoload :Factory, "labkit/tracing/factory"
-    autoload :GRPCInterceptor, "labkit/tracing/grpc_interceptor"
+    autoload :GRPC, "labkit/tracing/grpc"
+    autoload :GRPCInterceptor, "labkit/tracing/grpc_interceptor" # Deprecated
     autoload :JaegerFactory, "labkit/tracing/jaeger_factory"
     autoload :RackMiddleware, "labkit/tracing/rack_middleware"
     autoload :Rails, "labkit/tracing/rails"

data/lib/labkit/tracing/grpc.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Tracing
+    # The GRPC module contains functionality for instrumenting GRPC calls
+    module GRPC
+      autoload :ClientInterceptor, "labkit/tracing/grpc/client_interceptor"
+      autoload :ServerInterceptor, "labkit/tracing/grpc/server_interceptor"
+    end
+  end
+end

data/lib/labkit/tracing/grpc/client_interceptor.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Disable the UnusedMethodArgument linter, since we need to declare the kwargs
+# in the methods, but we don't actually use them.
+# rubocop:disable Lint/UnusedMethodArgument
+require "opentracing"
+require "grpc"
+
+module Labkit
+  module Tracing
+    module GRPC
+      # GRPCClientInterceptor is a client-side GRPC interceptor
+      # for instrumenting GRPC calls with distributed tracing
+      class ClientInterceptor < ::GRPC::ClientInterceptor
+        include Singleton
+
+        def request_response(request:, call:, method:, metadata:)
+          wrap_with_tracing(method, "unary", metadata) { yield }
+        end
+
+        def client_streamer(requests:, call:, method:, metadata:)
+          wrap_with_tracing(method, "client_stream", metadata) { yield }
+        end
+
+        def server_streamer(request:, call:, method:, metadata:)
+          wrap_with_tracing(method, "server_stream", metadata) { yield }
+        end
+
+        def bidi_streamer(requests:, call:, method:, metadata:)
+          wrap_with_tracing(method, "bidi_stream", metadata) { yield }
+        end
+
+        private
+
+        def wrap_with_tracing(method, grpc_type, metadata)
+          tags = { "component" => "grpc", "span.kind" => "client", "grpc.method" => method, "grpc.type" => grpc_type }
+
+          TracingUtils.with_tracing(operation_name: "grpc:#{method}", tags: tags) do |span|
+            OpenTracing.inject(span.context, OpenTracing::FORMAT_TEXT_MAP, metadata)
+
+            yield
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Lint/UnusedMethodArgument

data/lib/labkit/tracing/grpc/server_interceptor.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Disable the UnusedMethodArgument linter, since we need to declare the kwargs
+# in the methods, but we don't actually use them.
+# rubocop:disable Lint/UnusedMethodArgument
+
+require "opentracing"
+require "grpc"
+
+module Labkit
+  module Tracing
+    module GRPC
+      # GRPCServerInterceptor is a server-side GRPC interceptor
+      # for instrumenting GRPC calls with distributed tracing
+      # in a GRPC Ruby server
+      class ServerInterceptor < ::GRPC::ServerInterceptor
+        def request_response(request: nil, call: nil, method: nil)
+          wrap_with_tracing(call, method, "unary") do
+            yield
+          end
+        end
+
+        def client_streamer(call: nil, method: nil)
+          wrap_with_tracing(call, method, "client_stream") do
+            yield
+          end
+        end
+
+        def server_streamer(request: nil, call: nil, method: nil)
+          wrap_with_tracing(call, method, "server_stream") do
+            yield
+          end
+        end
+
+        def bidi_streamer(requests: nil, call: nil, method: nil)
+          wrap_with_tracing(call, method, "bidi_stream") do
+            yield
+          end
+        end
+
+        private
+
+        def route_from_method(method)
+          service_class = method.owner
+          rpc_method = method.name.to_s.split("_").map(&:capitalize).join("")
+
+          "/#{service_class.service_name}/#{rpc_method}"
+        end
+
+        def wrap_with_tracing(call, method, grpc_type)
+          context = TracingUtils.tracer.extract(OpenTracing::FORMAT_TEXT_MAP, call.metadata)
+          method_name = route_from_method(method)
+          tags = {
+            "component" => "grpc",
+            "span.kind" => "server",
+            "grpc.method" => method_name,
+            "grpc.type" => grpc_type,
+          }
+
+          TracingUtils.with_tracing(operation_name: "grpc:#{method_name}", child_of: context, tags: tags) do |_span|
+            yield
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Lint/UnusedMethodArgument

data/lib/labkit/tracing/grpc_interceptor.rb

@@ -1,45 +1,8 @@
 # frozen_string_literal: true
 
-# rubocop:disable Lint/UnusedMethodArgument
-require "opentracing"
-require "grpc"
-
 module Labkit
   module Tracing
-    # GRPCInterceptor is a client-side GRPC interceptor
-    # for instrumenting GRPC calls with distributed tracing
-    class GRPCInterceptor < GRPC::ClientInterceptor
-      include Singleton
-
-      def request_response(request:, call:, method:, metadata:)
-        wrap_with_tracing(method, "unary", metadata) { yield }
-      end
-
-      def client_streamer(requests:, call:, method:, metadata:)
-        wrap_with_tracing(method, "client_stream", metadata) { yield }
-      end
-
-      def server_streamer(request:, call:, method:, metadata:)
-        wrap_with_tracing(method, "server_stream", metadata) { yield }
-      end
-
-      def bidi_streamer(requests:, call:, method:, metadata:)
-        wrap_with_tracing(method, "bidi_stream", metadata) { yield }
-      end
-
-      private
-
-      def wrap_with_tracing(method, grpc_type, metadata)
-        tags = { "component" => "grpc", "span.kind" => "client", "grpc.method" => method, "grpc.type" => grpc_type }
-
-        TracingUtils.with_tracing(operation_name: "grpc:#{method}", tags: tags) do |span|
-          OpenTracing.inject(span.context, OpenTracing::FORMAT_TEXT_MAP, metadata)
-
-          yield
-        end
-      end
-    end
+    # GRPCInterceptor is the deprecated name for GRPCClientInterceptor
+    GRPCInterceptor = GRPC::ClientInterceptor
   end
 end
-
-# rubocop:enable Lint/UnusedMethodArgument

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: jaeger-client
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: grpc-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +217,9 @@ files:
 - lib/labkit/logging/sanitizer.rb
 - lib/labkit/tracing.rb
 - lib/labkit/tracing/factory.rb
+- lib/labkit/tracing/grpc.rb
+- lib/labkit/tracing/grpc/client_interceptor.rb
+- lib/labkit/tracing/grpc/server_interceptor.rb
 - lib/labkit/tracing/grpc_interceptor.rb
 - lib/labkit/tracing/jaeger_factory.rb
 - lib/labkit/tracing/rack_middleware.rb