gitlab-labkit 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c6a4f92530f7662034e9a67cda9b6f1587cce729502a088ef9b6777659b0bdc
-  data.tar.gz: 1f17a19f8e2f7a0f052c4474caaaf0fd1d3a291a77de67b4184000fb12a599de
+  metadata.gz: 198c31e6a0717be721e68fb8e68e145e24f66ae17338eccc80c0c4e94f638be6
+  data.tar.gz: e6ee6cf53603f78442d96b89bf8edf2720ee334d9441042dd9167fa9328a4406
 SHA512:
-  metadata.gz: 2a50b5944898571c6fa9038eed5d35ec3d560c684c7363e1779aa8b4ec1363e8533e51667ae868b961562a3d3195cc9ac1f8b27e6e76204290439a735b61f5bc
-  data.tar.gz: d96aeafefa46bb244fc7371165fed6f91e47326d60463f8d25685d50081b63a8651c2b5dee7656094d5fb87085a58dd44459aafc64621b32a083dde3eaf7180e
+  metadata.gz: 00544f82819064032c9bd3105ed265c56e078e9204702b9b91ed28f4ba760ae4481f1b766b9c0832a9648efa8c55212ef641d008d82912bb0dfab1ca8a9d2868
+  data.tar.gz: 0b195fec25f24758afb2df4d17dc639388e537258f08182bcc3a5162253b8efab493578e11a99d2bf86370ecd476ea467cce49ffeafe372e5be3def4f15141b3

data/README.md

@@ -18,7 +18,8 @@ The changelog is available via [**tagged release notes**](https://gitlab.com/git
 
 LabKit-Ruby provides functionality in three areas:
 
-1. `Labkit::Correlation` for handling and propagating Correlation-IDs.
+1. `Labkit::Context` used for providing context information to log messages.
+1. `Labkit::Correlation` For accessing the correlation id. (Generated and propagated by `Labkit::Context`)
 1. `Labkit::Logging` for sanitizing log messages.
 1. `Labkit::Tracing` for handling and propagating distributed traces.
 
@@ -41,3 +42,16 @@ $ bundle exec rake verify
 Note that LabKit-Ruby uses the [`rufo`](https://github.com/ruby-formatter/rufo) for auto-formatting. Please run `bundle exec rake fix` to auto-format your code before pushing.
 
 Please also review the [development section of the LabKit (go) README](https://gitlab.com/gitlab-org/labkit#developing-labkit) for details of the LabKit architectural philosophy.
+
+### Releasing a new version
+
+Releasing a new version can be done by pushing a new tag, or creating
+it from the
+[interface](https://gitlab.com/gitlab-org/labkit-ruby/-/tags).
+
+A new changelog will automatically be added to the release on Gitlab.
+
+The new version will automatically be published to
+[rubygems](https://rubygems.org/gems/gitlab-labkit) when the pipeline
+for the tag completes. It might take a few minutes before the update
+is available.

data/lib/labkit/middleware/sidekiq.rb

@@ -6,6 +6,8 @@ module Labkit
     module Sidekiq
       autoload :Client, "labkit/middleware/sidekiq/client"
       autoload :Server, "labkit/middleware/sidekiq/server"
+      autoload :Context, "labkit/middleware/sidekiq/context"
+      autoload :Tracing, "labkit/middleware/sidekiq/tracing"
     end
   end
 end

data/lib/labkit/middleware/sidekiq/client.rb

@@ -3,14 +3,21 @@
 module Labkit
   module Middleware
     module Sidekiq
-      # This middleware for Sidekiq-client wraps scheduling jobs in a context
-      # The context will also be added to the sidekiq job in redis so it can
-      # be reinstantiated by Sidekiq-server when running the job.
+      # This is a wrapper around all the sidekiq client-middleware in labkit
+      # The only middleware that needs to be added to the chain in GitLab-rails
+      #
+      # It uses a new `Sidekiq::Middleware::Chain` to string multiple middlewares
+      # together.
       class Client
-        def call(_worker_class, job, _queue, _redis_pool)
-          Labkit::Context.with_context do |context|
-            job.merge!(context.to_h)
+        def self.chain
+          @chain ||= ::Sidekiq::Middleware::Chain.new do |chain|
+            chain.add Labkit::Middleware::Sidekiq::Context::Client
+            chain.add Labkit::Middleware::Sidekiq::Tracing::Client if Labkit::Tracing.enabled?
+          end
+        end
 
+        def call(*args)
+          self.class.chain.invoke(*args) do
             yield
           end
         end

data/lib/labkit/middleware/sidekiq/context.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Middleware
+    module Sidekiq
+      # This module contains all the sidekiq middleware regarding application
+      # context
+      module Context
+        autoload :Client, "labkit/middleware/sidekiq/context/client"
+        autoload :Server, "labkit/middleware/sidekiq/context/server"
+      end
+    end
+  end
+end

data/lib/labkit/middleware/sidekiq/context/client.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Middleware
+    module Sidekiq
+      module Context
+        # This middleware for Sidekiq-client wraps scheduling jobs in a context
+        # The context will also be added to the sidekiq job in redis so it can
+        # be reinstantiated by Sidekiq-server when running the job.
+        class Client
+          def call(_worker_class, job, _queue, _redis_pool)
+            Labkit::Context.with_context do |context|
+              job.merge!(context.to_h)
+
+              yield
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/labkit/middleware/sidekiq/context/server.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Middleware
+    module Sidekiq
+      module Context
+        # This middleware for Sidekiq-client uses the values stored on a job to
+        # reinstantiate a context in which the job will run.
+        class Server
+          def call(_worker_class, job, _queue)
+            data = job.merge(Labkit::Context.log_key(:caller_id) => job["class"])
+
+            Labkit::Context.with_context(data) do |_context|
+              yield
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/labkit/middleware/sidekiq/server.rb

@@ -3,13 +3,21 @@
 module Labkit
   module Middleware
     module Sidekiq
-      # This middleware for Sidekiq-client uses the values stored on a job to
-      # reinstantiate a context in which the job will run.
+      # This is a wrapper around all the sidekiq server-middleware in labkit
+      # The only middleware that needs to be added to the chain in GitLab-rails
+      #
+      # It uses a new `Sidekiq::Middleware::Chain` to string multiple middlewares
+      # together.
       class Server
-        def call(_worker_class, job, _queue)
-          data = job.merge(Labkit::Context.log_key(:caller_id) => job["class"])
+        def self.chain
+          @chain ||= ::Sidekiq::Middleware::Chain.new do |chain|
+            chain.add Labkit::Middleware::Sidekiq::Context::Server
+            chain.add Labkit::Middleware::Sidekiq::Tracing::Server if Labkit::Tracing.enabled?
+          end
+        end
 
-          Labkit::Context.with_context(data) do |_context|
+        def call(*args)
+          self.class.chain.invoke(*args) do
             yield
           end
         end

data/lib/labkit/middleware/sidekiq/tracing.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Middleware
+    module Sidekiq
+      # Sidekiq provides classes for instrumenting Sidekiq client and server
+      # functionality
+      module Tracing
+        autoload :Client, "labkit/middleware/sidekiq/tracing/client"
+        autoload :Server, "labkit/middleware/sidekiq/tracing/server"
+        autoload :SidekiqCommon, "labkit/middleware/sidekiq/tracing/sidekiq_common"
+      end
+    end
+  end
+end

data/lib/labkit/middleware/sidekiq/tracing/client.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "opentracing"
+
+module Labkit
+  module Middleware
+    module Sidekiq
+      module Tracing
+        # Client provides a sidekiq client middleware for
+        # instrumenting distributed tracing calls made from the client
+        # application
+        class Client
+          include SidekiqCommon
+
+          SPAN_KIND = "client"
+
+          def call(_worker_class, job, _queue, _redis_pool)
+            Labkit::Tracing::TracingUtils.with_tracing(operation_name: "sidekiq:#{job["class"]}", tags: tags_from_job(job, SPAN_KIND)) do |span|
+              # Inject the details directly into the job
+              Labkit::Tracing::TracingUtils.tracer.inject(span.context, OpenTracing::FORMAT_TEXT_MAP, job)
+
+              yield
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/labkit/middleware/sidekiq/tracing/server.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "opentracing"
+
+module Labkit
+  module Middleware
+    module Sidekiq
+      module Tracing
+        # Server provides a sidekiq server middleware for
+        # instrumenting distributed tracing calls when they are
+        # executed by the Sidekiq server
+        class Server
+          include SidekiqCommon
+
+          SPAN_KIND = "server"
+
+          def call(_worker, job, _queue)
+            context = Labkit::Tracing::TracingUtils.tracer.extract(OpenTracing::FORMAT_TEXT_MAP, job)
+
+            Labkit::Tracing::TracingUtils.with_tracing(operation_name: "sidekiq:#{job["class"]}", child_of: context, tags: tags_from_job(job, SPAN_KIND)) { |_span| yield }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/labkit/middleware/sidekiq/tracing/sidekiq_common.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Middleware
+    module Sidekiq
+      module Tracing
+        # SidekiqCommon is a mixin for the sidekiq middleware components
+        module SidekiqCommon
+          def tags_from_job(job, kind)
+            {
+              "component" => "sidekiq",
+              "span.kind" => kind,
+              "sidekiq.queue" => job["queue"],
+              "sidekiq.jid" => job["jid"],
+              "sidekiq.retry" => job["retry"].to_s,
+              "sidekiq.args" => job["args"]&.join(", "),
+            }
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -284,7 +284,14 @@ files:
 - lib/labkit/middleware/rack.rb
 - lib/labkit/middleware/sidekiq.rb
 - lib/labkit/middleware/sidekiq/client.rb
+- lib/labkit/middleware/sidekiq/context.rb
+- lib/labkit/middleware/sidekiq/context/client.rb
+- lib/labkit/middleware/sidekiq/context/server.rb
 - lib/labkit/middleware/sidekiq/server.rb
+- lib/labkit/middleware/sidekiq/tracing.rb
+- lib/labkit/middleware/sidekiq/tracing/client.rb
+- lib/labkit/middleware/sidekiq/tracing/server.rb
+- lib/labkit/middleware/sidekiq/tracing/sidekiq_common.rb
 - lib/labkit/tracing.rb
 - lib/labkit/tracing/factory.rb
 - lib/labkit/tracing/grpc.rb
@@ -301,10 +308,6 @@ files:
 - 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
-- lib/labkit/tracing/sidekiq/sidekiq_common.rb
 - lib/labkit/tracing/tracing_utils.rb
 homepage: https://gitlab.com/gitlab-org/labkit-ruby
 licenses:

data/lib/labkit/tracing/sidekiq.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Labkit
-  module Tracing
-    # Sidekiq provides classes for instrumenting Sidekiq client and server
-    # functionality
-    module Sidekiq
-      autoload :ClientMiddleware, "labkit/tracing/sidekiq/client_middleware"
-      autoload :ServerMiddleware, "labkit/tracing/sidekiq/server_middleware"
-      autoload :SidekiqCommon, "labkit/tracing/sidekiq/sidekiq_common"
-    end
-  end
-end

data/lib/labkit/tracing/sidekiq/client_middleware.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "opentracing"
-
-module Labkit
-  module Tracing
-    module Sidekiq
-      # ClientMiddleware provides a sidekiq client middleware for
-      # instrumenting distributed tracing calls made from the client
-      # application
-      class ClientMiddleware
-        include SidekiqCommon
-
-        SPAN_KIND = "client"
-
-        def call(_worker_class, job, _queue, _redis_pool)
-          TracingUtils.with_tracing(operation_name: "sidekiq:#{job["class"]}", tags: tags_from_job(job, SPAN_KIND)) do |span|
-            # Inject the details directly into the job
-            TracingUtils.tracer.inject(span.context, OpenTracing::FORMAT_TEXT_MAP, job)
-
-            yield
-          end
-        end
-      end
-    end
-  end
-end

data/lib/labkit/tracing/sidekiq/server_middleware.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "opentracing"
-
-module Labkit
-  module Tracing
-    module Sidekiq
-      # ServerMiddleware provides a sidekiq server middleware for
-      # instrumenting distributed tracing calls when they are
-      # executed by the Sidekiq server
-      class ServerMiddleware
-        include SidekiqCommon
-
-        SPAN_KIND = "server"
-
-        def call(_worker, job, _queue)
-          context = TracingUtils.tracer.extract(OpenTracing::FORMAT_TEXT_MAP, job)
-
-          TracingUtils.with_tracing(operation_name: "sidekiq:#{job["class"]}", child_of: context, tags: tags_from_job(job, SPAN_KIND)) { |_span| yield }
-        end
-      end
-    end
-  end
-end

data/lib/labkit/tracing/sidekiq/sidekiq_common.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Labkit
-  module Tracing
-    module Sidekiq
-      # SidekiqCommon is a mixin for the sidekiq middleware components
-      module SidekiqCommon
-        def tags_from_job(job, kind)
-          {
-            "component" => "sidekiq",
-            "span.kind" => kind,
-            "sidekiq.queue" => job["queue"],
-            "sidekiq.jid" => job["jid"],
-            "sidekiq.retry" => job["retry"].to_s,
-            "sidekiq.args" => job["args"]&.join(", "),
-          }
-        end
-      end
-    end
-  end
-end