gitlab-labkit 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 190e76612be6032be5116ecf271dd78b4f1d8bcdd07e3f47516a161b3c69f1ac
-  data.tar.gz: 890b5aadb68d2d3da1a80869b288e57180a6b8a30571227811abe20fbdc8a1f8
+  metadata.gz: a7e7afa0f2bf64760a144d433f5433532c1a08f1157f2ca46f180f13fead059b
+  data.tar.gz: 6647d722dc1ad3835001401ff13be3545649bbbc5847d664678422c3f3bab688
 SHA512:
-  metadata.gz: f9b3eabc156afeb32ad87e68e542993a8a6789e3b702c114bf5d5bed9002d11341a6dfafcbb3f2ca5a6460b3e5fb8eb9a589fff9a71f1b62a4dfa9d8e6be54f1
-  data.tar.gz: 2683b9da50c2878c120b8c4a53cb44f179e301c655cdad125aa23bfe7c034bf6f78a0fdbc5d6dad14dfe2873ee30d0e6adbffe9eaab88292a610c88db41a06c4
+  metadata.gz: 1c2a10af3bb8968d523f62a40ef1597af6c26173b7b433c6ed7a1f2f613f76c02008653471dba139a82de7582e564d703da3b28b4bdc10f081c443dd0a41a07d
+  data.tar.gz: 5d38c2ef80073df95a0b3898e324ef7ac7b3e962bb72470833f4b1f0c1d28e64580c164fdcfca5d84f2f2e1579f3bd3b6211996205254be35631f5143787e07f

data/gitlab-labkit.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-parameterized", "~> 0.4"
   spec.add_development_dependency "rubocop", "~> 0.65.0"
   spec.add_development_dependency "rubocop-rspec", "~> 1.22.1"
-  spec.add_development_dependency "rufo", "~> 0.5"
+  spec.add_development_dependency "rufo", "~> 0.6"
 end

data/lib/labkit/tracing/grpc_interceptor.rb

@@ -9,7 +9,6 @@ module Labkit
     # GRPCInterceptor is a client-side GRPC interceptor
     # for instrumenting GRPC calls with distributed tracing
     class GRPCInterceptor < GRPC::ClientInterceptor
-      include Common
       include Singleton
 
       def request_response(request:, call:, method:, metadata:)
@@ -33,7 +32,7 @@ module Labkit
       def wrap_with_tracing(method, grpc_type, metadata)
         tags = { "component" => "grpc", "span.kind" => "client", "grpc.method" => method, "grpc.type" => grpc_type }
 
-        in_tracing_span(operation_name: "grpc:#{method}", tags: tags) do |span|
+        TracingUtils.with_tracing(operation_name: "grpc:#{method}", tags: tags) do |span|
           OpenTracing.inject(span.context, OpenTracing::FORMAT_TEXT_MAP, metadata)
 
           yield

data/lib/labkit/tracing/rack_middleware.rb

@@ -10,8 +10,6 @@ module Labkit
     # instrumenting incoming http requests into a Rails/Rack
     # server
     class RackMiddleware
-      include Common
-
       REQUEST_METHOD = "REQUEST_METHOD"
 
       def initialize(app)
@@ -21,10 +19,10 @@ module Labkit
       def call(env)
         method = env[REQUEST_METHOD]
 
-        context = tracer.extract(OpenTracing::FORMAT_RACK, env)
+        context = TracingUtils.tracer.extract(OpenTracing::FORMAT_RACK, env)
         tags = { "component" => "rack", "span.kind" => "server", "http.method" => method, "http.url" => self.class.build_sanitized_url_from_env(env) }
 
-        in_tracing_span(operation_name: "http:#{method}", child_of: context, tags: tags) do |span|
+        TracingUtils.with_tracing(operation_name: "http:#{method}", child_of: context, tags: tags) do |span|
           @app.call(env).tap { |status_code, _headers, _body| span.set_tag("http.status_code", status_code) }
         end
       end

data/lib/labkit/tracing/rails/rails_common.rb

@@ -9,7 +9,6 @@ module Labkit
       # functionality for the rails instrumentation classes
       module RailsCommon
         extend ActiveSupport::Concern
-        include Labkit::Tracing::Common
 
         class_methods do
           def create_unsubscriber(subscriptions)
@@ -20,7 +19,7 @@ module Labkit
         def generate_span_for_notification(operation_name, start, finish, payload, tags)
           exception = payload[:exception]
 
-          postnotify_span(operation_name, start, finish, tags: tags, exception: exception)
+          TracingUtils.postnotify_span(operation_name, start, finish, tags: tags, exception: exception)
         end
       end
     end

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

@@ -14,10 +14,9 @@ module Labkit
         SPAN_KIND = "client"
 
         def call(_worker_class, job, _queue, _redis_pool)
-          in_tracing_span(operation_name: "sidekiq:#{job["class"]}", tags: tags_from_job(job, SPAN_KIND)) do |span|
+          TracingUtils.with_tracing(operation_name: "sidekiq:#{job["class"]}", tags: tags_from_job(job, SPAN_KIND)) do |span|
             # Inject the details directly into the job
-            tracer
-              .inject(span.context, OpenTracing::FORMAT_TEXT_MAP, job)
+            TracingUtils.tracer.inject(span.context, OpenTracing::FORMAT_TEXT_MAP, job)
 
             yield
           end

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

@@ -14,9 +14,9 @@ module Labkit
         SPAN_KIND = "server"
 
         def call(_worker, job, _queue)
-          context = tracer.extract(OpenTracing::FORMAT_TEXT_MAP, job)
+          context = TracingUtils.tracer.extract(OpenTracing::FORMAT_TEXT_MAP, job)
 
-          in_tracing_span(operation_name: "sidekiq:#{job["class"]}", child_of: context, tags: tags_from_job(job, SPAN_KIND)) { |_span| yield }
+          TracingUtils.with_tracing(operation_name: "sidekiq:#{job["class"]}", child_of: context, tags: tags_from_job(job, SPAN_KIND)) { |_span| yield }
         end
       end
     end

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

@@ -5,8 +5,6 @@ module Labkit
     module Sidekiq
       # SidekiqCommon is a mixin for the sidekiq middleware components
       module SidekiqCommon
-        include Labkit::Tracing::Common
-
         def tags_from_job(job, kind)
           {
             "component" => "sidekiq",

data/lib/labkit/tracing/{common.rb → tracing_utils.rb}

@@ -4,14 +4,11 @@ require "opentracing"
 
 module Labkit
   module Tracing
-    # Common is a mixin for various distributed tracing instrumentation
-    module Common
-      def tracer
-        OpenTracing.global_tracer
-      end
-
+    # Internal methods for tracing. This is not part of the LabKit public API.
+    # For internal usage only
+    class TracingUtils
       # Convience method for running a block with a span
-      def in_tracing_span(operation_name:, tags:, child_of: nil)
+      def self.with_tracing(operation_name:, tags:, child_of: nil)
         scope = tracer.start_active_span(operation_name, child_of: child_of, tags: tags)
         span = scope.span
 
@@ -29,7 +26,13 @@ module Labkit
         end
       end
 
-      def postnotify_span(operation_name, start_time, end_time, tags: nil, child_of: nil, exception: nil)
+      # Obtain a tracer instance
+      def self.tracer
+        OpenTracing.global_tracer
+      end
+
+      # Generate a span retrospectively
+      def self.postnotify_span(operation_name, start_time, end_time, tags: nil, child_of: nil, exception: nil)
         span = OpenTracing.start_span(operation_name, start_time: start_time, tags: tags, child_of: child_of)
 
         log_exception_on_span(span, exception) if exception
@@ -37,12 +40,14 @@ module Labkit
         span.finish(end_time: end_time)
       end
 
-      def log_exception_on_span(span, exception)
+      # Add exception logging to a span
+      def self.log_exception_on_span(span, exception)
         span.set_tag("error", true)
         span.log_kv(kv_tags_for_exception(exception))
       end
 
-      def kv_tags_for_exception(exception)
+      # Generate key-value tags for an exception
+      def self.kv_tags_for_exception(exception)
         case exception
         when Exception
           {

data/lib/labkit/tracing.rb

@@ -5,13 +5,13 @@ require "active_support/all"
 module Labkit
   # Tracing provides distributed tracing functionality
   module Tracing
-    autoload :Common, "labkit/tracing/common"
     autoload :Factory, "labkit/tracing/factory"
     autoload :GRPCInterceptor, "labkit/tracing/grpc_interceptor"
     autoload :JaegerFactory, "labkit/tracing/jaeger_factory"
     autoload :RackMiddleware, "labkit/tracing/rack_middleware"
     autoload :Rails, "labkit/tracing/rails"
     autoload :Sidekiq, "labkit/tracing/sidekiq"
+    autoload :TracingUtils, "labkit/tracing/tracing_utils"
 
     # Tracing is only enabled when the `GITLAB_TRACING` env var is configured.
     def self.enabled?
@@ -43,5 +43,15 @@ module Labkit
                           .gsub("{{ correlation_id }}", correlation_id)
                           .gsub("{{ service }}", service_name)
     end
+
+    # This will run a block with a span
+    # @param operation_name [String] The operation name for the span
+    # @param tags [Hash] Tags to assign to the span
+    # @param child_of [SpanContext, Span] SpanContext that acts as a parent to
+    #  the newly-started span. If a span instance is provided, its
+    #  context is automatically substituted.
+    def self.with_tracing(**kwargs, &block)
+      TracingUtils.with_tracing(**kwargs, &block)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 description: 
 email:
 - andrew@gitlab.com
@@ -202,7 +202,6 @@ files:
 - lib/labkit/logging.rb
 - lib/labkit/logging/sanitizer.rb
 - lib/labkit/tracing.rb
-- lib/labkit/tracing/common.rb
 - lib/labkit/tracing/factory.rb
 - lib/labkit/tracing/grpc_interceptor.rb
 - lib/labkit/tracing/jaeger_factory.rb
@@ -215,6 +214,7 @@ files:
 - 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: http://about.gitlab.com
 licenses:
 - MIT
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Instrumentation for GitLab