gitlab-labkit 0.13.0 → 0.13.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54ad7f3ed011ed85b6f0c090f05cd47a4bf7c738fabd2a165bad85b6e4d288c0
-  data.tar.gz: c833a07fa745fe8286b9c000879de8b0f338c0d24b722e71dc5044c60dcc3b79
+  metadata.gz: 386875226d2cd983130f209da6204b633bc564dc7cdf749e4fd51aeb27ea44b7
+  data.tar.gz: b07771c72a4dc8385bba052ac9524dde00cce55023ad9c327db040535faeed31
 SHA512:
-  metadata.gz: 5c724e7322119314f35831c726900220842e2f473a48d81241a94cc2eb4f34da39bb38c843ba72b724a1b5d0dff5e1b115cec704468d49797d4c681c309cf7ba
-  data.tar.gz: 91e870d9af690c2b5f6ce7659954616880ee3313f710b49c89505cbe915c4606ef3d1032d905cbfd1be4e547d98c846baa6fed052836833e71dc7a59444c0727
+  metadata.gz: 73dcbe4d30d4706da4299dce292b7cd7271be8c10ab555fa4bbd46c53f3cdbb2d47e1c92743f4f914a95b78d3035d43e38003344f7afc399b5507dab84690bb1
+  data.tar.gz: 571c2df46e971b9696c5e23b5bdba9ab6df56d8253e998fa9a8797b2ebfb4d0e1b2371ac1626fd8e02d11641b17fb5270e23a7c927e28fddf03b17f4b3b21e7a

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 *.gem
 node_modules
+.bundle

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:
@@ -5,6 +14,10 @@
     - bundle install
     - bundle exec rake verify build install
 
+test:2.7:
+  image: ruby:2.7
+  <<: *test_definition
+
 test:2.6:
   image: ruby:2.6
   <<: *test_definition
@@ -13,10 +26,6 @@ test:2.5:
   image: ruby:2.5
   <<: *test_definition
 
-test:2.4:
-  image: ruby:2.4
-  <<: *test_definition
-
 deploy:
   stage: deploy
   script:

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.7.2

data/gitlab-labkit.gemspec

@@ -22,9 +22,10 @@ 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"
+  spec.add_runtime_dependency "gitlab-pg_query", "~> 1.3"
 
   # Please maintain alphabetical order for dev dependencies
   spec.add_development_dependency "grpc-tools", "~> 1.19"

data/lib/labkit/context.rb

@@ -21,8 +21,9 @@ module Labkit
     LOG_KEY = "meta"
     CORRELATION_ID_KEY = "correlation_id"
     RAW_KEYS = [CORRELATION_ID_KEY].freeze
+    HEADER_PREFIX = "X-Gitlab-"
     KNOWN_KEYS = %w[user project root_namespace subscription_plan caller_id
-                    related_class feature_category].freeze
+                    remote_ip related_class feature_category].freeze
 
     class << self
       def with_context(attributes = {})
@@ -67,6 +68,10 @@ module Labkit
         @known_log_keys ||= (KNOWN_KEYS.map(&method(:log_key)) + RAW_KEYS).freeze
       end
 
+      def header_name(name)
+        HEADER_PREFIX + log_key(name).titlecase(keep_id_suffix: true).gsub(/\W/, "-")
+      end
+
       private
 
       def contexts
@@ -95,6 +100,12 @@ module Labkit
       data[CORRELATION_ID_KEY]
     end
 
+    def to_headers
+      to_h.except(CORRELATION_ID_KEY).transform_keys do |key|
+        self.class.header_name(key)
+      end
+    end
+
     protected
 
     def assign_attributes(attributes)

data/lib/labkit/logging/grpc/server_interceptor.rb

@@ -67,6 +67,7 @@ module Labkit
         ensure
           service_name, method_name = rpc_split(method)
           message = @default_tags.merge(
+            'grpc.start_time': start.utc.rfc3339,
             'grpc.time_ms': ((Time.now - start) * 1000.0).truncate(3),
             'grpc.code': CODE_STRINGS.fetch(code, code.to_s),
             'grpc.method': method_name,

data/lib/labkit/logging/sanitizer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "pg_query"
+
 module Labkit
   module Logging
     # Sanitizer provides log message sanitization, removing
@@ -22,6 +24,12 @@ module Labkit
         content
       end
 
+      def self.sanitize_sql(sql)
+        PgQuery.normalize(sql)
+      rescue PgQuery::ParseError
+        ""
+      end
+
       # Ensures that URLS are sanitized to hide credentials
       def self.mask_url(url)
         url = url.to_s.strip

data/lib/labkit/tracing.rb

@@ -28,6 +28,12 @@ module Labkit
       ENV["GITLAB_TRACING_URL"]
     end
 
+    # Check if the current request is being traced.
+    def self.sampled?
+      context = OpenTracing.active_span&.context
+      context && context.respond_to?(:sampled?) && context.sampled?
+    end
+
     def self.stacktrace_operations
       @stacktrace_operations ||= Set.new(ENV["GITLAB_TRACING_INCLUDE_STACKTRACE"].to_s.split(",").map(&:strip))
     end

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]),
@@ -34,7 +37,7 @@ module Labkit
           warn message
         end
 
-        Jaeger::Client.build(kwargs)
+        Jaeger::Client.build(**kwargs)
       end
 
       def self.get_sampler(sampler_type, sampler_param)

data/lib/labkit/tracing/rails/active_record/sql_instrumenter.rb

@@ -14,13 +14,14 @@ module Labkit
           end
 
           def tags(payload)
+            sql = Labkit::Logging::Sanitizer.sanitize_sql(payload[:sql]) if Labkit::Tracing.sampled? && payload[:sql]
             {
               "component" => COMPONENT_TAG,
               "span.kind" => "client",
               "db.type" => "sql",
               "db.connection_id" => payload[:connection_id],
               "db.cached" => payload[:cached] || false,
-              "db.statement" => payload[:sql],
+              "db.statement" => sql,
             }
           end
         end

data/lib/labkit/tracing/tracing_utils.rb

@@ -49,7 +49,7 @@ module Labkit
       # 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))
+        span.log_kv(**kv_tags_for_exception(exception))
       end
 
       # Generate key-value tags for an exception

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.5
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2020-12-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
@@ -112,6 +112,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: gitlab-pg_query
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement