helios-opentelemetry-sdk 0.1.12 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce889a94723b9b8f7b2c8da0a10608f5ae627841543649b3716cc01c5d915c2c
-  data.tar.gz: ef7bc57d8507c1bb613a603197414700a9e428a58f9d271d5b3c19d975a97f68
+  metadata.gz: 11a4d057dafe06241ebe7042f68f2675fa052e653cb325df1ed7df27e609d603
+  data.tar.gz: 8b4b103be5da44eb1944a2211c58af5a85397c2acc1f3c20c554663979bde68b
 SHA512:
-  metadata.gz: 1199e9514864e6497bd3cff0f9f2c311bd6711298ac4d6e7f94834bcb02c84d90ce08b0404ca76b2b6425736d027c3e91e67eb5e846ddfb5c01a4a8af36eae70
-  data.tar.gz: a9d5cf728fda4d6745386218ffc55e7df3bbf0a1ac6119c404c94379106f7f570c51905c3f484046636b51604765dad633e7b1d82ca6f193ac159191a90ab3a7
+  metadata.gz: 39f09188ae59c71fe5779d7af3d84221cf3fa439372fbc71128e2668a4cb21e3b285846004965601d21d9b273edef9a7c4c7106e70eaed6091decabf617b868f
+  data.tar.gz: 4001559c175453f4a13742233b698aa96fa03948f29f5aa0b1530e28e85e6c4056cb808f5c6199bfef7232a09d0e0f22006589aa1688908bfd7ae960b1463bb8

data/.rubocop.yml

@@ -21,3 +21,6 @@ Style/HashSyntax:
 
 Metrics/BlockLength:
   Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false

data/Gemfile

@@ -8,3 +8,5 @@ gem 'opentelemetry-instrumentation-all', '~> 0.25.0'
 gem 'opentelemetry-instrumentation-rspec', '~> 0.2.0'
 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]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    helios-opentelemetry-sdk (0.1.12)
+    helios-opentelemetry-sdk (0.1.15)
       opentelemetry-exporter-otlp (~> 0.22.0)
       opentelemetry-instrumentation-all (~> 0.25.0)
       opentelemetry-instrumentation-rspec (~> 0.2.0)
@@ -12,6 +12,10 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
     google-protobuf (3.21.1)
     googleapis-common-protos-types (1.3.1)
       google-protobuf (~> 3.14)
@@ -201,6 +205,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
+    rack (2.2.4)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
@@ -238,11 +243,13 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.3.16)
+  faraday (~> 2.3.0)
   helios-opentelemetry-sdk!
   opentelemetry-exporter-otlp (~> 0.22.0)
   opentelemetry-instrumentation-all (~> 0.25.0)
   opentelemetry-instrumentation-rspec (~> 0.2.0)
   opentelemetry-sdk (~> 1.1.0)
+  rack (~> 2.2.4)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.30.1)

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

@@ -32,7 +32,7 @@ SUPPORTED_INSTRUMENTATIONS = {
   'OpenTelemetry::Instrumentation::Que' => { propagation_style: :child },
   'OpenTelemetry::Instrumentation::Rack' => {},
   'OpenTelemetry::Instrumentation::Rdkafka' => {},
-  'OpenTelemetry::Instrumentation::Redis' => {},
+  'OpenTelemetry::Instrumentation::Redis' => { db_statement: :include },
   'OpenTelemetry::Instrumentation::Resque' => { propagation_style: :child },
   'OpenTelemetry::Instrumentation::RestClient' => {},
   'OpenTelemetry::Instrumentation::RSpec' => nil, # Disabled for now
@@ -52,7 +52,33 @@ def apply_instrumentations(otel_config)
   additional_patches
 end
 
-def additional_patches
-  require_relative 'net_http_patch'
+def patch_net_http
+  require_relative 'patches/net_http_patch'
   ::Net::HTTP.prepend(NetHttpPatch::Instrumentation)
 end
+
+def patch_faraday
+  return unless defined?(::Faraday)
+
+  require 'opentelemetry/instrumentation/faraday/middlewares/tracer_middleware'
+  require_relative 'patches/faraday_patch'
+  ::OpenTelemetry::Instrumentation::Faraday::Middlewares::TracerMiddleware.prepend(
+    FaradayPatch::HeliosFaradayMiddleware
+  )
+end
+
+def patch_rack
+  return unless defined?(::Rack)
+
+  require 'opentelemetry/instrumentation/rack/middlewares/tracer_middleware'
+  require_relative 'patches/rack_patch'
+  ::OpenTelemetry::Instrumentation::Rack::Middlewares::TracerMiddleware.prepend(
+    RackPatch::HeliosRackMiddleware
+  )
+end
+
+def additional_patches
+  patch_net_http
+  patch_faraday
+  patch_rack
+end

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

@@ -0,0 +1,22 @@
+require 'faraday'
+require 'json'
+require_relative '../../semantic_attributes'
+
+module FaradayPatch
+  module HeliosFaradayMiddleware
+    def trace_response(span, env)
+      extract_additional_attributes(span, env)
+      super(span, env)
+    end
+
+    def extract_additional_attributes(span, env)
+      request_headers = env.request_headers
+      semantic_attributes = Helios::OpenTelemetry::SemanticAttributes
+      span.set_attribute(semantic_attributes::HTTP_REQUEST_HEADERS, request_headers.to_json)
+      span.set_attribute(semantic_attributes::HTTP_REQUEST_BODY, env.body) unless env.body.nil?
+      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?
+    end
+  end
+end

data/lib/helios/opentelemetry/sdk/{net_http_patch.rb → patches/net_http_patch.rb}

@@ -1,5 +1,5 @@
 require 'json'
-require_relative '../semantic_attributes'
+require_relative '../../semantic_attributes'
 
 module NetHttpPatch
   # Module to prepend to Net::HTTP for instrumentation
@@ -7,7 +7,7 @@ module NetHttpPatch
     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))
-      unless req.body.nil?
+      unless body.nil?
         current_span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_REQUEST_BODY,
                                    body.is_a?(String) ? body : body.to_s)
       end

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

@@ -0,0 +1,26 @@
+require 'rack'
+require 'json'
+require_relative '../../semantic_attributes'
+
+module RackPatch
+  module HeliosRackMiddleware
+    def request_span_attributes(env:)
+      res = super(env: env)
+      # 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
+      res[semantic_attributes::HTTP_REQUEST_HEADERS] = request_headers.to_json
+      request_body = env['rack.input']&.read
+      env['rack.input']&.rewind
+      res[semantic_attributes::HTTP_REQUEST_BODY] = request_body if request_body&.length&.positive?
+      res
+    end
+
+    def set_attributes_after_request(span, status, 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)
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 module Helios
   module OpenTelemetry
     module SDK
-      VERSION = '0.1.12'
+      VERSION = '0.1.15'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helios-opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.15
 platform: ruby
 authors:
 - Team Helios
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +130,9 @@ files:
 - helios-opentelemetry-sdk.gemspec
 - lib/helios/opentelemetry/sdk.rb
 - lib/helios/opentelemetry/sdk/instrumentations.rb
-- lib/helios/opentelemetry/sdk/net_http_patch.rb
+- lib/helios/opentelemetry/sdk/patches/faraday_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
 - lib/helios/opentelemetry/semantic_attributes.rb
 homepage: https://gethelios.dev