helios-opentelemetry-sdk 0.1.11 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1adbd46e6a58a91a55e6b5f174e706564141dcbeb65d5b1c5d855632ffdb3b7c
-  data.tar.gz: 76577730e1f13b6c9f2d60aa86906cca431e90f8253d50bfb0edcb0181450c76
+  metadata.gz: 3e7f2f77a8b66880739f7a053fd1e0ac0ed6a9330d9d9068ccbeb060460ba7db
+  data.tar.gz: 806da26e71661cb27095bcc616d098b1a36af5ffbb4699e461cdeae5d0e077f4
 SHA512:
-  metadata.gz: 99f28108bf45d3a29cfdc76aafcb21330d3a25ae1567460df3173af4b1705b42cc4ac8173cf3815be7270d85d60f292f967fa1255b0f676549762db670039705
-  data.tar.gz: 66297d9845f19cd5158c7e6e14436169c96d328efe17d4cafc504fa72b7d54b0784249cfdbcdcc12961454585cc65db1101b66ff760e5e3d59657568293d8ae1
+  metadata.gz: 4dd2dac65944039de49814d7958161bcd5317864bc1bc3b35c89024691739ce4dd4bdfbd168fcd9a2a2df75212dea7c7a7c81e716156880c5e5ce6bc8618aee0
+  data.tar.gz: f5ae7746690135bf149d897fcb61fe53709a5b7bc0f8f7ed32c48116b686a2a74e4b3d79f762ce0c16425cbfb5b7cc760da4f9d23c69a848c97fa03132e03df5

data/.rubocop.yml

@@ -18,3 +18,6 @@ AllCops:
 
 Style/HashSyntax:
   Enabled: false
+
+Metrics/BlockLength:
+  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.11)
+    helios-opentelemetry-sdk (0.1.14)
       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
@@ -48,4 +48,37 @@ def apply_instrumentations(otel_config)
 
     otel_config.use(instrumentation, config)
   end
+
+  additional_patches
+end
+
+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,19 @@
+require 'faraday'
+require 'json'
+require_relative '../../semantic_attributes'
+
+module FaradayPatch
+  module HeliosFaradayMiddleware
+    def trace_response(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?
+
+      super(span, env)
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require 'json'
+require_relative '../../semantic_attributes'
+
+module NetHttpPatch
+  # Module to prepend to Net::HTTP for instrumentation
+  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))
+      unless body.nil?
+        current_span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_REQUEST_BODY,
+                                   body.is_a?(String) ? body : body.to_s)
+      end
+
+      super(req, body, &block).tap do |response|
+        current_span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_RESPONSE_HEADERS,
+                                   collect_headers(response))
+        current_span.set_attribute(Helios::OpenTelemetry::SemanticAttributes::HTTP_RESPONSE_BODY, response.body)
+      end
+    end
+
+    def collect_headers(obj)
+      headers = {}
+      obj.each_header do |k, v|
+        headers[k] = v
+      end
+
+      headers.to_json
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+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
+      if request_body&.length&.positive?
+        res[semantic_attributes::HTTP_REQUEST_BODY] = request_body
+      end
+
+      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[0]&.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.11'
+      VERSION = '0.1.14'
     end
   end
 end

data/lib/helios/opentelemetry/semantic_attributes.rb

@@ -0,0 +1,10 @@
+module Helios
+  module OpenTelemetry
+    class SemanticAttributes
+      HTTP_REQUEST_BODY = 'http.request.body'
+      HTTP_REQUEST_HEADERS = 'http.request.headers'
+      HTTP_RESPONSE_BODY = 'http.response.body'
+      HTTP_RESPONSE_HEADERS = 'http.response.headers'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helios-opentelemetry-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.14
 platform: ruby
 authors:
 - Team Helios
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +130,11 @@ files:
 - helios-opentelemetry-sdk.gemspec
 - lib/helios/opentelemetry/sdk.rb
 - lib/helios/opentelemetry/sdk/instrumentations.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
 licenses:
 - Apache-2.0