epsagon 0.0.12 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfe4b588a7d3aeac7ea954338f6814c1b733cdacaab175b8ab63711a09adb849
-  data.tar.gz: a18b237f3e75ff45e3866a4570ad4125951480366007f0700af412254e04fd5e
+  metadata.gz: cff5af42ab7df270fc1a9c645d5dc25558e03ba194e2d642694dbbeaa074ebf6
+  data.tar.gz: 75971b80361f7feefeb45af21074d2357eeb4cdeb82ce0bdad989493b3b1abc6
 SHA512:
-  metadata.gz: 4b0e7b5e44f8941fe647e69cb4f59c86ce144eef01fe7c96a035652c8fede98d2b781d59f495a852e1c0919fa5af40fe6413e2ef2c6c2b9c3b4a013b5ebef5c0
-  data.tar.gz: d67ce25f32683d501729e1715e6427881f7a89fc730030ade43ca3df05402c8277237df9fb1f38c9a4e460f21863a076903c2c8f011b715b50b56d4be3e2b549
+  metadata.gz: a71dffcee29e3039cd7be5a5bf7cd60661574b86b0cc45b1b1b55df5d1b8108f1f713ace4ccb173f5283638212798f2a7e0430fbc76f6d3f35eeec52c8008d0b
+  data.tar.gz: 18b465927c9dc8b8ea722b55cc8b9e896fc498b6aa02b7a6c2e628c848ffebfe3f637ae417a2361879e511311907f480bad565091e75bd94d488b1a7f90b4b51

data/lib/epsagon.rb

@@ -12,18 +12,23 @@ require_relative 'instrumentation/faraday'
 require_relative 'instrumentation/aws_sdk'
 require_relative 'instrumentation/rails'
 require_relative 'util'
+require_relative 'epsagon_constants'
 
 Bundler.require
 
 # Epsagon tracing main entry point
 module Epsagon
+  
+  DEFAULT_BACKEND = 'opentelemetry.tc.epsagon.com:443/traces'
+
   @@epsagon_config = {
-      metadata_only: ENV['EPSAGON_METADATA']&.to_s&.downcase != 'false',
-      debug: ENV['EPSAGON_DEBUG']&.to_s&.downcase == 'true',
-      token: ENV['EPSAGON_TOKEN'],
-      app_name: ENV['EPSAGON_APP_NAME'],
-      backend: ENV['EPSAGON_BACKEND'] || 'localhost:55681/v1/trace'
-    }
+    metadata_only: ENV['EPSAGON_METADATA']&.to_s&.downcase != 'false',
+    debug: ENV['EPSAGON_DEBUG']&.to_s&.downcase == 'true',
+    token: ENV['EPSAGON_TOKEN'],
+    app_name: ENV['EPSAGON_APP_NAME'],
+    max_attribute_size: ENV['EPSAGON_MAX_ATTRIBUTE_SIZE'] || 5000,
+    backend: ENV['EPSAGON_BACKEND'] || DEFAULT_BACKEND
+  }
 
   module_function
 
@@ -32,11 +37,18 @@ module Epsagon
     OpenTelemetry::SDK.configure
   end
 
+  def get_config
+    @@epsagon_config
+  end
+
   # config opentelemetry with epsaon extensions:
 
   def epsagon_confs(configurator)
     configurator.resource = OpenTelemetry::SDK::Resources::Resource.telemetry_sdk.merge(
-      OpenTelemetry::SDK::Resources::Resource.create({ 'application' => @@epsagon_config[:app_name] })
+      OpenTelemetry::SDK::Resources::Resource.create({ 
+        'application' => @@epsagon_config[:app_name],
+        'epsagon.version' => EpsagonConstants::VERSION
+      })
     )
     configurator.use 'EpsagonSinatraInstrumentation', { epsagon: @@epsagon_config }
     configurator.use 'EpsagonNetHTTPInstrumentation', { epsagon: @@epsagon_config }
@@ -47,10 +59,10 @@ module Epsagon
     if @@epsagon_config[:debug]
       configurator.add_span_processor OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
         OpenTelemetry::Exporter::OTLP::Exporter.new(headers: {
-                            'x-epsagon-token' => @@epsagon_config[:token]
-                          },
-                          endpoint: @@epsagon_config[:backend],
-                          insecure: @@epsagon_config[:insecure] || false)
+                                                      'x-epsagon-token' => @@epsagon_config[:token]
+                                                    },
+                                                    endpoint: @@epsagon_config[:backend],
+                                                    insecure: @@epsagon_config[:insecure] || false)
       )
 
       configurator.add_span_processor OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
@@ -66,7 +78,29 @@ module Epsagon
       )
     end
   end
+end
 
+
+module SpanExtension
+
+  BLANKS = [nil, [], '']
+
+  def set_attribute(key, value)
+    unless BLANKS.include?(value)
+      value = Util.trim_attr(value, Epsagon.get_config[:max_attribute_size])
+      super(key, value)
+    end
+  end
+
+  def initialize(*args)
+    super(*args)
+    if @attributes
+      @attributes = Hash[@attributes.map { |k,v|
+        [k, Util.trim_attr(v, Epsagon.get_config[:max_attribute_size])]
+      }]
+    end
+    
+  end
 end
 
 # monkey patch to include epsagon confs
@@ -79,5 +113,11 @@ module OpenTelemetry
         Epsagon.epsagon_confs c
       end
     end
+
+    module Trace
+      class Span
+        prepend SpanExtension
+      end
+    end
   end
 end

data/lib/epsagon_constants.rb

@@ -0,0 +1,3 @@
+module EpsagonConstants
+	VERSION = '0.0.17'
+end

data/lib/instrumentation/aws_sdk.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require_relative '../util'
+require_relative '../epsagon_constants'
 
 # AWS SDK epsagon instrumentation
 class EpsagonAwsSdkInstrumentation < OpenTelemetry::Instrumentation::Base
-  VERSION = '0.0.0'
+  VERSION = EpsagonConstants::VERSION
   SERVICES = %w[
     ACM
     APIGateway

data/lib/instrumentation/aws_sdk_plugin.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 require 'aws-sdk-core'
 require 'opentelemetry/common'
 require 'opentelemetry/sdk'
 
-def untraced
-  OpenTelemetry::Trace.with_span(OpenTelemetry::Trace::Span.new) { yield }
+def untraced(&block)
+  OpenTelemetry::Trace.with_span(OpenTelemetry::Trace::Span.new, &block)
 end
+
 # AWS SDK plugin for epsagon instrumentation
 class EpsagonAwsPlugin < Seahorse::Client::Plugin
   def add_handlers(handlers, _)
@@ -15,19 +18,19 @@ end
 # Generates Spans for all uses of AWS SDK
 class EpsagonAwsHandler < Seahorse::Client::Handler
   def call(context)
-    tracer.in_span('') do |span|
+    tracer.in_span('', kind: :client) do |span|
       untraced do
         @handler.call(context).tap do
           span.set_attribute('aws.service', context.client.class.to_s.split('::')[1].downcase)
-          span.set_attribute('aws.aws.operation', context.operation.name)
+          span.set_attribute('aws.operation', context.operation.name)
           span.set_attribute('aws.region', context.client.config.region)
-          span.set_attribute('aws.status_code', context.http_response.status_code)
+          span.set_attribute('http.status_code', context.http_response.status_code)
         end
       end
     end
   end
 
   def tracer
-    EpsagonAwsSdkInstrumentation.instance.tracer
+    EpsagonAwsSdkInstrumentation.instance.tracer()
   end
-end
+end

data/lib/instrumentation/epsagon_faraday_middleware.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
 
 require_relative '../util'
+require_relative '../epsagon_constants'
+
 require 'faraday'
 
 # Faraday middleware for epsagon instrumentaton

data/lib/instrumentation/epsagon_rails_middleware.rb

@@ -1,41 +1,42 @@
-require 'opentelemetry/trace/status'
+# frozen_string_literal: true
 
+require 'opentelemetry/trace/status'
 
 module QueueTime
-	REQUEST_START = 'HTTP_X_REQUEST_START'
-	QUEUE_START = 'HTTP_X_QUEUE_START'
-	MINIMUM_ACCEPTABLE_TIME_VALUE = 1_000_000_000
-
-	module_function
-
-	def get_request_start(env, now = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-	  header = env[REQUEST_START] || env[QUEUE_START]
-	  return unless header
-
-	  # nginx header is seconds in the format "t=1512379167.574"
-	  # apache header is microseconds in the format "t=1570633834463123"
-	  # heroku header is milliseconds in the format "1570634024294"
-	  time_string = header.to_s.delete('^0-9')
-	  return if time_string.nil?
-
-	  # Return nil if the time is clearly invalid
-	  time_value = "#{time_string[0, 10]}.#{time_string[10, 6]}".to_f
-	  return if time_value.zero? || time_value < MINIMUM_ACCEPTABLE_TIME_VALUE
-
-	  # return the request_start only if it's lesser than
-	  # current time, to avoid significant clock skew
-	  request_start = Time.at(time_value)
-	  now ||= Time.now.utc
-	  request_start.utc > now ? nil : request_start
-	rescue StandardError => e
-	  # in case of an Exception we don't create a
-	  # `request.queuing` span
-	  OpenTelemetry.logger.debug("[rack] unable to parse request queue headers: #{e}")
-	  nil
-	end
+  REQUEST_START = 'HTTP_X_REQUEST_START'
+  QUEUE_START = 'HTTP_X_QUEUE_START'
+  MINIMUM_ACCEPTABLE_TIME_VALUE = 1_000_000_000
+
+  module_function
+
+  def get_request_start(env, now = nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    header = env[REQUEST_START] || env[QUEUE_START]
+    return unless header
+
+    # nginx header is seconds in the format "t=1512379167.574"
+    # apache header is microseconds in the format "t=1570633834463123"
+    # heroku header is milliseconds in the format "1570634024294"
+    time_string = header.to_s.delete('^0-9')
+    return if time_string.nil?
+
+    # Return nil if the time is clearly invalid
+    time_value = "#{time_string[0, 10]}.#{time_string[10, 6]}".to_f
+    return if time_value.zero? || time_value < MINIMUM_ACCEPTABLE_TIME_VALUE
+
+    # return the request_start only if it's lesser than
+    # current time, to avoid significant clock skew
+    request_start = Time.at(time_value)
+    now ||= Time.now.utc
+    request_start.utc > now ? nil : request_start
+  rescue StandardError => e
+    # in case of an Exception we don't create a
+    # `request.queuing` span
+    OpenTelemetry.logger.debug("[rack] unable to parse request queue headers: #{e}")
+    nil
+  end
 end
 
-class EpsagonRackMiddleware # rubocop:disable Metrics/ClassLength
+class EpsagonRackMiddleware
   class << self
     def allowed_rack_request_headers
       @allowed_rack_request_headers ||= Array(config[:allowed_request_headers]).each_with_object({}) do |header, memo|
@@ -72,7 +73,7 @@ class EpsagonRackMiddleware # rubocop:disable Metrics/ClassLength
     @app = app
   end
 
-  def call(env) # rubocop:disable Metrics/AbcSize
+  def call(env)
     original_env = env.dup
     extracted_context = OpenTelemetry.propagation.http.extract(env)
     frontend_context = create_frontend_span(env, extracted_context)
@@ -84,7 +85,11 @@ class EpsagonRackMiddleware # rubocop:disable Metrics/ClassLength
                      attributes: request_span_attributes(env: env),
                      kind: :server) do |http_span|
         RackExtension.with_span(http_span) do
-          tracer.in_span('rails') do |framework_span|
+          tracer.in_span(
+              env['HTTP_HOST'],
+              kind: :server,
+              attributes: {type: 'rails'}
+            ) do |framework_span|
             @app.call(env).tap do |status, headers, response|
               set_attributes_after_request(http_span, framework_span, status, headers, response)
             end
@@ -134,7 +139,7 @@ class EpsagonRackMiddleware # rubocop:disable Metrics/ClassLength
     attributes = {
       'operation' => env['REQUEST_METHOD'],
       'type' => 'http',
-      'http.scheme' => env['PATH_INFO'],
+      'http.scheme' => env['rack.url_scheme'],
       'http.request.path' => path,
       'http.request.headers' => request_headers
     }
@@ -181,7 +186,7 @@ class EpsagonRackMiddleware # rubocop:disable Metrics/ClassLength
     end
   end
 
-  def set_attributes_after_request(http_span, framework_span, status, headers, response)
+  def set_attributes_after_request(http_span, _framework_span, status, headers, response)
     unless config[:epsagon][:metadata_only]
       http_span.set_attribute('http.response.headers', JSON.generate(headers))
       http_span.set_attribute('http.response.body', response.join)
@@ -269,7 +274,6 @@ end
 #   end
 # end
 
-
 class EpsagonRailtie < ::Rails::Railtie
   config.before_initialize do |app|
     # EpsagonRackInstrumentation.instance.install({})

data/lib/instrumentation/faraday.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Patch faraday to include middleware
 module EpsagonFaradayPatch
   def adapter(*args)
@@ -12,7 +13,7 @@ end
 
 # Faraday epsagon instrumentaton
 class EpsagonFaradayInstrumentation < OpenTelemetry::Instrumentation::Base
-  VERSION = '0.0.0'
+  VERSION = EpsagonConstants::VERSION
 
   install do |_config|
     require_relative 'epsagon_faraday_middleware'

data/lib/instrumentation/net_http.rb

@@ -3,6 +3,7 @@
 require 'opentelemetry'
 
 require_relative '../util'
+require_relative '../epsagon_constants'
 
 # Net::HTTP patch for epsagon instrumentaton
 module EpsagonNetHTTPExtension
@@ -40,7 +41,7 @@ module EpsagonNetHTTPExtension
     tracer.in_span(
       @address,
       attributes: attributes,
-      kind: :Client
+      kind: :client
     ) do |span|
       OpenTelemetry.propagation.http.inject(req)
 
@@ -74,7 +75,7 @@ end
 
 # Net::HTTP epsagon instrumentaton
 class EpsagonNetHTTPInstrumentation < OpenTelemetry::Instrumentation::Base
-  VERSION = '0.0.0'
+  VERSION = EpsagonConstants::VERSION
 
   install do |_|
     ::Net::HTTP.prepend(EpsagonNetHTTPExtension)

data/lib/instrumentation/rails.rb

@@ -1,12 +1,15 @@
-  
+# frozen_string_literal: true
+
 require 'opentelemetry'
 require 'rails'
-require "action_controller/railtie"
+require 'action_controller/railtie'
 
 require_relative '../util'
+require_relative '../epsagon_constants'
+
 
 module RackExtension
-  extend self
+  module_function
 
   CURRENT_SPAN_KEY = OpenTelemetry::Context.create_key('current-span')
 
@@ -41,7 +44,7 @@ module RackExtension
     OpenTelemetry::Context.with_value(CURRENT_SPAN_KEY, span) { |c, s| yield s, c }
   end
 end
-  
+
 module MetalPatch
   def dispatch(name, request, response)
     rack_span = RackExtension.current_span
@@ -50,15 +53,13 @@ module MetalPatch
   end
 end
 
-
-
 class EpsagonRailsInstrumentation < OpenTelemetry::Instrumentation::Base
-    install do |_config|
-      require_relative 'epsagon_rails_middleware'
-      ::ActionController::Metal.prepend(MetalPatch)
-    end
+  install do |_config|
+    require_relative 'epsagon_rails_middleware'
+    ::ActionController::Metal.prepend(MetalPatch)
+  end
 
-    present do
-      defined?(::Rails)
-    end
-end
+  present do
+    defined?(::Rails)
+  end
+end

data/lib/instrumentation/sinatra.rb

@@ -3,6 +3,7 @@
 require 'opentelemetry'
 
 require_relative '../util'
+require_relative '../epsagon_constants'
 
 # Sinatra middleware for epsagon instrumentation
 class EpsagonTracerMiddleware
@@ -26,7 +27,7 @@ class EpsagonTracerMiddleware
     attributes = {
       'operation' => env['REQUEST_METHOD'],
       'type' => 'http',
-      'http.scheme' => env['PATH_INFO'],
+      'http.scheme' => env['rack.url_scheme'],
       'http.request.path' => path,
       'http.request.headers' => request_headers
     }
@@ -51,7 +52,11 @@ class EpsagonTracerMiddleware
       kind: :server,
       with_parent: parent_context(env)
     ) do |http_span|
-      tracer.in_span('sinatra') do |framework_span|
+      tracer.in_span(
+        env['HTTP_HOST'],
+        kind: :server,
+        attributes: { type: 'sinatra' }
+      ) do |framework_span|
         app.call(env).tap { |resp| trace_response(http_span, framework_span, env, resp) }
       end
     end
@@ -78,7 +83,7 @@ class EpsagonTracerMiddleware
     end
 
     http_span.set_attribute('http.status_code', status)
-    framework_span.set_attribute('http.route', env['sinatra.route'].split.last) if env['sinatra.route']
+    http_span.set_attribute('http.route', env['sinatra.route'].split.last) if env['sinatra.route']
     http_span.status = OpenTelemetry::Trace::Status.http_to_status(status)
   end
 end
@@ -107,7 +112,7 @@ end
 
 # Sinatra epsagon instrumentation
 class EpsagonSinatraInstrumentation < OpenTelemetry::Instrumentation::Base
-  VERSION = '0.0.0'
+  VERSION = EpsagonConstants::VERSION
 
   install do |_|
     ::Sinatra::Base.register EpsagonTracerExtension

data/lib/util.rb

@@ -11,4 +11,23 @@ module Util
       { 'http.request.query' => query_string }
     end
   end
+
+  def self.trim_attr(value, max_size)
+  	if value.instance_of? Array then 
+  		current_size = 2
+  		value.each_with_index do |el, i|
+  			el_size =  el.to_s.size + (i==0 ? 0 : 2)
+  			if current_size + el_size > max_size then 
+  				return value[0,i] + [Util.trim_attr(el, max_size - current_size)]
+  			else 
+  				current_size += el_size
+  			end
+  		end
+  		return value
+  	elsif value.instance_of? String then
+  		value[0, max_size]
+  	else
+  		value
+  	end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epsagon
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.17
 platform: ruby
 authors:
 - Epsagon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: opentelemetry-sdk
+  name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: opentelemetry-exporter-otlp
+  name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.11.1
 description: 'Epsagon provides tracing to Ruby applications for the collection of
   distributed tracing and performance metrics to simplify complex architectures, eliminate
   manual work, visualize and correlate data to identify and fix problems fast.
@@ -77,6 +77,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/epsagon.rb
+- lib/epsagon_constants.rb
 - lib/instrumentation/aws_sdk.rb
 - lib/instrumentation/aws_sdk_plugin.rb
 - lib/instrumentation/epsagon_faraday_middleware.rb
@@ -85,6 +86,7 @@ files:
 - lib/instrumentation/net_http.rb
 - lib/instrumentation/rails.rb
 - lib/instrumentation/sinatra.rb
+- lib/instrumentation/version.rb
 - lib/util.rb
 homepage: https://github.com/epsagon/epsagon-ruby
 licenses: