gitlab-labkit 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a12f0cfece810e841d6e90af209518aedb4f419b56bb8bdf2718e3dd13c4c4e0
-  data.tar.gz: ec955a4d6c7e119f774ec78636a92f3991d052f29e2ca8c51c4b17e5dbda433f
+  metadata.gz: 1bf18910dd8b5fe524da8c6c935423a9aa059e48ba35a8773d1b5aaa85ac6dd4
+  data.tar.gz: 5793dbbe30934d2b4799fa6295e5a7994bbaeb172bcc18c85c062d83552eb1c3
 SHA512:
-  metadata.gz: 3e95164f20400532ca86c1b832a1c723925a917cc23d7c2ac093fd63525c215c02c2f9f90822ac0010342553dff5d46a60403a29149b5a11f89d2d80d51b64d1
-  data.tar.gz: a873c80f7bef4706394ea583a0b69d3576ffacad7f10caf0c3996bc2bfc4f229ccf76dd2fddf6e028deee09d7a876f36de75de8164e8409890993c5d77cb2b14
+  metadata.gz: 13e32000497293b6bc57c4114db05d13eac4ed928e7111f9f30e4ade7bfa0ad173143577cb8fe503b069903752ae200fc32c8341a23db469c4aca6a27af320b0
+  data.tar.gz: 93f1ad1a7f292732ad9c73f5b618aab676cb16d991ac55561e3e9f269ab58ff22d6c29dfd6452ea89e8b5bafc5d5b7d73f2456ac02af42047199fb689eef2958

data/gitlab-labkit.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   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 "opentracing", "~> 0.4"
+  spec.add_runtime_dependency "redis", "~> 3.2"
 
   # Please maintain alphabetical order for dev dependencies
   spec.add_development_dependency "grpc-tools", "~> 1.19"

data/lib/labkit/tracing.rb

@@ -11,6 +11,7 @@ module Labkit
     autoload :JaegerFactory, "labkit/tracing/jaeger_factory"
     autoload :RackMiddleware, "labkit/tracing/rack_middleware"
     autoload :Rails, "labkit/tracing/rails"
+    autoload :Redis, "labkit/tracing/redis"
     autoload :Sidekiq, "labkit/tracing/sidekiq"
     autoload :TracingUtils, "labkit/tracing/tracing_utils"
 

data/lib/labkit/tracing/redis.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module Labkit
+  module Tracing
+    # The Redis interceptor will intercept all calls to Redis and instrument them for distributed tracing
+    module Redis
+      autoload :RedisInterceptor, "labkit/tracing/redis/redis_interceptor"
+      autoload :RedisInterceptorHelper, "labkit/tracing/redis/redis_interceptor_helper"
+
+      def self.instrument
+        ::Redis::Client.prepend RedisInterceptor
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module Labkit
+  module Tracing
+    module Redis
+      # RedisInterceptor is an interceptor for Redis to add distributed tracing.
+      # It should be installed using the `Labkit::Tracing.instrument` method
+      module RedisInterceptor
+        def call(command)
+          RedisInterceptorHelper.call_with_tracing(command, self) do
+            # Note: when used without any arguments super uses the arguments given to the subclass method.
+            super
+          end
+        end
+
+        def call_pipeline(pipeline)
+          RedisInterceptorHelper.call_pipeline_with_tracing(pipeline, self) do
+            # Note: when used without any arguments super uses the arguments given to the subclass method.
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "redis"
+
+module Labkit
+  module Tracing
+    module Redis
+      # 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
+
+        def self.call_with_tracing(command, client)
+          Labkit::Tracing::TracingUtils.with_tracing(operation_name: "redis.call", tags: tags_from_command(command, client)) do |_span|
+            yield
+          end
+        end
+
+        def self.call_pipeline_with_tracing(pipeline, client)
+          Labkit::Tracing::TracingUtils.with_tracing(operation_name: "redis.call_pipeline", tags: tags_from_pipeline(pipeline, client)) do |_span|
+            yield
+          end
+        end
+
+        def self.common_tags_for_client(client)
+          {
+            "component" => "redis",
+            "span.kind" => "client",
+            "redis.scheme" => client.scheme,
+            "redis.host" => client.host,
+            "redis.port" => client.port,
+            "redis.path" => client.path,
+          }
+        end
+
+        def self.tags_from_command(command, client)
+          tags = common_tags_for_client(client)
+
+          tags["redis.command"] = command_serialized(command)
+
+          tags
+        end
+
+        def self.command_serialized(command)
+          command_name, *arguments = command
+
+          info = [command_name]
+          info << sanitize_argument_for_command(command_name, arguments.first) unless arguments.empty?
+
+          # Additional arguments? Only include the number
+          info << "...#{arguments.size - 1} more value(s)" if arguments.size > 1
+
+          info.join(" ")
+        end
+
+        def self.tags_from_pipeline(pipeline, client)
+          tags = common_tags_for_client(client)
+
+          commands = pipeline.commands
+
+          # Limit to the first 5 commands
+          commands.first(5).each_with_index do |command, index|
+            tags["redis.command.#{index}"] = command_serialized(command)
+          end
+          tags["redis.pipeline.commands.length"] = commands.length
+
+          tags
+        end
+
+        # get_first_argument_for_command returns a masked value representing the first argument
+        # from a redis command, taking care of certain sensitive commands
+        def self.sanitize_argument_for_command(command_name, first_argument)
+          return "*****" if command_is_sensitive(command_name)
+
+          return "nil" if first_argument.nil?
+          return first if first_argument.is_a?(Numeric)
+          return "*****" unless first_argument.is_a?(String)
+
+          mask_redis_arg(first_argument)
+        end
+
+        def self.command_is_sensitive(command_name)
+          return true if command_name == :auth || "auth".casecmp(command_name).zero?
+          return true if command_name == :eval || "eval".casecmp(command_name).zero?
+
+          false
+        end
+
+        def self.mask_redis_arg(argument)
+          return "" if argument.empty?
+
+          matches = argument.match(MASK_REDIS_RE)
+          matches[2].empty? ? matches[0] : matches[0] + "*****"
+        end
+        private_class_method :mask_redis_arg
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
@@ -228,6 +242,9 @@ files:
 - lib/labkit/tracing/rails/active_record_subscriber.rb
 - lib/labkit/tracing/rails/active_support_subscriber.rb
 - lib/labkit/tracing/rails/rails_common.rb
+- lib/labkit/tracing/redis.rb
+- lib/labkit/tracing/redis/redis_interceptor.rb
+- lib/labkit/tracing/redis/redis_interceptor_helper.rb
 - lib/labkit/tracing/sidekiq.rb
 - lib/labkit/tracing/sidekiq/client_middleware.rb
 - lib/labkit/tracing/sidekiq/server_middleware.rb