epsagon 0.0.28 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a17b55f2ce2ff35ca70dd51e8f8337041e202c528b6c691800d3e3b7b0d42c4
-  data.tar.gz: d93046c571faa2d35a681217cb12952c57c7bd3232e77a136a5954a5534541b1
+  metadata.gz: 25cf09d9ea5babb3e7caa3380d6b8a78365909391ec3eb84ec150e07fbd9841a
+  data.tar.gz: bb3f2efc49e2b0930ffb677bfb5b8440fa16fe2a41a7adb96b33a35e89efdb67
 SHA512:
-  metadata.gz: 9290a8dee89f24588f93bca0ab331855cab0cd46e09fdae10c4bb0c00c7c61c35c6045bc6b41971639767fc46f30d241b49a45a89a51c29baaa734113188aa7a
-  data.tar.gz: 3c4c1b54d0b344bf7399f3d088cd22bebca010d2b063244b425693bcaa2ef0ced625ec3a0921d1d5ce0cf7effd81e90dc6e410d5c893f1062096c78ec66e795f
+  metadata.gz: b179e2cf5b65329b6a7a40dec43a379fb294ddee0e58f389cd4ffc105f503265ad655cbf50067a9995b04358ddb9d9d0f8441d47e2639befcc4744c8af3c290c
+  data.tar.gz: 5b8443325b4afadffed3f836ba9a7385cbdfbc2cd03eebfee007bb0543ddb5f2b3c279d22a614fa80ecabb7f4a18f6a1292298567d444a84c9a364ef361bb626

data/lib/epsagon.rb

@@ -13,6 +13,7 @@ require_relative 'instrumentation/faraday'
 require_relative 'instrumentation/aws_sdk'
 require_relative 'instrumentation/rails'
 require_relative 'instrumentation/postgres'
+require_relative 'instrumentation/resque'
 require_relative 'util'
 require_relative 'epsagon_constants'
 require_relative 'exporter_extension'
@@ -20,10 +21,13 @@ require_relative 'arn_parser'
 
 Bundler.require
 
+
 # Epsagon tracing main entry point
 module Epsagon
   DEFAULT_BACKEND = 'opentelemetry.tc.epsagon.com:443/traces'
   DEFAULT_IGNORE_DOMAINS = ['newrelic.com'].freeze
+  MUTABLE_CONF_KEYS = Set.new([:metadata_only, :max_attribute_size, :ignore_domains]) 
+
 
   @@epsagon_config = nil
 
@@ -31,7 +35,29 @@ module Epsagon
 
   def init(**args)
     get_config.merge!(args)
+    validate(get_config)
     OpenTelemetry::SDK.configure
+    @@initialized = true
+  end
+
+  def validate(config)
+    Util.validate_value(config, :metadata_only, 'Must be a boolean') {|v| !!v == v}
+    Util.validate_value(config, :debug, 'Must be a boolean') {|v| !!v == v}
+    Util.validate_value(config, :token, 'Must be a valid Epsagon token') {|v| v.is_a? String and v.size > 10}
+    Util.validate_value(config, :app_name, 'Must be a String') {|v| v.is_a? String}
+    Util.validate_value(config, :max_attribute_size, 'Must be an Integer') {|v| v.is_a? Integer}
+    Util.validate_value(config, :ignore_domains, 'Must be iterable') {|v| v.respond_to?(:each)}
+    Util.validate_value(config, :ignore_domains, 'Must be iterable') {|v| v.respond_to?(:each)}
+  end
+
+  def set_config(**args)
+    unless args.keys.all? {|a| MUTABLE_CONF_KEYS.include?(a)}
+      raise ArgumentError("only #{MUTABLE_CONF_KEYS.to_a} are mutable after `Epsagon.init`")
+    end
+    Epsagon.init unless @@initialized
+    new_conf = get_config.merge(args)
+    validate(new_conf)
+    @@epsagon_config = new_conf
   end
 
   def get_config
@@ -85,28 +111,22 @@ module Epsagon
     configurator.use 'EpsagonRailsInstrumentation', { epsagon: get_config }
     configurator.use 'OpenTelemetry::Instrumentation::Sidekiq', { epsagon: get_config }
     configurator.use 'EpsagonPostgresInstrumentation', { epsagon: get_config }
+    configurator.use 'EpsagonResqueInstrumentation', { epsagon: get_config }
 
-    if get_config[:debug]
-      configurator.add_span_processor OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
-        OpenTelemetry::Exporter::OTLP::Exporter.new(headers: {
-                                                      'x-epsagon-token' => get_config[:token]
-                                                    },
-                                                    endpoint: get_config[:backend],
-                                                    insecure: get_config[:insecure] || false)
-      )
 
+    if get_config[:debug]
       configurator.add_span_processor OpenTelemetry::SDK::Trace::Export::SimpleSpanProcessor.new(
         OpenTelemetry::SDK::Trace::Export::ConsoleSpanExporter.new
       )
-    else
-      configurator.add_span_processor OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-        exporter: OpenTelemetry::Exporter::OTLP::Exporter.new(headers: {
-                                                                'x-epsagon-token' => get_config[:token]
-                                                              },
-                                                              endpoint: get_config[:backend],
-                                                              insecure: get_config[:insecure] || false)
-      )
     end
+
+    configurator.add_span_processor OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+      exporter: OpenTelemetry::Exporter::OTLP::Exporter.new(headers: {
+                                                              'x-epsagon-token' => get_config[:token]
+                                                            },
+                                                            endpoint: get_config[:backend],
+                                                            insecure: get_config[:insecure] || false)
+    )
   end
 end
 

data/lib/epsagon_constants.rb

@@ -1,3 +1,3 @@
 module EpsagonConstants
-	VERSION = '0.0.28'
+	VERSION = '0.0.29'
 end

data/lib/instrumentation/aws_sdk.rb

@@ -7,6 +7,7 @@ require_relative '../epsagon_constants'
 class EpsagonAwsSdkInstrumentation < OpenTelemetry::Instrumentation::Base
   VERSION = EpsagonConstants::VERSION
   SERVICES = %w[
+    SecretsManager
     ACM
     APIGateway
     AppStream

data/lib/instrumentation/epsagon_rails_middleware.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'opentelemetry/trace/status'
+require 'action_controller/railtie'
 
 module QueueTime
   REQUEST_START = 'HTTP_X_REQUEST_START'
@@ -284,3 +285,48 @@ class EpsagonRailtie < ::Rails::Railtie
     )
   end
 end
+
+module RackExtension
+  module_function
+
+  CURRENT_SPAN_KEY = OpenTelemetry::Context.create_key('current-span')
+
+  private_constant :CURRENT_SPAN_KEY
+
+  # Returns the current span from the current or provided context
+  #
+  # @param [optional Context] context The context to lookup the current
+  #   {Span} from. Defaults to Context.current
+  def current_span(context = nil)
+    context ||= OpenTelemetry::Context.current
+    context.value(CURRENT_SPAN_KEY) || OpenTelemetry::Trace::Span::INVALID
+  end
+
+  # Returns a context containing the span, derived from the optional parent
+  # context, or the current context if one was not provided.
+  #
+  # @param [optional Context] context The context to use as the parent for
+  #   the returned context
+  def context_with_span(span, parent_context: OpenTelemetry::Context.current)
+    parent_context.set_value(CURRENT_SPAN_KEY, span)
+  end
+
+  # Activates/deactivates the Span within the current Context, which makes the "current span"
+  # available implicitly.
+  #
+  # On exit, the Span that was active before calling this method will be reactivated.
+  #
+  # @param [Span] span the span to activate
+  # @yield [span, context] yields span and a context containing the span to the block.
+  def with_span(span)
+    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
+    # rack_span.name = "#{self.class.name}##{name}" if rack_span.context.valid? && !request.env['action_dispatch.exception']
+    super(name, request, response)
+  end
+end

data/lib/instrumentation/epsagon_resque_job.rb

@@ -0,0 +1,113 @@
+require 'json'
+
+module EpsagonResqueModule
+  def self.prepended(base)
+    class << base
+      prepend ClassMethods
+    end
+  end
+
+  # Module to prepend to Resque singleton class
+  module ClassMethods
+    def push(queue, item)
+      epsagon_conf = config[:epsagon] || {}
+      # Check if the job is being wrapped by ActiveJob
+      # before retrieving the job class name
+      job_class = if item[:class] == 'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper' && item[:args][0]&.is_a?(Hash)
+                    item[:args][0]['job_class']
+                  else
+                    item[:class]
+                  end
+      attributes = {
+        'operation' => 'enqueue',
+        'messaging.system' => 'resque',
+        'messaging.resque.job_class' => job_class,
+        'messaging.destination' => queue.to_s,
+        'messaging.destination_kind' => 'queue',
+        'messaging.resque.redis_url' => Resque.redis.connection[:id]
+      }
+      unless epsagon_conf[:metadata_only]
+        attributes.merge!({
+          'messaging.resque.args' => JSON.dump(item)
+        })
+      end
+
+      tracer.in_span(queue.to_s, attributes: attributes, kind: :producer) do
+        OpenTelemetry.propagation.text.inject(item)
+        super
+      end
+    end
+
+    def tracer
+      EpsagonResqueInstrumentation.instance.tracer
+    end
+
+    def config
+      EpsagonResqueInstrumentation.instance.config
+    end
+  end
+end
+
+module EpsagonResqueJob
+  def perform # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    inner_exception = nil
+    epsagon_conf = config[:epsagon] || {}
+    job_args = args || []
+
+    # Check if the job is being wrapped by ActiveJob
+    # before retrieving the job class name
+    job_class = if payload_class_name == 'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper' && job_args[0]&.is_a?(Hash)
+                  job_args[0]['job_class']
+                else
+                  payload_class_name
+                end
+
+    attributes = {
+        'operation' => 'perform',
+        'messaging.system' => 'resque',
+        'messaging.resque.job_class' => job_class,
+        'messaging.destination' => queue.to_s,
+        'messaging.destination_kind' => 'queue',
+        'messaging.resque.redis_url' => Resque.redis.connection[:id]
+    }
+    runner_attributes = {
+      'type' => 'resque_worker',
+      'messaging.resque.redis_url' => Resque.redis.connection[:id],
+
+    }
+
+    extracted_context = OpenTelemetry.propagation.text.extract(@payload)
+
+    unless epsagon_conf[:metadata_only]
+      attributes.merge!({
+        'messaging.resque.args' => JSON.dump(args)
+      })
+    end
+    tracer.in_span(
+      queue.to_s,
+      attributes: attributes,
+      with_parent: extracted_context,
+      kind: :consumer
+    ) do |trigger_span|
+      tracer.in_span(job_class,
+        attributes: runner_attributes,
+        kind: :consumer
+      ) do |runner_span|
+        super
+      end
+    rescue Exception => e
+      inner_exception = e
+    end
+    raise inner_exception if inner_exception
+  end
+
+  private
+
+  def tracer
+    EpsagonResqueInstrumentation.instance.tracer
+  end
+
+  def config
+    EpsagonResqueInstrumentation.instance.config
+  end
+end

data/lib/instrumentation/rails.rb

@@ -1,58 +1,11 @@
 # frozen_string_literal: true
 
 require 'opentelemetry'
-require 'rails'
-require 'action_controller/railtie'
 
 require_relative '../util'
 require_relative '../epsagon_constants'
 
 
-module RackExtension
-  module_function
-
-  CURRENT_SPAN_KEY = OpenTelemetry::Context.create_key('current-span')
-
-  private_constant :CURRENT_SPAN_KEY
-
-  # Returns the current span from the current or provided context
-  #
-  # @param [optional Context] context The context to lookup the current
-  #   {Span} from. Defaults to Context.current
-  def current_span(context = nil)
-    context ||= OpenTelemetry::Context.current
-    context.value(CURRENT_SPAN_KEY) || OpenTelemetry::Trace::Span::INVALID
-  end
-
-  # Returns a context containing the span, derived from the optional parent
-  # context, or the current context if one was not provided.
-  #
-  # @param [optional Context] context The context to use as the parent for
-  #   the returned context
-  def context_with_span(span, parent_context: OpenTelemetry::Context.current)
-    parent_context.set_value(CURRENT_SPAN_KEY, span)
-  end
-
-  # Activates/deactivates the Span within the current Context, which makes the "current span"
-  # available implicitly.
-  #
-  # On exit, the Span that was active before calling this method will be reactivated.
-  #
-  # @param [Span] span the span to activate
-  # @yield [span, context] yields span and a context containing the span to the block.
-  def with_span(span)
-    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
-    # rack_span.name = "#{self.class.name}##{name}" if rack_span.context.valid? && !request.env['action_dispatch.exception']
-    super(name, request, response)
-  end
-end
-
 class EpsagonRailsInstrumentation < OpenTelemetry::Instrumentation::Base
   install do |_config|
     require_relative 'epsagon_rails_middleware'

data/lib/instrumentation/resque.rb

@@ -0,0 +1,21 @@
+class EpsagonResqueInstrumentation < OpenTelemetry::Instrumentation::Base
+  install do |_config|
+    require_dependencies
+    patch
+  end
+
+  present do
+    defined?(::Resque)
+  end
+
+  private
+
+  def patch
+    ::Resque.prepend(EpsagonResqueModule)
+    ::Resque::Job.prepend(EpsagonResqueJob)
+  end
+
+  def require_dependencies
+    require_relative 'epsagon_resque_job'
+  end
+end

data/lib/util.rb

@@ -4,6 +4,10 @@ require 'cgi'
 
 # Utilities for epsagon opentelemetry solution
 module Util
+  def self.validate_value(h, k, message, &block)
+    raise ArgumentError.new( "#{k} #{message}. Got #{h[k].class}: #{h[k]}" ) unless yield(h[k])
+  end
+
   def self.epsagon_query_attributes(query_string)
     if query_string&.include? '='
       { 'http.request.query_params' => CGI.parse(query_string).to_json }
@@ -25,7 +29,7 @@ module Util
   		end
   		return value
   	elsif value.instance_of? String then
-  		value[0, max_size]
+  		(value.frozen? ? value.dup : value).force_encoding('utf-8')[0, max_size]
   	else
   		value
   	end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epsagon
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.29
 platform: ruby
 authors:
 - Epsagon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -98,7 +98,7 @@ description: 'Epsagon provides tracing to Ruby applications for the collection o
   distributed tracing and performance metrics to simplify complex architectures, eliminate
   manual work, visualize and correlate data to identify and fix problems fast.
 
-'
+  '
 email: info@epsagon.com
 executables: []
 extensions: []
@@ -112,10 +112,12 @@ files:
 - lib/instrumentation/aws_sdk_plugin.rb
 - lib/instrumentation/epsagon_faraday_middleware.rb
 - lib/instrumentation/epsagon_rails_middleware.rb
+- lib/instrumentation/epsagon_resque_job.rb
 - lib/instrumentation/faraday.rb
 - lib/instrumentation/net_http.rb
 - lib/instrumentation/postgres.rb
 - lib/instrumentation/rails.rb
+- lib/instrumentation/resque.rb
 - lib/instrumentation/sinatra.rb
 - lib/instrumentation/version.rb
 - lib/util.rb
@@ -123,7 +125,7 @@ homepage: https://github.com/epsagon/epsagon-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Epsagon provides tracing to Ruby applications for the collection of distributed
   tracing and performance metrics.