epsagon 0.0.29 → 0.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25cf09d9ea5babb3e7caa3380d6b8a78365909391ec3eb84ec150e07fbd9841a
-  data.tar.gz: bb3f2efc49e2b0930ffb677bfb5b8440fa16fe2a41a7adb96b33a35e89efdb67
+  metadata.gz: f8ebb5eb2134eb62b3b83fa8cbb48b9c535cf528999c55ad1b58ed161b63cd97
+  data.tar.gz: 1e5ac5ea5ef2d6a3ba156b89061cca64bab22b90ce27b37e128a9b62c2633526
 SHA512:
-  metadata.gz: b179e2cf5b65329b6a7a40dec43a379fb294ddee0e58f389cd4ffc105f503265ad655cbf50067a9995b04358ddb9d9d0f8441d47e2639befcc4744c8af3c290c
-  data.tar.gz: 5b8443325b4afadffed3f836ba9a7385cbdfbc2cd03eebfee007bb0543ddb5f2b3c279d22a614fa80ecabb7f4a18f6a1292298567d444a84c9a364ef361bb626
+  metadata.gz: 34adf61a4771b2e61f916a79f3e038a1b23235214d13ec9771c33e3a1be34edc843c735f2ca2fd6d1a84fc895e9ffd7f6ec4b7674b1ace141b39f193e0d7b7b0
+  data.tar.gz: 289999c6c4d93c3521598fc0ac30eefd29f83e46f74079d1133b50d4a459c6f8e397f6fa1cf151492308d6089b9bfda9f9ed4279aab29c0e1de787aba26e4361

data/lib/epsagon.rb

@@ -26,8 +26,7 @@ Bundler.require
 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]) 
-
+  MUTABLE_CONF_KEYS = Set.new([:metadata_only, :max_attribute_size, :ignore_domains, :ignored_keys]) 
 
   @@epsagon_config = nil
 
@@ -43,16 +42,16 @@ module Epsagon
   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, :token, 'Must be a valid Epsagon token') {|v| (v.is_a? String) && (v.size > 10) }
+    Util.validate_value(config, :app_name, 'Must be a String') {|v| (v.is_a? String) && (v.size > 0) }
     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)}
+    Util.validate_value(config, :ignored_keys, '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`")
+      raise ArgumentError.new("only #{MUTABLE_CONF_KEYS.to_a} are mutable after `Epsagon.init`")
     end
     Epsagon.init unless @@initialized
     new_conf = get_config.merge(args)
@@ -60,6 +59,14 @@ module Epsagon
     @@epsagon_config = new_conf
   end
 
+  def add_ignored_key(key)
+    get_config[:ignored_keys].push(key).uniq
+  end
+
+  def remove_ignored_key(key)
+    get_config[:ignored_keys].delete(key)
+  end
+
   def get_config
     @@epsagon_config ||= {
       metadata_only: ENV['EPSAGON_METADATA']&.to_s&.downcase != 'false',
@@ -68,7 +75,8 @@ module Epsagon
       app_name: ENV['EPSAGON_APP_NAME'] || '',
       max_attribute_size: ENV['EPSAGON_MAX_ATTRIBUTE_SIZE'] || 5000,
       backend: ENV['EPSAGON_BACKEND'] || DEFAULT_BACKEND,
-      ignore_domains: ENV['EPSAGON_IGNORE_DOMAINS'] || DEFAULT_IGNORE_DOMAINS
+      ignore_domains: ENV['EPSAGON_IGNORE_DOMAINS']&.split(',') || DEFAULT_IGNORE_DOMAINS,
+      ignored_keys: ENV['EPSAGON_IGNORED_KEYS']&.split(',') || []
     }
   end
 
@@ -135,10 +143,15 @@ module SpanExtension
 
   BLANKS = [nil, [], '']
 
+  def set_mapping_attribute(key, value)
+    value = Util.prepare_attr(key, value, Epsagon.get_config[:max_attribute_size], Epsagon.get_config[:ignored_keys])
+    set_attribute(key, value) if value
+  end
+
   def set_attribute(key, value)
     unless BLANKS.include?(value)
-      value = Util.trim_attr(value, Epsagon.get_config[:max_attribute_size])
-      super(key, value)
+      value = Util.prepare_attr(key, value, Epsagon.get_config[:max_attribute_size], Epsagon.get_config[:ignored_keys])
+      super(key, value) if value
     end
   end
 
@@ -146,8 +159,9 @@ module SpanExtension
     super(*args)
     if @attributes
       @attributes = Hash[@attributes.select {|k,v| not BLANKS.include? v}.map { |k,v|
-        [k, Util.trim_attr(v, Epsagon.get_config[:max_attribute_size])]
-      }]
+        v = Util.prepare_attr(k, v, Epsagon.get_config[:max_attribute_size], Epsagon.get_config[:ignored_keys])
+        [k, v] if v
+      }.compact]
     end
   end
 end

data/lib/epsagon_constants.rb

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

data/lib/instrumentation/aws_sdk_plugin.rb

@@ -59,10 +59,10 @@ class EpsagonAwsHandler < Seahorse::Client::Handler
               'message_body' => m[:message_body],
             } 
           end
-          attributes['aws.sqs.record'] = JSON.dump(messages_attributes) if messages_attributes
+          attributes['aws.sqs.record'] = messages_attributes if messages_attributes
         end
         attributes['aws.sqs.record.message_body'] = context.params[:message_body]
-        attributes['aws.sqs.record.message_attributes'] = JSON.dump(context.params[:message_attributes]) if context.params[:message_attributes]
+        attributes['aws.sqs.record.message_attributes'] = context.params[:message_attributes] if context.params[:message_attributes]
       end
     elsif attributes['aws.service'] == 'sns'
       topic_arn = context.params[:topic_arn]
@@ -71,7 +71,7 @@ class EpsagonAwsHandler < Seahorse::Client::Handler
       unless config[:epsagon][:metadata_only]
         attributes['aws.sns.subject'] = context.params[:subject]
         attributes['aws.sns.message'] = context.params[:message]
-        attributes['aws.sns.message_attributes'] = JSON.dump(context.params[:message_attributes]) if context.params[:message_attributes]
+        attributes['aws.sns.message_attributes'] = context.params[:message_attributes] if context.params[:message_attributes]
       end
     end
     tracer.in_span(span_name, kind: span_kind, attributes: attributes) do |span|
@@ -105,7 +105,7 @@ class EpsagonAwsHandler < Seahorse::Client::Handler
                 end
                 record
               end
-              span.set_attribute('aws.sqs.record', JSON.dump(messages_attributes)) if messages_attributes
+              span.set_mapping_attribute('aws.sqs.record', messages_attributes) if messages_attributes
             end
             if context.operation.name == 'ReceiveMessage'
               messages_attributes = result.messages.map do |m|
@@ -123,7 +123,7 @@ class EpsagonAwsHandler < Seahorse::Client::Handler
                 end 
                 record
               end
-              span.set_attribute('aws.sqs.record', JSON.dump(messages_attributes)) if messages_attributes
+              span.set_mapping_attribute('aws.sqs.record', messages_attributes) if messages_attributes
             end
           elsif attributes['aws.service'] == 'sns'
             span.set_attribute('aws.sns.message_id', result.message_id) if context.operation.name == 'Publish'

data/lib/instrumentation/epsagon_faraday_middleware.rb

@@ -38,7 +38,7 @@ class EpsagonFaradayMiddleware < ::Faraday::Middleware
       attributes.merge!(Util.epsagon_query_attributes(env.url.query))
       attributes.merge!({
         'http.request.path_params' => path_params,
-        'http.request.headers' => env.request_headers.to_json,
+        'http.request.headers' => Hash[env.request_headers],
         'http.request.body' => env.body,
         'http.request.headers.User-Agent' => env.request_headers['User-Agent']
       })
@@ -67,7 +67,7 @@ class EpsagonFaradayMiddleware < ::Faraday::Middleware
     span.set_attribute('http.status_code', response.status)
 
     unless config[:epsagon][:metadata_only]
-      span.set_attribute('http.response.headers', response.headers.to_json)
+      span.set_attribute('http.response.headers', Hash[env.response.headers])
       span.set_attribute('http.response.body', response.body)
     end
     span.status = OpenTelemetry::Trace::Status.http_to_status(

data/lib/instrumentation/epsagon_resque_job.rb

@@ -28,7 +28,7 @@ module EpsagonResqueModule
       }
       unless epsagon_conf[:metadata_only]
         attributes.merge!({
-          'messaging.resque.args' => JSON.dump(item)
+          'messaging.resque.args' => item
         })
       end
 
@@ -80,7 +80,7 @@ module EpsagonResqueJob
 
     unless epsagon_conf[:metadata_only]
       attributes.merge!({
-        'messaging.resque.args' => JSON.dump(args)
+        'messaging.resque.args' => args
       })
     end
     tracer.in_span(

data/lib/instrumentation/net_http.rb

@@ -34,7 +34,7 @@ module EpsagonNetHTTPExtension
       attributes.merge!({
                           'http.request.path_params' => path_params,
                           'http.request.body' => body,
-                          'http.request.headers' => headers.to_json,
+                          'http.request.headers' => Hash[headers],
                           'http.request.headers.User-Agent' => headers['user-agent']
                         })
       attributes.merge!(Util.epsagon_query_attributes(query))
@@ -62,7 +62,7 @@ module EpsagonNetHTTPExtension
 
     span.set_attribute('http.status_code', status_code)
     unless config[:epsagon][:metadata_only]
-      span.set_attribute('http.response.headers', Hash[response.each_header.to_a].to_json)
+      span.set_attribute('http.response.headers', Hash[response.each_header.to_a])
       span.set_attribute('http.response.body', response.body)
     end
     span.status = OpenTelemetry::Trace::Status.http_to_status(

data/lib/util.rb

@@ -16,6 +16,30 @@ module Util
     end
   end
 
+
+  def self.remove_key_recursive(h, key) 
+    dot_idx = key.index('.')
+    if not dot_idx.nil?
+      next_hash = h[key[0..dot_idx - 1]]
+      self.remove_key_recursive(next_hash, key[dot_idx + 1..-1]) if next_hash
+    else
+      h.delete(key)
+    end
+  end
+
+  def self.prepare_attr(key, value, max_size, excluded_keys)
+    return nil if excluded_keys.include? key
+    return self.trim_attr(value, max_size) unless value.instance_of? Hash
+    value = value.dup
+    excluded_keys.each do |ekey|
+      if ekey.start_with? (key + '.')
+        rest_of_key = ekey[key.size + 1..-1]
+        self.remove_key_recursive(value, rest_of_key)
+      end
+    end
+    return self.trim_attr(JSON.dump(value), max_size)
+  end
+
   def self.trim_attr(value, max_size)
   	if value.instance_of? Array then 
   		current_size = 2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epsagon
 version: !ruby/object:Gem::Version
-  version: 0.0.29
+  version: 0.0.30
 platform: ruby
 authors:
 - Epsagon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api