gitlab-labkit 0.0.6 → 0.1.0.pre.1.pre.gcb57c95

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 427b29fcb43592d13da97f2cb071e0ada987b214d5dd8e5c3f94828e1b86b8a3
-  data.tar.gz: 903f153844848e8afb87cf18425926251c6b515a9f0f1bed960717b9242fdabc
+  metadata.gz: fdc219ab5591aa5c36aa15d9c25957a96f18641a75d0ebca11b21bb7c6d17ae9
+  data.tar.gz: cb403516333c2be36ac1a4e2ece02a941876b2f70a40a695ce8ef770bc66aa33
 SHA512:
-  metadata.gz: 516bf1f97994171fc3081acfc6e802a485266456033f22093c8c75788b25842bfb81d5be45060a866434df83f5ce6e707ce21ec78fb37843a2bd6f645f70a1cb
-  data.tar.gz: 101fe75e2de783e67cb93012a24f52b9a9acdb832906eadfa7f74580fbb26385517f82cf75fa451905431125f56425a4f149adf620594888a1ebdbc71ea998b6
+  metadata.gz: 49907af513fabb133b8ab1efb8c1a070d6266a89d241a945933d02ac200608cdab7234e365458b71764b40833b48633329340c9b3390e1131998aead6203b866
+  data.tar.gz: e97d6bcb51c7f4c4705de887e5519b7c4678d2c00ebaa58fd48a35aadca8cdb666557b394de65cb5cbdf8d6e9f2fd1a5e9d0b5b1156220ef7bd1945672220108

data/.gitlab-ci.yml

@@ -19,6 +19,7 @@ test:2.4:
 deploy:
   stage: deploy
   script:
+    - mkdir -p ~/.gem/
     - "printf '---\n:rubygems_api_key: $RUBYGEMS_API_KEY\n' > ~/.gem/credentials"
     - bundle install
     - bundle exec rake release[remote]

data/.rubocop.yml

@@ -1,12 +1,173 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
 require:
   - rubocop-rspec
 
-inherit_gem:
-  gitlab-styles:
-    - rubocop-default.yml
-
 Style/HashSyntax:
   EnforcedStyle: no_mixed_keys
 
 Style/SymbolLiteral:
   Enabled: No
+
+Style/TrailingCommaInArguments:
+  Enabled: No # Delegated to rufo
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: No # Delegated to rufo
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: No
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: No
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: No
+
+Layout/FirstParameterIndentation:
+  Enabled: No
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 54.28
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: true
+  Max: 4
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 13
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: true
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Max: 14
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/BeEql:
+  Enabled: true
+
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/DescribeMethod:
+  Enabled: false
+
+RSpec/DescribeSymbol:
+  Enabled: true
+
+RSpec/DescribedClass:
+  Enabled: true
+
+RSpec/EmptyExampleGroup:
+  Enabled: true
+
+RSpec/ExampleLength:
+  Enabled: false
+  Max: 5
+
+RSpec/ExampleWording:
+  Enabled: false
+  CustomTransform:
+    be: is
+    have: has
+    not: does not
+  IgnoredWords: []
+
+RSpec/ExpectActual:
+  Enabled: true
+
+RSpec/ExpectOutput:
+  Enabled: true
+
+RSpec/FilePath:
+  Enabled: true
+  IgnoreMethods: true
+
+RSpec/Focus:
+  Enabled: true
+
+RSpec/HookArgument:
+  Enabled: true
+  EnforcedStyle: implicit
+
+RSpec/ImplicitExpect:
+  Enabled: true
+  EnforcedStyle: is_expected
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/NotToNot:
+  EnforcedStyle: not_to
+  Enabled: true
+
+RSpec/RepeatedDescription:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false

data/.rufo

@@ -0,0 +1,3 @@
+align_chained_calls true
+parens_in_def :dynamic
+trailing_commas true

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2019 GitLab B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# LabKit-Ruby 🔬🔬🔬🔬🔬
+
+LabKit-Ruby is minimalist library to provide functionality for Ruby services at GitLab.
+
+LabKit-Ruby is the Ruby companion for [LabKit](https://gitlab.com/gitlab-org/labkit), a minimalist library to provide functionality for Go services at GitLab.
+
+LabKit-Ruby and LabKit are intended to provide similar functionality, but use the semantics of their respective languages, so are not intended to provide identical APIS.
+
+## Documentation
+
+API Documentation is available at [the Rubydoc site](https://www.rubydoc.info/gems/gitlab-labkit/).
+
+## Functionality
+
+LabKit-Ruby provides functionality in three areas:
+
+1. `Labkit::Correlation` for handling and propagating Correlation-IDs.
+1. `Labkit::Logging` for sanitizing log messages.
+1. `Labkit::Tracing` for handling and propagating distributed traces.
+
+## Developing
+
+Anyone can contribute!
+
+```console
+$ git clone git@gitlab.com:gitlab-org/labkit-ruby.git
+$ cd labkit-ruby
+$ bundle install
+
+$ # Autoformat code and auto-correct linters
+$ bundle exec rake fix
+
+$ # Run tests, linters
+$ 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.

data/Rakefile

@@ -1,28 +1,41 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rufo"
 
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
 end
 
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-task :format do
-  prettier_cmd = "./node_modules/.bin/prettier --write --plugin=@prettier/plugin-ruby '**/*.rb'"
-  sh "#{prettier_cmd} || npm install && #{prettier_cmd}"
-end
+desc "Alias for `rake rufo:run`"
+task :format => ["rufo:run"]
+
+namespace :rufo do
+  require "rufo"
+
+  def rufo_command(*switches, rake_args)
+    files_or_dirs = rake_args[:files_or_dirs] || "."
+    args = switches + files_or_dirs.split(" ")
+    Rufo::Command.run(args)
+  end
+
+  desc "Format Ruby code in current directory"
+  task :run, [:files_or_dirs] do |_task, rake_args|
+    rufo_command(rake_args)
+  end
 
-task "format:check" do
-  prettier_cmd = "./node_modules/.bin/prettier --check --plugin=@prettier/plugin-ruby '**/*.rb'"
-  sh "#{prettier_cmd} || npm install && #{prettier_cmd}"
+  desc "Check that no formatting changes are produced"
+  task :check, [:files_or_dirs] do |_task, rake_args|
+    rufo_command("--check", rake_args)
+  end
 end
 
-task :default => %w[spec rubocop build format:check]
+task :fix => %w[rufo:run rubocop:auto_correct]
 
-task :fix => %w[format rubocop:auto_correct]
+task :verify => %w[spec rufo:check rubocop]
 
-task :verify => %w[spec rubocop]
+task :default => %w[verify build]

data/gitlab-labkit.gemspec

@@ -1,31 +1,33 @@
-lib = File.expand_path('lib', __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = 'gitlab-labkit'
-  spec.version       = '0.0.6'
-  spec.authors       = ['Andrew Newdigate']
-  spec.email         = ['andrew@gitlab.com']
+  spec.name = "gitlab-labkit"
+  spec.version = `git describe --tags`.chomp.gsub(/^v/,"")
+  spec.authors = ["Andrew Newdigate"]
+  spec.email = ["andrew@gitlab.com"]
 
-  spec.summary       = 'Instrumentation for GitLab'
-  spec.homepage      = 'http://about.gitlab.com'
-  spec.license       = 'MIT'
+  spec.summary = "Instrumentation for GitLab"
+  spec.homepage = "http://about.gitlab.com"
+  spec.license = "MIT"
 
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|tools)/}) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_runtime_dependency 'actionpack', '~> 5'
-  spec.add_runtime_dependency 'activesupport', '~> 5'
-  spec.add_runtime_dependency 'grpc', '~> 1.15'
-  spec.add_runtime_dependency 'jaeger-client', '~> 0.10'
-  spec.add_runtime_dependency 'opentracing', '~> 0.4'
+  spec.add_runtime_dependency "actionpack", "~> 5"
+  spec.add_runtime_dependency "activesupport", "~> 5"
+  spec.add_runtime_dependency "grpc", "~> 1.15"
+  spec.add_runtime_dependency "jaeger-client", "~> 0.10"
+  spec.add_runtime_dependency "opentracing", "~> 0.4"
 
-  spec.add_development_dependency 'gitlab-styles', '~> 2.4'
-  spec.add_development_dependency 'rack', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.6.0'
-  spec.add_development_dependency 'rspec-parameterized', '~> 0.4'
-  spec.add_development_dependency 'rubocop', '~> 0.54.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.22.1'
+  spec.add_development_dependency "rack", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.6.0"
+  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"
 end

data/lib/gitlab-labkit.rb

@@ -1,10 +1,15 @@
-# https://guides.rubyonrails.org/active_support_core_extensions.html
-require 'active_support/all'
-
 # rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require "active_support/all"
+
+# LabKit is a module for handling cross-project
+# infrastructural concerns, partcularly related to
+# observability.
 module Labkit
-  autoload :Correlation, 'labkit/correlation'
-  autoload :Tracing, 'labkit/tracing'
-  autoload :Logging, 'labkit/logging'
+  autoload :Correlation, "labkit/correlation"
+  autoload :Tracing, "labkit/tracing"
+  autoload :Logging, "labkit/logging"
 end
+
 # rubocop:enable Naming/FileName

data/lib/labkit/correlation.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module Labkit
+  # Correlation provides correlation functionality
   module Correlation
-    autoload :CorrelationId, 'labkit/correlation/correlation_id'
+    autoload :CorrelationId, "labkit/correlation/correlation_id"
   end
 end

data/lib/labkit/correlation/correlation_id.rb

@@ -2,11 +2,13 @@
 
 module Labkit
   module Correlation
+    # CorrelationId module provides access the Correlation-ID
+    # of the current request
     module CorrelationId
-      LOG_KEY = 'correlation_id'
+      LOG_KEY = "correlation_id"
 
       class << self
-        def use_id(correlation_id, &blk)
+        def use_id(correlation_id, &_blk)
           # always generate a id if null is passed
           correlation_id ||= new_id
 

data/lib/labkit/logging.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Labkit
+  # Logging provides functionality for logging, such as
+  # sanitization
   module Logging
-    autoload :Sanitizer, 'labkit/logging/sanitizer'
+    autoload :Sanitizer, "labkit/logging/sanitizer"
   end
 end

data/lib/labkit/logging/sanitizer.rb

@@ -2,24 +2,52 @@
 
 module Labkit
   module Logging
+    # Sanitizer provides log message sanitization, removing
+    # confidential information from log messages
     class Sanitizer
+      SCP_URL_REGEXP = %r{
+        (?:((?:[\-_.!~*()a-zA-Z\d;&=+$,]|%[a-fA-F\d]{2})+)(:(?:(?:[\-_.!~*()a-zA-Z\d;:&=+$,]|%[a-fA-F\d]{2})*))?@)        (?# 1: username, 2: password)
+        (?:((?:(?:[a-zA-Z0-9\-._])+|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|\[(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?:(?:[a-fA-F\d]{1,4}:)*[a-fA-F\d]{1,4})?::(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}))?)\]))) (?# 3: host)
+        :
+        ((?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*(?:\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*)*)? (?# 4: path)
+        }x.freeze
+      SCP_ANCHORED_URL_REGEXP = /^#{SCP_URL_REGEXP}$/x.freeze
       ALLOWED_SCHEMES = %w[http https ssh git].freeze
+      URL_REGEXP = URI::DEFAULT_PARSER.make_regexp(ALLOWED_SCHEMES).freeze
 
       def self.sanitize_field(content)
-        regexp = URI::DEFAULT_PARSER.make_regexp(ALLOWED_SCHEMES)
+        content = content.gsub(URL_REGEXP) { |url| mask_url(url) }
+        content = content.gsub(SCP_URL_REGEXP) { |scp_url| mask_scp_url(scp_url) }
 
-        content.gsub(regexp) { |url| masked_url(url) }
+        content
       end
 
-      def self.masked_url(url)
+      # Ensures that URLS are sanitized to hide credentials
+      def self.mask_url(url)
         url = url.to_s.strip
-        url = Addressable::URI.parse(url)
+        p = URI::DEFAULT_PARSER.parse(url)
 
-        url.password = '*****' if url.password.present?
-        url.user = '*****' if url.user.present?
-        url.to_s
-      rescue Addressable::URI::InvalidURIError
-        ''
+        p.password = "*****" if p.password.present?
+        p.user = "*****" if p.user.present?
+        p.to_s
+      rescue URI::InvalidURIError
+        ""
+      end
+
+      # Ensures that URLs of the form user:password@hostname:project.git are
+      # sanitized to hide credentials
+      def self.mask_scp_url(scp_url)
+        scp_url = scp_url.to_s.strip
+        m = SCP_ANCHORED_URL_REGEXP.match(scp_url)
+        return "" unless m
+
+        password = m[2]
+        host = m[3]
+        path = m[4]
+
+        return "*****@#{host}:#{path}" unless password.present?
+
+        "*****:*****@#{host}:#{path}"
       end
     end
   end

data/lib/labkit/tracing.rb

@@ -1,41 +1,29 @@
 # frozen_string_literal: true
 
-require 'active_support/all'
+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'
-
-    module Rails
-      autoload :ActionViewSubscriber, 'labkit/tracing/rails/action_view_subscriber'
-      autoload :ActiveRecordSubscriber, 'labkit/tracing/rails/active_record_subscriber'
-      autoload :RailsCommon, 'labkit/tracing/rails/rails_common'
-    end
-
-    module Sidekiq
-      autoload :ClientMiddleware, 'labkit/tracing/sidekiq/client_middleware'
-      autoload :ServerMiddleware, 'labkit/tracing/sidekiq/server_middleware'
-      autoload :SidekiqCommon, 'labkit/tracing/sidekiq/sidekiq_common'
-    end
-
-    # Only enable tracing when the `GITLAB_TRACING` env var is configured. Note that we avoid using ApplicationSettings since
-    # the same environment variable needs to be configured for Workhorse, Gitaly and any other components which
-    # emit tracing. Since other components may start before Rails, and may not have access to ApplicationSettings,
-    # an env var makes more sense.
+    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"
+
+    # Tracing is only enabled when the `GITLAB_TRACING` env var is configured.
     def self.enabled?
       connection_string.present?
     end
 
     def self.connection_string
-      ENV['GITLAB_TRACING']
+      ENV["GITLAB_TRACING"]
     end
 
     def self.tracing_url_template
-      ENV['GITLAB_TRACING_URL']
+      ENV["GITLAB_TRACING_URL"]
     end
 
     def self.tracing_url_enabled?
@@ -51,7 +39,9 @@ module Labkit
 
       # Avoid using `format` since it can throw TypeErrors
       # which we want to avoid on unsanitised env var input
-      tracing_url_template.to_s.gsub('{{ correlation_id }}', correlation_id).gsub('{{ service }}', service_name)
+      tracing_url_template.to_s
+                          .gsub("{{ correlation_id }}", correlation_id)
+                          .gsub("{{ service }}", service_name)
     end
   end
 end

data/lib/labkit/tracing/common.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'opentracing'
+require "opentracing"
 
 module Labkit
   module Tracing
+    # Common is a mixin for various distributed tracing instrumentation
     module Common
       def tracer
         OpenTracing.global_tracer
@@ -16,7 +17,7 @@ module Labkit
 
         # Add correlation details to the span if we have them
         correlation_id = Labkit::Correlation::CorrelationId.current_id
-        span.set_tag('correlation_id', correlation_id) if correlation_id
+        span.set_tag("correlation_id", correlation_id) if correlation_id
 
         begin
           yield span
@@ -37,7 +38,7 @@ module Labkit
       end
 
       def log_exception_on_span(span, exception)
-        span.set_tag('error', true)
+        span.set_tag("error", true)
         span.log_kv(kv_tags_for_exception(exception))
       end
 
@@ -45,13 +46,13 @@ module Labkit
         case exception
         when Exception
           {
-            :"event" => 'error',
+            :"event" => "error",
             :"error.kind" => exception.class.to_s,
             :"message" => Labkit::Logging::Sanitizer.sanitize_field(exception.message),
-            :"stack" => exception.backtrace&.join('\n')
+            :"stack" => exception.backtrace&.join('\n'),
           }
         else
-          { :"event" => 'error', :"error.kind" => exception.class.to_s, :"error.object" => Labkit::Logging::Sanitizer.sanitize_field(exception.to_s) }
+          { :"event" => "error", :"error.kind" => exception.class.to_s, :"error.object" => Labkit::Logging::Sanitizer.sanitize_field(exception.to_s) }
         end
       end
     end

data/lib/labkit/tracing/factory.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
-require 'cgi'
+require "cgi"
 
 module Labkit
   module Tracing
+    # Factory provides tools for setting up and configuring the
+    # distributed tracing system within the process, given the
+    # tracing connection string
     class Factory
-      OPENTRACING_SCHEME = 'opentracing'
+      OPENTRACING_SCHEME = "opentracing"
 
       def self.create_tracer(service_name, connection_string)
         return unless connection_string.present?
@@ -15,7 +18,7 @@ module Labkit
           driver_name = opentracing_details[:driver_name]
 
           case driver_name
-          when 'jaeger'
+          when "jaeger"
             JaegerFactory.create_tracer(service_name, opentracing_details[:options])
           else
             raise "Unknown driver: #{driver_name}"
@@ -31,7 +34,7 @@ module Labkit
       def self.parse_connection_string(connection_string)
         parsed = URI.parse(connection_string)
 
-        raise 'Invalid tracing connection string' unless valid_uri?(parsed)
+        raise "Invalid tracing connection string" unless valid_uri?(parsed)
 
         { driver_name: parsed.host, options: parse_query(parsed.query) }
       end

data/lib/labkit/tracing/grpc_interceptor.rb

@@ -1,34 +1,37 @@
 # frozen_string_literal: true
 
-require 'opentracing'
-require 'grpc'
+# rubocop:disable Lint/UnusedMethodArgument
+require "opentracing"
+require "grpc"
 
 module Labkit
   module Tracing
+    # 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:)
-        wrap_with_tracing(method, 'unary', metadata) { yield }
+        wrap_with_tracing(method, "unary", metadata) { yield }
       end
 
       def client_streamer(requests:, call:, method:, metadata:)
-        wrap_with_tracing(method, 'client_stream', metadata) { yield }
+        wrap_with_tracing(method, "client_stream", metadata) { yield }
       end
 
       def server_streamer(request:, call:, method:, metadata:)
-        wrap_with_tracing(method, 'server_stream', metadata) { yield }
+        wrap_with_tracing(method, "server_stream", metadata) { yield }
       end
 
       def bidi_streamer(requests:, call:, method:, metadata:)
-        wrap_with_tracing(method, 'bidi_stream', metadata) { yield }
+        wrap_with_tracing(method, "bidi_stream", metadata) { yield }
       end
 
       private
 
       def wrap_with_tracing(method, grpc_type, metadata)
-        tags = { 'component' => 'grpc', 'span.kind' => 'client', 'grpc.method' => method, 'grpc.type' => grpc_type }
+        tags = { "component" => "grpc", "span.kind" => "client", "grpc.method" => method, "grpc.type" => grpc_type }
 
         in_tracing_span(operation_name: "grpc:#{method}", tags: tags) do |span|
           OpenTracing.inject(span.context, OpenTracing::FORMAT_TEXT_MAP, metadata)
@@ -39,3 +42,5 @@ module Labkit
     end
   end
 end
+
+# rubocop:enable Lint/UnusedMethodArgument

data/lib/labkit/tracing/jaeger_factory.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'jaeger/client'
+require "jaeger/client"
 
 module Labkit
   module Tracing
+    # JaegerFactory will configure Jaeger distributed tracing
     class JaegerFactory
       # When the probabilistic sampler is used, by default 0.1% of requests will be traced
       DEFAULT_PROBABILISTIC_RATE = 0.001
@@ -21,13 +22,12 @@ module Labkit
         kwargs = {
           service_name: service_name,
           sampler: get_sampler(options[:sampler], options[:sampler_param]),
-          reporter: get_reporter(service_name, options[:http_endpoint], options[:udp_endpoint])
-        }
-          .compact
+          reporter: get_reporter(service_name, options[:http_endpoint], options[:udp_endpoint]),
+        }.compact
 
         extra_params = options.except(:sampler, :sampler_param, :http_endpoint, :udp_endpoint, :strict_parsing, :debug)
         if extra_params.present?
-          message = "jaeger tracer: invalid option: #{extra_params.keys.join(', ')}"
+          message = "jaeger tracer: invalid option: #{extra_params.keys.join(", ")}"
 
           raise message if options[:strict_parsing]
 
@@ -39,11 +39,11 @@ module Labkit
 
       def self.get_sampler(sampler_type, sampler_param)
         case sampler_type
-        when 'probabilistic'
+        when "probabilistic"
           sampler_rate = sampler_param ? sampler_param.to_f : DEFAULT_PROBABILISTIC_RATE
           Jaeger::Samplers::Probabilistic.new(rate: sampler_rate)
-        when 'const'
-          const_value = sampler_param == '1'
+        when "const"
+          const_value = sampler_param == "1"
           Jaeger::Samplers::Const.new(const_value)
         end
       end
@@ -70,7 +70,7 @@ module Labkit
       private_class_method :get_http_sender
 
       def self.get_udp_sender(encoder, address)
-        pair = address.split(':', 2)
+        pair = address.split(":", 2)
         host = pair[0]
         port = pair[1] ? pair[1].to_i : DEFAULT_UDP_PORT
 

data/lib/labkit/tracing/rack_middleware.rb

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
-require 'opentracing'
-require 'active_support/all'
-require 'action_dispatch'
+require "opentracing"
+require "active_support/all"
+require "action_dispatch"
 
 module Labkit
   module Tracing
+    # RackMiddleware is a rack middleware component for
+    # instrumenting incoming http requests into a Rails/Rack
+    # server
     class RackMiddleware
       include Common
 
-      REQUEST_METHOD = 'REQUEST_METHOD'
+      REQUEST_METHOD = "REQUEST_METHOD"
 
       def initialize(app)
         @app = app
@@ -19,10 +22,10 @@ module Labkit
         method = env[REQUEST_METHOD]
 
         context = 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) }
+        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|
-          @app.call(env).tap { |status_code, _headers, _body| span.set_tag('http.status_code', status_code) }
+          @app.call(env).tap { |status_code, _headers, _body| span.set_tag("http.status_code", status_code) }
         end
       end
 

data/lib/labkit/tracing/rails.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Labkit
+  module Tracing
+    # Rails provides classes for instrumenting Rails events
+    module Rails
+      autoload :ActionViewSubscriber, "labkit/tracing/rails/action_view_subscriber"
+      autoload :ActiveRecordSubscriber, "labkit/tracing/rails/active_record_subscriber"
+      autoload :RailsCommon, "labkit/tracing/rails/rails_common"
+    end
+  end
+end

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

@@ -3,13 +3,15 @@
 module Labkit
   module Tracing
     module Rails
+      # ActionViewSubscriber bridges action view notifications to
+      # the distributed tracing subsystem
       class ActionViewSubscriber
         include RailsCommon
 
-        COMPONENT_TAG = 'ActionView'
-        RENDER_TEMPLATE_NOTIFICATION_TOPIC = 'render_template.action_view'
-        RENDER_COLLECTION_NOTIFICATION_TOPIC = 'render_collection.action_view'
-        RENDER_PARTIAL_NOTIFICATION_TOPIC = 'render_partial.action_view'
+        COMPONENT_TAG = "ActionView"
+        RENDER_TEMPLATE_NOTIFICATION_TOPIC = "render_template.action_view"
+        RENDER_COLLECTION_NOTIFICATION_TOPIC = "render_collection.action_view"
+        RENDER_PARTIAL_NOTIFICATION_TOPIC = "render_partial.action_view"
 
         # Instruments Rails ActionView events for opentracing.
         # Returns a lambda, which, when called will unsubscribe from the notifications
@@ -25,7 +27,7 @@ module Labkit
             end,
             ActiveSupport::Notifications.subscribe(RENDER_PARTIAL_NOTIFICATION_TOPIC) do |_, start, finish, _, payload|
               subscriber.notify_render_partial(start, finish, payload)
-            end
+            end,
           ]
 
           create_unsubscriber subscriptions
@@ -33,34 +35,34 @@ module Labkit
 
         # For more information on the payloads: https://guides.rubyonrails.org/active_support_instrumentation.html
         def notify_render_template(start, finish, payload)
-          generate_span_for_notification('render_template', start, finish, payload, tags_for_render_template(payload))
+          generate_span_for_notification("render_template", start, finish, payload, tags_for_render_template(payload))
         end
 
         def notify_render_collection(start, finish, payload)
-          generate_span_for_notification('render_collection', start, finish, payload, tags_for_render_collection(payload))
+          generate_span_for_notification("render_collection", start, finish, payload, tags_for_render_collection(payload))
         end
 
         def notify_render_partial(start, finish, payload)
-          generate_span_for_notification('render_partial', start, finish, payload, tags_for_render_partial(payload))
+          generate_span_for_notification("render_partial", start, finish, payload, tags_for_render_partial(payload))
         end
 
         private
 
         def tags_for_render_template(payload)
-          { 'component' => COMPONENT_TAG, 'template.id' => payload[:identifier], 'template.layout' => payload[:layout] }
+          { "component" => COMPONENT_TAG, "template.id" => payload[:identifier], "template.layout" => payload[:layout] }
         end
 
         def tags_for_render_collection(payload)
           {
-            'component' => COMPONENT_TAG,
-            'template.id' => payload[:identifier],
-            'template.count' => payload[:count] || 0,
-            'template.cache.hits' => payload[:cache_hits] || 0
+            "component" => COMPONENT_TAG,
+            "template.id" => payload[:identifier],
+            "template.count" => payload[:count] || 0,
+            "template.cache.hits" => payload[:cache_hits] || 0,
           }
         end
 
         def tags_for_render_partial(payload)
-          { 'component' => COMPONENT_TAG, 'template.id' => payload[:identifier] }
+          { "component" => COMPONENT_TAG, "template.id" => payload[:identifier] }
         end
       end
     end

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

@@ -3,12 +3,14 @@
 module Labkit
   module Tracing
     module Rails
+      # ActiveRecordSubscriber bridges active record notifications to
+      # the distributed tracing subsystem
       class ActiveRecordSubscriber
         include RailsCommon
 
-        ACTIVE_RECORD_NOTIFICATION_TOPIC = 'sql.active_record'
-        OPERATION_NAME_PREFIX = 'active_record:'
-        DEFAULT_OPERATION_NAME = 'sqlquery'
+        ACTIVE_RECORD_NOTIFICATION_TOPIC = "sql.active_record"
+        OPERATION_NAME_PREFIX = "active_record:"
+        DEFAULT_OPERATION_NAME = "sqlquery"
 
         # Instruments Rails ActiveRecord events for opentracing.
         # Returns a lambda, which, when called will unsubscribe from the notifications
@@ -36,12 +38,12 @@ module Labkit
 
         def tags_for_notification(payload)
           {
-            'component' => 'ActiveRecord',
-            'span.kind' => 'client',
-            'db.type' => 'sql',
-            'db.connection_id' => payload[:connection_id],
-            'db.cached' => payload[:cached] || false,
-            'db.statement' => payload[:sql]
+            "component" => "ActiveRecord",
+            "span.kind" => "client",
+            "db.type" => "sql",
+            "db.connection_id" => payload[:connection_id],
+            "db.cached" => payload[:cached] || false,
+            "db.statement" => payload[:sql],
           }
         end
       end

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

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-require 'active_support/all'
+require "active_support/all"
 
 module Labkit
   module Tracing
     module Rails
+      # RailsCommon is a mixin for providing instrumentation
+      # functionality for the rails instrumentation classes
       module RailsCommon
         extend ActiveSupport::Concern
         include Labkit::Tracing::Common

data/lib/labkit/tracing/sidekiq.rb

@@ -0,0 +1,13 @@
+# 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,17 +1,20 @@
 # frozen_string_literal: true
 
-require 'opentracing'
+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'
+        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|
+        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|
             # Inject the details directly into the job
             tracer
               .inject(span.context, OpenTracing::FORMAT_TEXT_MAP, job)

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

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
-require 'opentracing'
+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'
+        SPAN_KIND = "server"
 
-        def call(worker, job, queue)
+        def call(_worker, job, _queue)
           context = 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 }
+          in_tracing_span(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

@@ -3,17 +3,18 @@
 module Labkit
   module Tracing
     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',
-            'span.kind' => kind,
-            'sidekiq.queue' => job['queue'],
-            'sidekiq.jid' => job['jid'],
-            'sidekiq.retry' => job['retry'].to_s,
-            'sidekiq.args' => job['args']&.join(', ')
+            "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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0.pre.1.pre.gcb57c95
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: gitlab-styles
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: 0.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: 0.65.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.22.1
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: 
 email:
 - andrew@gitlab.com
@@ -187,11 +187,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
-- ".prettierrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".rufo"
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - gitlab-labkit.gemspec
 - lib/gitlab-labkit.rb
@@ -205,14 +207,14 @@ files:
 - lib/labkit/tracing/grpc_interceptor.rb
 - lib/labkit/tracing/jaeger_factory.rb
 - lib/labkit/tracing/rack_middleware.rb
+- lib/labkit/tracing/rails.rb
 - lib/labkit/tracing/rails/action_view_subscriber.rb
 - lib/labkit/tracing/rails/active_record_subscriber.rb
 - lib/labkit/tracing/rails/rails_common.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
-- package-lock.json
-- package.json
 homepage: http://about.gitlab.com
 licenses:
 - MIT
@@ -225,12 +227,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.8

data/.prettierrc

@@ -1,3 +0,0 @@
-{
-  "printWidth": 160
-}

data/package-lock.json

@@ -1,22 +0,0 @@
-{
-  "name": "labkit-ruby",
-  "requires": true,
-  "lockfileVersion": 1,
-  "dependencies": {
-    "@prettier/plugin-ruby": {
-      "version": "0.5.1",
-      "resolved": "https://registry.npmjs.org/@prettier/plugin-ruby/-/plugin-ruby-0.5.1.tgz",
-      "integrity": "sha512-i5vcRvswNc0FhR41CnKCIy4hIztXDJb99vFavn/4cDeSk9Gu2OYnorDCpgjSVnu8l7go2P4na+Rws3qoxrX09A==",
-      "dev": true,
-      "requires": {
-        "prettier": "^1.16.4"
-      }
-    },
-    "prettier": {
-      "version": "1.16.4",
-      "resolved": "https://registry.npmjs.org/prettier/-/prettier-1.16.4.tgz",
-      "integrity": "sha512-ZzWuos7TI5CKUeQAtFd6Zhm2s6EpAD/ZLApIhsF9pRvRtM1RFo61dM/4MSRUA0SuLugA/zgrZD8m0BaY46Og7g==",
-      "dev": true
-    }
-  }
-}

data/package.json

@@ -1,7 +0,0 @@
-{
-  "name": "labkit-ruby",
-  "devDependencies": {
-    "@prettier/plugin-ruby": "^0.5.1",
-    "prettier": "^1.16.4"
-  }
-}