gitlab-labkit 0.11.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '079f4d5036a9fec36b5b6407aae14904afe2cf8e14805bd66e2bc4e7232fbf6a'
-  data.tar.gz: ba3f76216a9e26fd2208911ae51f147e94ffa3bb786922eec529f4188c35b91b
+  metadata.gz: a70f566d4ed676fa90486f0117f74d52a839d2720103cf2c909ecfdb1e762b6e
+  data.tar.gz: 21614ae6e31149551dd15337957ff079c7c40536710d8911e697087e7a15bde3
 SHA512:
-  metadata.gz: 512596bceb4a8549af748a72e49286e3c1224ab1ae61d30f127685b70653fe30579c37d1091190cab19e244e016f5e2947b5892f51ba55b31651ccbc9e028706
-  data.tar.gz: de29c45094bafd62607471a8b0142ae3dffced97032d2a6b25c748a2a47347a5c815e5735d60985a98f6c43f3107ba901094ba814d1ff903d38c4f8ac6452b9b
+  metadata.gz: 94946b83b7e1f15fbcbd641b44332a78a9c578a26d2261f22ceb916266bb5f5ddf14652ec7485cc774f03ab051c4e78de1380501a6e35517121e526c170caca3
+  data.tar.gz: 9feec573a60e49eea6e86bc9ed85b615a0ca60bca10228a49fdea2afbb9296b8bfbccac646dc3cecb4e1bd71e8bd8f53efe1c77305c2cf0098b5dff0ac808ae6

data/.gitlab-ci.yml

@@ -1,3 +1,12 @@
+workflow:
+  rules:
+    # For merge requests, create a pipeline.
+    - if: '$CI_MERGE_REQUEST_IID'
+    # For `master` branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    # For tags, create a pipeline.
+    - if: '$CI_COMMIT_TAG'
+
 .test_template: &test_definition
   stage: test
   script:

data/gitlab-labkit.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "actionpack", ">= 5.0.0", "< 6.1.0"
   spec.add_runtime_dependency "activesupport", ">= 5.0.0", "< 6.1.0"
   spec.add_runtime_dependency "grpc", "~> 1.19" # Be sure to update the "grpc-tools" dev_depenency too
-  spec.add_runtime_dependency "jaeger-client", "~> 0.10"
+  spec.add_runtime_dependency "jaeger-client", "~> 1.1"
   spec.add_runtime_dependency "opentracing", "~> 0.4"
   spec.add_runtime_dependency "redis", ">3.0.0", "<5.0.0"
 

data/lib/labkit/context.rb

@@ -21,7 +21,8 @@ module Labkit
     LOG_KEY = "meta"
     CORRELATION_ID_KEY = "correlation_id"
     RAW_KEYS = [CORRELATION_ID_KEY].freeze
-    KNOWN_KEYS = %w[user project root_namespace subscription_plan caller_id].freeze
+    KNOWN_KEYS = %w[user project root_namespace subscription_plan caller_id
+                    related_class feature_category].freeze
 
     class << self
       def with_context(attributes = {})

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",

data/lib/labkit/tracing/jaeger_factory.rb

@@ -19,6 +19,9 @@ module Labkit
       FLUSH_INTERVAL = 5
 
       def self.create_tracer(service_name, options)
+        # The service_name parameter from GITLAB_TRACING takes precedence over the application one
+        service_name = options[:service_name] if options[:service_name]
+
         kwargs = {
           service_name: service_name,
           sampler: get_sampler(options[:sampler], options[:sampler_param]),

data/lib/labkit/tracing/redis/redis_interceptor_helper.rb

@@ -8,7 +8,7 @@ module Labkit
       # RedisInterceptorHelper is a helper for the RedisInterceptor. This is not a public API
       class RedisInterceptorHelper
         # For optimization, compile this once
-        MASK_REDIS_RE = /^([\w-]+(?:\W+[\w-]+(?:\W+[\w-]+)?)?)(.?)/.freeze
+        MASK_REDIS_RE = /^([\w{}-]+(?:\W+[\w{}-]+(?:\W+[\w{}-]+)?)?)(.?)/.freeze
 
         def self.call_with_tracing(command, client)
           Labkit::Tracing::TracingUtils.with_tracing(operation_name: "redis.call", tags: tags_from_command(command, client)) do |_span|
@@ -99,6 +99,7 @@ module Labkit
           return "" if argument.empty?
 
           matches = argument.match(MASK_REDIS_RE)
+
           matches[2].empty? ? matches[0] : matches[0] + "*****"
         end
         private_class_method :mask_redis_arg

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: opentracing
   requirement: !ruby/object:Gem::Requirement
@@ -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