gitlab-labkit 0.13.2 → 0.13.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 458dd268746446a442c85e56a58ebc2005a169822856cf041e30444c649cd02a
-  data.tar.gz: 73613e1ad1aacf1f67bd9875622e97475600f65a2a5624b0cf39c79ba434b300
+  metadata.gz: f7365b2f12b026f6b497d56738197b66e34014676dc284f568e97fad669cecef
+  data.tar.gz: ca9da033595aed9506edd7ba376a1bdd0b15c8e880a5e6b3edc52dc72b5a5570
 SHA512:
-  metadata.gz: 111b312fac281429728c2e33c2e57548c643b7ead4079c86ae6ab766c670b23417e336610acb4a7b1fe6d9e297f6d2080192029e04a229b8956f1a9293cb0ce9
-  data.tar.gz: 17ea39978f5cd418ffe33f6fe2baf931fcd76cf3bfe7c47cfca9a0acdedf97cf2078ff64a18a10c0735f9bc87e3ad7a76369191a3394dfcb8a74a6bebe16406d
+  metadata.gz: 87aaa07295098883563e77694fdb1401ba9e2e5fbc26569ee0b87f8ce7bc329f0d26b78df5d2e1c2e97b86f3d7ec3c41200406eb2b7028aba8ce8bdec4001ab4
+  data.tar.gz: 42f5dcee07855cd347b9585b96e44ac3e36e05a5fd634db55ddea02676b82df9c35e0ba3d6bbbbf0e4c6b4ec16906ff8a86f041db67d392485008d811f3d20b2

data/.gitlab-ci.yml

@@ -14,6 +14,10 @@ workflow:
     - 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
@@ -22,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/gitlab-labkit.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   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/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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.13.3
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -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