helios-opentelemetry-sdk 0.1.16 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76cb4b1d14f9d68ab3bf329963f3a61b1df0962266bf20440fc882b3bc03dfc7
-  data.tar.gz: 9eac30d4d73bade94970786bd8eedd9c1e530b1c026f96d37a30f61d2dea26d6
+  metadata.gz: e1333d4f45a6affbdc086bb2e8e98f8871e7a295a50e4dd87f624b60ca4be78e
+  data.tar.gz: b50075cf28a40a5ccc36dd39c46d6c1323b8a6514e027f558f3fc1cb4439e0e6
 SHA512:
-  metadata.gz: 5c15ad22b47fb73056fbb5445bb9bd578b5f67afd3472c97bbcbf3ce44b923d25460ecb1e8e9bd738fc113d7aaece1273322eecaaea8daed9dc2b07d0908c671
-  data.tar.gz: fa2d528cc8f882cb5ec06595e5ee7c46227cf7ff554c8d0c5613d0de78c682ad19e3d56382a6e8e450a0410dd6c7ef33ca286cd37b892bc5cb9d17a16bc38067
+  metadata.gz: d6467ee1a6eabce6fb8a743e536c8e83ba3bbdb9705b62fd9793552ef163b9d69a43649e13d948f686d4d4a6cbb4da02ad3f90e5a65b59d66d497a7757d89a91
+  data.tar.gz: 9b96c5e12e92befd75f0d5f650b2119e79279efe19e4b2aa4e1b69cceb7939a4f90f8eddc5ee495fa0bbfa72c435ae86ae4012634f6c514f93233aa00bf3337d

data/.github/workflows/test.yml

@@ -21,6 +21,16 @@ jobs:
             fail-fast: false
             matrix:
                 ruby-version: ['2.6', '2.7', '3.1']
+        services:
+            mongodb:
+                image: mongo@sha256:845fd775d7a58f564fae7c17a4eec7ff038e1c4004ebe05cc1cb5fc3767cf6cc
+                ports:
+                    - 27017:27017
+                options: >-
+                    --health-cmd="echo 'db.runCommand(\"ping\").ok' | mongo localhost:27017/test --quiet"
+                    --health-interval=10s
+                    --health-timeout=5s
+                    --health-retries=3
         steps:
             - uses: actions/checkout@v2
             - uses: actions/setup-ruby@v1

data/.rubocop.yml

@@ -24,3 +24,6 @@ Metrics/BlockLength:
 
 Metrics/CyclomaticComplexity:
   Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/Gemfile

@@ -10,3 +10,4 @@ gem 'rubocop', '~> 1.30.1', group: [:development, :test]
 gem 'bundler', '~> 2.3.16', group: [:development, :test]
 gem 'faraday', '~> 2.3.0', group: [:development, :test]
 gem 'rack', '~> 2.2.4', group: [:development, :test]
+gem 'mongo', '~> 2.5', group: [:development, :test]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    helios-opentelemetry-sdk (0.1.16)
+    helios-opentelemetry-sdk (0.1.19)
       opentelemetry-exporter-otlp (~> 0.22.0)
       opentelemetry-instrumentation-all (~> 0.25.0)
       opentelemetry-instrumentation-rspec (~> 0.2.0)
@@ -11,6 +11,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    bson (4.15.0)
     diff-lcs (1.5.0)
     faraday (2.3.0)
       faraday-net_http (~> 2.0)
@@ -19,6 +20,8 @@ GEM
     google-protobuf (3.21.1)
     googleapis-common-protos-types (1.3.1)
       google-protobuf (~> 3.14)
+    mongo (2.18.1)
+      bson (>= 4.14.1, < 5.0.0)
     opentelemetry-api (1.0.2)
     opentelemetry-common (0.19.6)
       opentelemetry-api (~> 1.0)
@@ -245,6 +248,7 @@ DEPENDENCIES
   bundler (~> 2.3.16)
   faraday (~> 2.3.0)
   helios-opentelemetry-sdk!
+  mongo (~> 2.5)
   opentelemetry-exporter-otlp (~> 0.22.0)
   opentelemetry-instrumentation-all (~> 0.25.0)
   opentelemetry-instrumentation-rspec (~> 0.2.0)

data/lib/helios/opentelemetry/sdk/instrumentations.rb

@@ -55,6 +55,8 @@ end
 def patch_net_http
   require_relative 'patches/net_http_patch'
   ::Net::HTTP.prepend(NetHttpPatch::Instrumentation)
+rescue StandardError => e
+  ::OpenTelemetry.logger.debug("Error patching net http: #{e}")
 end
 
 def patch_faraday
@@ -65,6 +67,8 @@ def patch_faraday
   ::OpenTelemetry::Instrumentation::Faraday::Middlewares::TracerMiddleware.prepend(
     FaradayPatch::HeliosFaradayMiddleware
   )
+rescue StandardError => e
+  ::OpenTelemetry.logger.debug("Error patching faraday: #{e}")
 end
 
 def patch_rack
@@ -75,10 +79,28 @@ def patch_rack
   ::OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware.prepend(
     RackPatch::HeliosRackMiddleware
   )
+rescue StandardError => e
+  ::OpenTelemetry.logger.debug("Error patching rack: #{e}")
+end
+
+def patch_mongo
+  return unless defined?(::Mongo::Monitoring::Global)
+
+  require 'opentelemetry/instrumentation/mongo/subscriber'
+  min_version = ::OpenTelemetry::Instrumentation::Mongo::Instrumentation::MINIMUM_VERSION
+  mongo_version = Gem::Version.new(::Mongo::VERSION)
+  return unless mongo_version >= min_version
+
+  require_relative 'patches/mongo_patch'
+  ::OpenTelemetry::Instrumentation::Mongo::Subscriber.prepend(MongoPatch::Subscriber)
+  ::OpenTelemetry::Instrumentation::Mongo::CommandSerializer.prepend(MongoPatch::CommandSerializer)
+rescue StandardError => e
+  ::OpenTelemetry.logger.debug("Error patching mongo: #{e}")
 end
 
 def additional_patches
   patch_net_http
   patch_faraday
   patch_rack
+  patch_mongo
 end

data/lib/helios/opentelemetry/sdk/patches/faraday_patch.rb

@@ -17,6 +17,8 @@ module FaradayPatch
       response_headers = env.response_headers
       span.set_attribute(semantic_attributes::HTTP_RESPONSE_HEADERS, response_headers.to_json)
       span.set_attribute(semantic_attributes::HTTP_RESPONSE_BODY, env.response_body) unless env.response_body.nil?
+    rescue StandardError => e
+      ::OpenTelemetry.logger.debug("Error extracting faraday attributes: #{e}")
     end
   end
 end

data/lib/helios/opentelemetry/sdk/patches/mongo_patch.rb

@@ -0,0 +1,36 @@
+require 'json'
+require_relative '../../semantic_attributes'
+
+module MongoPatch
+  module Subscriber
+    def succeeded(event)
+      extract_query_result(event)
+      super(event)
+    end
+
+    def extract_query_result(event)
+      span = get_span(event)
+      return unless span
+
+      span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::DB_QUERY_RESULT, event.reply.to_json)
+    rescue StandardError => e
+      ::OpenTelemetry.logger.debug("Error extracting mongo query result: #{e}")
+    end
+  end
+
+  module CommandSerializer
+    # Temp patch until the upstream fix is released
+    def mask(hash)
+      hash.each_with_object({}) do |(k, v), h|
+        value = if v.is_a?(Hash)
+                  mask(v)
+                elsif @obfuscate
+                  MASK_VALUE
+                else
+                  v
+                end
+        h[k] = value
+      end
+    end
+  end
+end

data/lib/helios/opentelemetry/sdk/patches/net_http_patch.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'opentelemetry/semantic_conventions'
 require_relative '../../semantic_attributes'
 
 module NetHttpPatch
@@ -6,7 +7,9 @@ module NetHttpPatch
   module Instrumentation
     def request(req, body = nil, &block)
       current_span = OpenTelemetry::Trace.current_span
-      current_span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_REQUEST_HEADERS, collect_headers(req))
+      current_span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_REQUEST_HEADERS,
+                                 collect_headers(req))
+      current_span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_URL, req.uri&.to_s)
       unless body.nil?
         current_span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_REQUEST_BODY,
                                    body.is_a?(String) ? body : body.to_s)
@@ -27,5 +30,22 @@ module NetHttpPatch
 
       headers.to_json
     end
+
+    def extract_request_attributes(span, req, body)
+      span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_REQUEST_HEADERS, collect_headers(req))
+      unless body.nil?
+        span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_REQUEST_BODY,
+                           body.is_a?(String) ? body : body.to_s)
+      end
+    rescue StandardError => e
+      ::OpenTelemetry.logger.debug("Error extracting net http request attributes: #{e}")
+    end
+
+    def extract_response_attributes(span, response)
+      span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_RESPONSE_HEADERS, collect_headers(response))
+      span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_RESPONSE_BODY, response.body)
+    rescue StandardError => e
+      ::OpenTelemetry.logger.debug("Error extracting net http response attributes: #{e}")
+    end
   end
 end

data/lib/helios/opentelemetry/sdk/patches/rack_patch.rb

@@ -6,6 +6,16 @@ module RackPatch
   module HeliosRackMiddleware
     def request_span_attributes(env:)
       res = super(env: env)
+      extract_request_attributes(env, res)
+      res
+    end
+
+    def set_attributes_after_request(span, status, headers, response)
+      extract_response_attributes(span, headers, response)
+      super(span, status, headers, response)
+    end
+
+    def extract_request_attributes(env, res)
       # Request headers are attributes in the env hash that start with HTTP_
       request_headers = env.select { |k, _v| k.start_with? 'HTTP_' }.transform_keys { |k| k.sub(/^HTTP_/, '').downcase }
       semantic_attributes = Helios::OpenTelemetry::SemanticAttributes
@@ -13,17 +23,18 @@ module RackPatch
       request_body = env['rack.input']&.read
       env['rack.input']&.rewind
       res[semantic_attributes::HTTP_REQUEST_BODY] = request_body if request_body&.length&.positive?
-      res
+    rescue StandardError => e
+      ::OpenTelemetry.logger.debug("Error extracting rack request attributes: #{e}")
     end
 
-    def set_attributes_after_request(span, status, headers, response)
+    def extract_response_attributes(span, headers, response)
       semantic_attributes = Helios::OpenTelemetry::SemanticAttributes
       span.set_attribute(semantic_attributes::HTTP_RESPONSE_HEADERS, headers.to_json)
       if response.respond_to?(:first) && response.first&.length&.positive?
         span.set_attribute(semantic_attributes::HTTP_RESPONSE_BODY, response.first)
       end
-
-      super(span, status, headers, response)
+    rescue StandardError => e
+      ::OpenTelemetry.logger.debug("Error extracting rack response attributes: #{e}")
     end
   end
 end

data/lib/helios/opentelemetry/sdk/version.rb

@@ -1,7 +1,7 @@
 module Helios
   module OpenTelemetry
     module SDK
-      VERSION = '0.1.16'
+      VERSION = '0.1.19'
     end
   end
 end

data/lib/helios/opentelemetry/semantic_attributes.rb

@@ -5,6 +5,7 @@ module Helios
       HTTP_REQUEST_HEADERS = 'http.request.headers'
       HTTP_RESPONSE_BODY = 'http.response.body'
       HTTP_RESPONSE_HEADERS = 'http.response.headers'
+      DB_QUERY_RESULT = 'db.query_result'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helios-opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.19
 platform: ruby
 authors:
 - Team Helios
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - lib/helios/opentelemetry/sdk.rb
 - lib/helios/opentelemetry/sdk/instrumentations.rb
 - lib/helios/opentelemetry/sdk/patches/faraday_patch.rb
+- lib/helios/opentelemetry/sdk/patches/mongo_patch.rb
 - lib/helios/opentelemetry/sdk/patches/net_http_patch.rb
 - lib/helios/opentelemetry/sdk/patches/rack_patch.rb
 - lib/helios/opentelemetry/sdk/version.rb