gitlab-labkit 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8e8c2b52b6c4c63c4cded0ebf69fe68a74a03a8f02135e8c816ada927f74631
-  data.tar.gz: 3c0db5e80d47e8121f3211af5955c26dd6f19a6aed3c56c4acc57f17511f5651
+  metadata.gz: 657f2a528464eceb2b62cba36dba3dc262722a95ff2a351a71fb2162a7e5b949
+  data.tar.gz: 97d123fab3d434469eea2c948d26535decfd38ccad14f1b26aa441c26acef367
 SHA512:
-  metadata.gz: e562304883df27ad611536b45bf9548cfce823187ad055a5fcc46042933a7f6e78633da60480936ea2003d246b9f5181fbd2b05caba125c6dd1153f5792bf6ca
-  data.tar.gz: 2b1de826bb738a38d54332b89b5ab01d6da5b2b0237544d475b476a2cae46ad21f165ff44d2292e4e56aa5ebef0d30d6968becea99361aab7b2ea7684f177621
+  metadata.gz: 70ca817fd1f24705c50888f0e4ee22091424b6b2d05f12543bc8d0a350725b9052df28fa6ead8742d9ce5863d30d808955d574335b35939675aff61fa8e3815a
+  data.tar.gz: 5bab0eecef0233b1620f6da6ab609b6ff8af4ea96db6ed1803f924f55bae24f8f8e4de6497bd2131112d234ca5509baf75412b0bc64111207b01419274cd469c

data/lib/labkit/correlation.rb

@@ -3,6 +3,8 @@
 module Labkit
   # Correlation provides correlation functionality
   module Correlation
+    autoload :GRPC, "labkit/correlation/grpc"
+
     autoload :CorrelationId, "labkit/correlation/correlation_id"
   end
 end

data/lib/labkit/correlation/grpc.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Correlation
+    # The GRPC module contains functionality for instrumenting GRPC calls
+    module GRPC
+      autoload :GRPCCommon, "labkit/correlation/grpc/grpc_common"
+      autoload :ServerInterceptor, "labkit/correlation/grpc/server_interceptor"
+    end
+  end
+end

data/lib/labkit/correlation/grpc/grpc_common.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Correlation
+    module GRPC
+      # This module is shared between the client and server interceptor middlewares.
+      # It is not part of the public API
+      module GRPCCommon
+        CORRELATION_METADATA_KEY = "x-gitlab-correlation-id"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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 "grpc"
+
+module Labkit
+  module Correlation
+    module GRPC
+      # ServerInterceptor is a server-side GRPC interceptor
+      # for injecting GRPC calls with a correlation-id passed from
+      # a GRPC client to the GRPC Ruby Service
+      class ServerInterceptor < ::GRPC::ServerInterceptor
+        include Labkit::Correlation::GRPC::GRPCCommon
+
+        def request_response(request: nil, call: nil, method: nil)
+          wrap_with_correlation_id(call) do
+            yield
+          end
+        end
+
+        def client_streamer(call: nil, method: nil)
+          wrap_with_correlation_id(call) do
+            yield
+          end
+        end
+
+        def server_streamer(request: nil, call: nil, method: nil)
+          wrap_with_correlation_id(call) do
+            yield
+          end
+        end
+
+        def bidi_streamer(requests: nil, call: nil, method: nil)
+          wrap_with_correlation_id(call) do
+            yield
+          end
+        end
+
+        private
+
+        def wrap_with_correlation_id(call, &block)
+          correlation_id = call.metadata[CORRELATION_METADATA_KEY]
+          correlation_id ||= Labkit::Correlation::CorrelationId.current_or_new_id
+
+          Labkit::Correlation::CorrelationId.use_id(correlation_id, &block)
+        end
+      end
+    end
+  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.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -233,6 +233,9 @@ files:
 - lib/gitlab-labkit.rb
 - lib/labkit/correlation.rb
 - lib/labkit/correlation/correlation_id.rb
+- lib/labkit/correlation/grpc.rb
+- lib/labkit/correlation/grpc/grpc_common.rb
+- lib/labkit/correlation/grpc/server_interceptor.rb
 - lib/labkit/logging.rb
 - lib/labkit/logging/sanitizer.rb
 - lib/labkit/tracing.rb