gitlab-labkit 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4aea03a17735936eac617c462fb55b220f639d99d13c029de0c15dc7ace629e
-  data.tar.gz: fbf9048f2750ce87927864deb37b82d69652b27695aff4876745f509b9d4d4de
+  metadata.gz: 54ad7f3ed011ed85b6f0c090f05cd47a4bf7c738fabd2a165bad85b6e4d288c0
+  data.tar.gz: c833a07fa745fe8286b9c000879de8b0f338c0d24b722e71dc5044c60dcc3b79
 SHA512:
-  metadata.gz: 994ef11d2b1911eba33581b62136d4cc67b112491280710f31ea50ac04a6fb0037aa820ff3315c3146827acd6b017e10c3d6d1817d4a7aabd587c4567bcb2504
-  data.tar.gz: c522466510fad218e8ecb0376da5fe0478124f3a2adebfccedda7727b76cfa3d753f10ccb39ca94242746a0feee5d357cfd1ea2078b9b3ca9b823e688887e7dd
+  metadata.gz: 5c724e7322119314f35831c726900220842e2f473a48d81241a94cc2eb4f34da39bb38c843ba72b724a1b5d0dff5e1b115cec704468d49797d4c681c309cf7ba
+  data.tar.gz: 91e870d9af690c2b5f6ce7659954616880ee3313f710b49c89505cbe915c4606ef3d1032d905cbfd1be4e547d98c846baa6fed052836833e71dc7a59444c0727

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

@@ -7,6 +7,16 @@ module Labkit
       # It is not part of the public API
       module GRPCCommon
         CORRELATION_METADATA_KEY = "x-gitlab-correlation-id"
+
+        def rpc_split(method)
+          owner = method.owner
+          method_name, = owner.rpc_descs.find do |k, _|
+            ::GRPC::GenericService.underscore(k.to_s) == method.name.to_s
+          end
+          method_name ||= "(unknown)"
+
+          [owner.service_name, method_name]
+        end
       end
     end
   end

data/lib/labkit/logging.rb

@@ -4,6 +4,7 @@ module Labkit
   # Logging provides functionality for logging, such as
   # sanitization
   module Logging
+    autoload :GRPC, "labkit/logging/grpc"
     autoload :Sanitizer, "labkit/logging/sanitizer"
   end
 end

data/lib/labkit/logging/grpc.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Logging
+    module GRPC
+      autoload :ServerInterceptor, "labkit/logging/grpc/server_interceptor"
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "grpc"
+require "json"
+
+module Labkit
+  module Logging
+    module GRPC
+      class ServerInterceptor < ::GRPC::ServerInterceptor
+        include Labkit::Correlation::GRPC::GRPCCommon
+
+        CODE_STRINGS = {
+          ::GRPC::Core::StatusCodes::OK => "OK",
+          ::GRPC::Core::StatusCodes::CANCELLED => "Canceled",
+          ::GRPC::Core::StatusCodes::UNKNOWN => "Unknown",
+          ::GRPC::Core::StatusCodes::INVALID_ARGUMENT => "InvalidArgument",
+          ::GRPC::Core::StatusCodes::DEADLINE_EXCEEDED => "DeadlineExceeded",
+          ::GRPC::Core::StatusCodes::NOT_FOUND => "NotFound",
+          ::GRPC::Core::StatusCodes::ALREADY_EXISTS => "AlreadyExists",
+          ::GRPC::Core::StatusCodes::PERMISSION_DENIED => "PermissionDenied",
+          ::GRPC::Core::StatusCodes::RESOURCE_EXHAUSTED => "ResourceExhausted",
+          ::GRPC::Core::StatusCodes::FAILED_PRECONDITION => "FailedPrecondition",
+          ::GRPC::Core::StatusCodes::ABORTED => "Aborted",
+          ::GRPC::Core::StatusCodes::OUT_OF_RANGE => "OutOfRange",
+          ::GRPC::Core::StatusCodes::UNIMPLEMENTED => "Unimplemented",
+          ::GRPC::Core::StatusCodes::INTERNAL => "Internal",
+          ::GRPC::Core::StatusCodes::UNAVAILABLE => "Unavailable",
+          ::GRPC::Core::StatusCodes::DATA_LOSS => "DataLoss",
+          ::GRPC::Core::StatusCodes::UNAUTHENTICATED => "Unauthenticated",
+        }.freeze
+
+        def initialize(log_file, default_tags)
+          @log_file = log_file
+          @log_file.sync = true
+          @default_tags = default_tags
+
+          super()
+        end
+
+        def request_response(request: nil, call: nil, method: nil)
+          log_request(method, call) { yield }
+        end
+
+        def server_streamer(request: nil, call: nil, method: nil)
+          log_request(method, call) { yield }
+        end
+
+        def client_streamer(call: nil, method: nil)
+          log_request(method, call) { yield }
+        end
+
+        def bidi_streamer(requests: nil, call: nil, method: nil)
+          log_request(method, call) { yield }
+        end
+
+        private
+
+        def log_request(method, call)
+          start = Time.now
+          code = ::GRPC::Core::StatusCodes::OK
+
+          yield
+        rescue StandardError => ex
+          code = ex.is_a?(::GRPC::BadStatus) ? ex.code : ::GRPC::Core::StatusCodes::UNKNOWN
+
+          raise
+        ensure
+          service_name, method_name = rpc_split(method)
+          message = @default_tags.merge(
+            'grpc.time_ms': ((Time.now - start) * 1000.0).truncate(3),
+            'grpc.code': CODE_STRINGS.fetch(code, code.to_s),
+            'grpc.method': method_name,
+            'grpc.service': service_name,
+            pid: Process.pid,
+            correlation_id: Labkit::Correlation::CorrelationId.current_id.to_s,
+            time: Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.%LZ"),
+          )
+
+          @log_file.puts(JSON.dump(message))
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,8 @@ module Labkit
       # for instrumenting GRPC calls with distributed tracing
       # in a GRPC Ruby server
       class ServerInterceptor < ::GRPC::ServerInterceptor
+        include Labkit::Correlation::GRPC::GRPCCommon
+
         def request_response(request: nil, call: nil, method: nil)
           wrap_with_tracing(call, method, "unary") do
             yield
@@ -40,16 +42,9 @@ module Labkit
 
         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)
+          method_name = "/#{rpc_split(method).join("/")}"
           tags = {
             "component" => "grpc",
             "span.kind" => "server",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -279,6 +279,8 @@ files:
 - lib/labkit/correlation/grpc/grpc_common.rb
 - lib/labkit/correlation/grpc/server_interceptor.rb
 - lib/labkit/logging.rb
+- lib/labkit/logging/grpc.rb
+- lib/labkit/logging/grpc/server_interceptor.rb
 - lib/labkit/logging/sanitizer.rb
 - lib/labkit/middleware.rb
 - lib/labkit/middleware/rack.rb