helios-opentelemetry-sdk 0.1.15 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11a4d057dafe06241ebe7042f68f2675fa052e653cb325df1ed7df27e609d603
-  data.tar.gz: 8b4b103be5da44eb1944a2211c58af5a85397c2acc1f3c20c554663979bde68b
+  metadata.gz: 889fa8ef795bda2e3a01cf6dbf9670126977fdf24a5bb813bba82d6468b74791
+  data.tar.gz: ef1827c4e26eabd10fe8842f2bc6bcee6c49e2b5e7d699143fc0884717a3d9ff
 SHA512:
-  metadata.gz: 39f09188ae59c71fe5779d7af3d84221cf3fa439372fbc71128e2668a4cb21e3b285846004965601d21d9b273edef9a7c4c7106e70eaed6091decabf617b868f
-  data.tar.gz: 4001559c175453f4a13742233b698aa96fa03948f29f5aa0b1530e28e85e6c4056cb808f5c6199bfef7232a09d0e0f22006589aa1688908bfd7ae960b1463bb8
+  metadata.gz: 4f981326aec00f05820ff100717cbe93637e10503a26bc85798a0359dd0cba1b41745c28759730ca7b94cac8fbd40f1ef3f1158e1a49f3570b0c7ebd8def4564
+  data.tar.gz: beb783d8219358140e293f124e59a69d0f5bf0498d32095989aae3c4985232df976ef2151a90117b8a787e911a575e069dd45b97553f64bdbac52a22c09fe41d

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.15)
+    helios-opentelemetry-sdk (0.1.18)
       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

@@ -6,7 +6,8 @@ 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))
       unless body.nil?
         current_span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_REQUEST_BODY,
                                    body.is_a?(String) ? body : body.to_s)
@@ -27,5 +28,23 @@ module NetHttpPatch
 
       headers.to_json
     end
+
+    def extract_request_attributes(span, req, body)
+      ::OpenTelemetry.logger.warn('aaaaaaa')
+      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,14 +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)
-      span.set_attribute(semantic_attributes::HTTP_RESPONSE_BODY, response[0]) if response&.first&.length&.positive?
-      super(span, status, headers, response)
+      if response.respond_to?(:first) && response.first&.length&.positive?
+        span.set_attribute(semantic_attributes::HTTP_RESPONSE_BODY, response.first)
+      end
+    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.15'
+      VERSION = '0.1.18'
     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.15
+  version: 0.1.18
 platform: ruby
 authors:
 - Team Helios
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-29 00:00:00.000000000 Z
+date: 2022-08-30 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