gitlab-labkit 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1966ecde160ebd4af3cf1e131cdc2f5e7665e327bc0074128d293f4b33710c8
-  data.tar.gz: 0abde88973ac84a12862be74f5a438ae5a76852d805dc690852f121eb0466cce
+  metadata.gz: 79846c3feb1b3287ef00d0f55b81ee788745bd5e9834849686061d3ec533cd8a
+  data.tar.gz: 527270e43d3a430155932fa3fd133be491ae572196f830e1f3464ff3fe0d4144
 SHA512:
-  metadata.gz: 7a18b78e676c89304be5db049ea675fe2b8671d0f4eabfec557340328821dc14f56a9b4a6e80a86fa62c72a657e97dd5f667e63a5da2eedb419114ce68480eeb
-  data.tar.gz: 2aeb4a0f9b5cd31e89d169654992977bbab625539da4511de6e989ec8dfae31693a4180e0def980437cdc89b258d18ea577d5f9ca70b06797e7080ea4b7d5e08
+  metadata.gz: bdf9d4b68fa887ddaf7763a21637cdafe0937dd6f6aef355c71178e8f52c960b7726f9060364c4d254e75e83014764baddfa8545a27818b92fb0409fb422dabd
+  data.tar.gz: 1926fbefa4446482eb4a9ed7af240eecb2c6b5af6a8e6cc444d67ca7c95bb252853729b771bf29984437e0843396bfac9e188031a29f29913cf61d9f97f6a183

data/.env.example.sh

@@ -0,0 +1,7 @@
+export CI_PROJECT_ID=10947578
+export CI_API_V4_URL="https://gitlab.com/api/v4"
+export CI_PROJECT_URL="https://gitlab.com/gitlab-org/ruby/gems/labkit-ruby"
+# Don't keep secrets in plaintext files. Use a keyring or 1password to load
+# it instead and export it as an env var.
+token=$(load-your-token)
+export GITLAB_TOKEN=$token

data/.gitignore

@@ -2,3 +2,4 @@ Gemfile.lock
 *.gem
 node_modules
 .bundle
+/.env.sh

data/.gitlab-ci.yml

@@ -20,16 +20,11 @@ workflow:
 test:3.0:
   image: ruby:3.0
   <<: *test_definition
-  allow_failure: true # until we resolve grpc compatibility, see https://gitlab.com/gitlab-org/labkit-ruby/-/merge_requests/81
 
 test:2.7:
   image: ruby:2.7
   <<: *test_definition
 
-test:2.6:
-  image: ruby:2.6
-  <<: *test_definition
-
 static-analysis:
   before_script:
     - bundle install

data/README.md

@@ -44,6 +44,20 @@ Note that LabKit-Ruby uses the [`rufo`](https://github.com/ruby-formatter/rufo)
 
 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.
 
+To work on some of the scripts we use for releasing a new version,
+make sure to add a new `.env.sh`.
+
+```console
+cp .env.example.sh .env.sh`
+```
+
+Inside `.env.sh`, add a personal acccess token for the `GITLAB_TOKEN`
+environment variable. Next source the file:
+
+```console
+. .env.sh
+```
+
 ### Releasing a new version
 
 Releasing a new version can be done by pushing a new tag, or creating

data/lib/labkit/context.rb

@@ -123,7 +123,7 @@ module Labkit
       data.merge!(attributes)
 
       # Remove keys that had their values set to `nil` in the new attributes
-      data.keep_if { |_, value| value.present? }
+      data.keep_if { |_, value| valid_data?(value) }
 
       # Assign a correlation if it was missing in the first context or when
       # explicitly removed
@@ -146,12 +146,16 @@ module Labkit
       data.transform_values do |value|
         value = call_or_value(value)
 
-        value.presence
+        value if valid_data?(value)
       end.compact
     end
 
     def new_id
       SecureRandom.hex
     end
+
+    def valid_data?(value)
+      value == false || value.present?
+    end
   end
 end

data/lib/labkit/logging/json_logger.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require "time"
+require "logger"
+require "json"
+
+module Labkit
+  module Logging
+    class JsonLogger < ::Logger
+      def self.log_level(fallback: ::Logger::DEBUG)
+        ENV.fetch("GITLAB_LOG_LEVEL", fallback)
+      end
+
+      def initialize(path, level: JsonLogger.log_level)
+        super
+      end
+
+      def format_message(severity, timestamp, progname, message)
+        data = default_attributes
+        data[:severity] = severity
+        data[:time] = timestamp.utc.iso8601(3)
+        data[Labkit::Correlation::CorrelationId::LOG_KEY] = Labkit::Correlation::CorrelationId.current_id
+
+        case message
+        when String
+          data[:message] = message
+        when Hash
+          data.merge!(message)
+        end
+
+        dump_json(data) << "\n"
+      end
+
+      private
+
+      def default_attributes
+        {}
+      end
+
+      def dump_json(data)
+        JSON.generate(data)
+      end
+    end
+  end
+end

data/lib/labkit/logging.rb

@@ -6,5 +6,6 @@ module Labkit
   module Logging
     autoload :GRPC, "labkit/logging/grpc"
     autoload :Sanitizer, "labkit/logging/sanitizer"
+    autoload :JsonLogger, "labkit/logging/json_logger"
   end
 end

data/lib/labkit/tracing/jaeger_factory.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "active_support"
+require "active_support/core_ext"
+
 require "jaeger/client"
 
 module Labkit
@@ -22,10 +25,13 @@ module Labkit
         # The service_name parameter from GITLAB_TRACING takes precedence over the application one
         service_name = options[:service_name] if options[:service_name]
 
+        # parse reporter headers as necessary
+        headers = build_headers(options)
+
         kwargs = {
           service_name: service_name,
           sampler: get_sampler(options[:sampler], options[:sampler_param]),
-          reporter: get_reporter(service_name, options[:http_endpoint], options[:udp_endpoint]),
+          reporter: get_reporter(service_name, options[:http_endpoint], options[:udp_endpoint], headers),
         }.compact
 
         extra_params = options.except(:sampler, :sampler_param, :http_endpoint, :udp_endpoint, :strict_parsing, :debug)
@@ -40,6 +46,24 @@ module Labkit
         Jaeger::Client.build(**kwargs)
       end
 
+      def self.build_headers(options)
+        return unless options&.key?(:http_endpoint)
+
+        http_endpoint = options[:http_endpoint]
+        parsed = URI.parse(http_endpoint)
+
+        headers = {}
+        # add basic auth header only when both user and password are setup correctly
+        user = parsed.user
+        password = parsed.password
+        if user.present? && password.present?
+          headers["Authorization"] = "Basic " + Base64.strict_encode64("#{user}:#{password}")
+        end
+
+        return headers
+      end
+      private_class_method :build_headers
+
       def self.get_sampler(sampler_type, sampler_param)
         case sampler_type
         when "probabilistic"
@@ -52,11 +76,11 @@ module Labkit
       end
       private_class_method :get_sampler
 
-      def self.get_reporter(service_name, http_endpoint, udp_endpoint)
+      def self.get_reporter(service_name, http_endpoint, udp_endpoint, headers)
         encoder = Jaeger::Encoders::ThriftEncoder.new(service_name: service_name)
 
         if http_endpoint.present?
-          sender = get_http_sender(encoder, http_endpoint)
+          sender = get_http_sender(encoder, http_endpoint, headers)
         elsif udp_endpoint.present?
           sender = get_udp_sender(encoder, udp_endpoint)
         else
@@ -67,8 +91,8 @@ module Labkit
       end
       private_class_method :get_reporter
 
-      def self.get_http_sender(encoder, address)
-        Jaeger::HttpSender.new(url: address, encoder: encoder, logger: Logger.new(STDOUT))
+      def self.get_http_sender(encoder, address, headers)
+        Jaeger::HttpSender.new(url: address, headers: headers, encoder: encoder, logger: Logger.new(STDOUT))
       end
       private_class_method :get_http_sender
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-30 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -357,6 +357,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example.sh"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".gitlab/CODEOWNERS"
@@ -386,6 +387,7 @@ files:
 - lib/labkit/logging.rb
 - lib/labkit/logging/grpc.rb
 - lib/labkit/logging/grpc/server_interceptor.rb
+- lib/labkit/logging/json_logger.rb
 - lib/labkit/logging/sanitizer.rb
 - lib/labkit/middleware.rb
 - lib/labkit/middleware/rack.rb