atatus 1.7.0 → 2.0.0

data/lib/atatus/sql/tokenizer.rb

@@ -69,7 +69,7 @@ module Atatus
         when '['   then scan_quoted_indentifier(']')
         when '('   then LPAREN
         when ')'   then RPAREN
-        when '/'   then scan_bracketed_comment
+        when '/'   then scan_bracketed_or_cql_comment
         when '-'   then scan_simple_comment
         when "'"   then scan_string_literal
         when ALPHA then scan_keyword_or_identifier(possible_keyword: true)
@@ -110,7 +110,7 @@ module Atatus
             next next_char
           end
 
-          next next_char if peek =~ ALPHA
+          next next_char if ALPHA.match?(peek)
 
           break
         end
@@ -130,7 +130,7 @@ module Atatus
       end
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity
       def scan_dollar_sign
         while (peek = peek_char)
           case peek
@@ -165,7 +165,7 @@ module Atatus
 
         OTHER
       end
-      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def scan_quoted_indentifier(delimiter)
         while (char = next_char)
@@ -185,10 +185,16 @@ module Atatus
         IDENT
       end
 
+      def scan_bracketed_or_cql_comment
+        case peek_char
+        when '*' then scan_bracketed_comment
+        when '/' then scan_cql_comment
+        else OTHER
+        end
+      end
+
       # rubocop:disable Metrics/CyclomaticComplexity
       def scan_bracketed_comment
-        return OTHER unless peek_char == '*'
-
         nesting = 1
 
         while (char = next_char)
@@ -207,6 +213,16 @@ module Atatus
       end
       # rubocop:enable Metrics/CyclomaticComplexity
 
+      def scan_cql_comment
+        return OTHER unless peek_char == '/'
+
+        while (char = next_char)
+          break if char == "\n"
+        end
+
+        COMMENT
+      end
+
       def scan_simple_comment
         return OTHER unless peek_char == '-'
 
@@ -251,7 +267,7 @@ module Atatus
           when 'e', 'E'
             return NUMBER if exponent
             next_char
-            next_char if peek_char =~ /[+-]/
+            next_char if /[+-]/.match?(peek_char)
           else break
           end
         end

data/lib/atatus/stacktrace/frame.rb

@@ -38,6 +38,7 @@ module Atatus
         :module,
         :colno
       )
+
       def build_context(context_line_count)
         return unless abs_path && context_line_count > 0
 

data/lib/atatus/stacktrace_builder.rb

@@ -23,7 +23,7 @@ require 'atatus/util/lru_cache'
 module Atatus
   # @api private
   class StacktraceBuilder
-    JAVA_FORMAT = /^(.+)\.([^\.]+)\(([^\:]+)\:(\d+)\)$/.freeze
+    JAVA_FORMAT = /^(.+)\.([^.]+)\(([^:]+):(\d+)\)$/.freeze
     RUBY_FORMAT = /^(.+?):(\d+)(?::in `(.+?)')?$/.freeze
 
     RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
@@ -38,7 +38,9 @@ module Atatus
 
     def initialize(config)
       @config = config
-      @cache = Util::LruCache.new(2048, &method(:build_frame))
+      @cache = Util::LruCache.new(2048) do |cache, frame|
+        build_frame(cache, frame)
+      end
     end
 
     attr_reader :config
@@ -59,7 +61,7 @@ module Atatus
 
       frame = Stacktrace::Frame.new
       frame.abs_path = abs_path
-      frame.filename = strip_load_path(config, abs_path)
+      frame.filename = strip_load_path(abs_path)
       frame.function = function
       frame.lineno = lineno.to_i
       frame.library_frame = library_frame?(config, abs_path)
@@ -86,14 +88,13 @@ module Atatus
       [file, number, method, module_name]
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def library_frame?(config, abs_path)
       return false unless abs_path
 
       return true if abs_path.start_with?(GEMS_PATH)
 
       if abs_path.start_with?(config.__root_path)
-        return true if abs_path.start_with?(config.__root_path + '/vendor')
+        return true if abs_path.start_with?("#{config.__root_path}/vendor")
         return false
       end
 
@@ -102,20 +103,15 @@ module Atatus
 
       false
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
-    def strip_load_path(config, path)
+    def strip_load_path(path)
       return nil if path.nil?
 
-      if path.start_with?(config.__root_path)
-        prefix = config.__root_path
-      else
-        prefix =
-          $LOAD_PATH
-          .map(&:to_s)
-          .select { |s| path.start_with?(s) }
-          .max_by(&:length)
-      end
+      prefix =
+        $LOAD_PATH
+        .map(&:to_s)
+        .select { |s| path.start_with?(s) }
+        .max_by(&:length)
 
       prefix ? path[prefix.chomp(File::SEPARATOR).length + 1..-1] : path
     end

data/lib/atatus/subscriber.rb

@@ -45,6 +45,7 @@ module Atatus
     # AS::Notifications API
 
     Notification = Struct.new(:id, :span)
+
     def start(name, id, payload)
       return unless (transaction = @agent.current_transaction)
 

data/lib/atatus/trace_context/traceparent.rb

@@ -22,27 +22,24 @@ module Atatus
     # @api private
     class Traceparent
       VERSION = '00'
-      HEX_REGEX = /[^[:xdigit:]]/.freeze
+      NON_HEX_REGEX = /[^[:xdigit:]]/.freeze
 
       TRACE_ID_LENGTH = 16
       ID_LENGTH = 8
 
-      # rubocop:disable Metrics/ParameterLists
       def initialize(
         version: VERSION,
         trace_id: nil,
-        span_id: nil,
+        parent_id: nil,
         id: nil,
         recorded: true
       )
         @version = version
         @trace_id = trace_id || hex(TRACE_ID_LENGTH)
-        # TODO: rename span_id kw arg to parent_id with next major version bump
-        @parent_id = span_id
+        @parent_id = parent_id
         @id = id || hex(ID_LENGTH)
         @recorded = recorded
       end
-      # rubocop:enable Metrics/ParameterLists
 
       attr_accessor :version, :id, :trace_id, :parent_id, :recorded
 
@@ -58,8 +55,8 @@ module Atatus
               values[-1] = Util.hex_to_bits(values[-1])
             end
 
-          raise_invalid(header) if HEX_REGEX =~ t.trace_id
-          raise_invalid(header) if HEX_REGEX =~ t.parent_id
+          raise_invalid(header) if NON_HEX_REGEX.match?(t.trace_id)
+          raise_invalid(header) if NON_HEX_REGEX.match?(t.parent_id)
         end
       end
 

data/lib/atatus/trace_context/tracestate.rb

@@ -17,6 +17,8 @@
 
 # frozen_string_literal: true
 
+require 'atatus/util/precision_validator'
+
 module Atatus
   class TraceContext
     # @api private
@@ -35,12 +37,13 @@ module Atatus
         end
       end
 
+      # @api private
       class EsEntry
         ASSIGN = ':'
         SPLIT = ';'
 
-        SHORT_TO_LONG = { 's' => 'sample_rate' }
-        LONG_TO_SHORT = { 'sample_rate' => 's' }
+        SHORT_TO_LONG = { 's' => 'sample_rate' }.freeze
+        LONG_TO_SHORT = { 'sample_rate' => 's' }.freeze
 
         def initialize(values = nil)
           parse(values)
@@ -63,13 +66,9 @@ module Atatus
         end
 
         def sample_rate=(val)
-          float = Float(val).round(3)
-
-          return nil unless (0.0..1.0).include?(float)
-
-          @sample_rate = float
-        rescue ArgumentError => e
-          nil
+          @sample_rate = Util::PrecisionValidator.validate(
+            val, precision: 4, minimum: 0.0001
+          )
         end
 
         def to_s
@@ -85,7 +84,7 @@ module Atatus
 
           values.split(SPLIT).map do |kv|
             k, v = kv.split(ASSIGN)
-            next unless SHORT_TO_LONG.keys.include?(k)
+            next unless SHORT_TO_LONG.key?(k)
             send("#{SHORT_TO_LONG[k]}=", v)
           end
         end
@@ -93,6 +92,8 @@ module Atatus
 
       extend Forwardable
 
+      ENTRY_SPLIT_REGEX = /\s*[\n,]+\s*/
+
       def initialize(entries: {}, sample_rate: nil)
         @entries = entries
 
@@ -108,7 +109,7 @@ module Atatus
           split_by_nl_and_comma(header)
           .each_with_object({}) do |entry, hsh|
             k, v = entry.split('=')
-
+            next unless k && v && !k.empty? && !v.empty?
             hsh[k] =
               case k
               when 'es' then EsEntry.new(v)
@@ -138,9 +139,10 @@ module Atatus
         def split_by_nl_and_comma(str)
           # HTTP allows multiple headers with the same name, eg. multiple
           # Set-Cookie headers per response.
-          # Rack handles this by joining the headers under the same key, separated
-          # by newlines, see https://www.rubydoc.info/github/rack/rack/file/SPEC
-          String(str).split("\n").map { |s| s.split(',') }.flatten
+          # Rack handles this by joining the headers under the same key,
+          # separated by newlines.
+          # See https://www.rubydoc.info/github/rack/rack/file/SPEC
+          String(str).split(ENTRY_SPLIT_REGEX).flatten
         end
       end
     end

data/lib/atatus/trace_context.rb

@@ -29,10 +29,9 @@ module Atatus
 
     def initialize(
       traceparent: nil,
-      tracestate: nil,
-      **legacy_traceparent_attrs
+      tracestate: nil
     )
-      @traceparent = traceparent || Traceparent.new(**legacy_traceparent_attrs)
+      @traceparent = traceparent || Traceparent.new
       @tracestate = tracestate || Tracestate.new
     end
 
@@ -42,22 +41,18 @@ module Atatus
       :version, :trace_id, :id, :parent_id, :ensure_parent_id, :recorded?
 
     class << self
-      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      def parse(legacy_header = nil, env: nil, metadata: nil)
-        unless legacy_header || env || metadata
+      def parse(env: nil, metadata: nil)
+        unless env || metadata
           raise ArgumentError, 'TraceContext expects env:, metadata: ' \
             'or single argument header string'
         end
 
-        if legacy_header
-          legacy_parse_from_header(legacy_header)
-        elsif env
+        if env
           trace_context_from_env(env)
         elsif metadata
           trace_context_from_metadata(metadata)
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       private
 
@@ -90,11 +85,6 @@ module Atatus
 
         new(traceparent: parent, tracestate: state)
       end
-
-      def legacy_parse_from_header(header)
-        parent = Traceparent.parse(header)
-        new(traceparent: parent)
-      end
     end
 
     def child
@@ -106,7 +96,7 @@ module Atatus
     def apply_headers
       yield 'Traceparent', traceparent.to_header
 
-      if tracestate
+      if tracestate && !tracestate.to_header.empty?
         yield 'Tracestate', tracestate.to_header
       end
 

data/lib/atatus/transaction.rb

@@ -20,6 +20,17 @@
 module Atatus
   # @api private
   class Transaction
+    # @api private
+    class Outcome
+      FAILURE = "failure"
+      SUCCESS = "success"
+      UNKNOWN = "unknown"
+
+      def self.from_http_status(code)
+        code.to_i >= 500 ? FAILURE : SUCCESS
+      end
+    end
+
     extend Forwardable
     include ChildDurations::Methods
 
@@ -33,10 +44,10 @@ module Atatus
     def initialize(
       name = nil,
       type = nil,
+      config:,
       sampled: true,
       sample_rate: 1,
       context: nil,
-      config:,
       trace_context: nil
     )
       @name = name
@@ -63,7 +74,9 @@ module Atatus
       unless (@trace_context = trace_context)
         @trace_context = TraceContext.new(
           traceparent: TraceContext::Traceparent.new(recorded: sampled),
-          tracestate: TraceContext::Tracestate.new(sample_rate: sampled ? sample_rate : 0)
+          tracestate: TraceContext::Tracestate.new(
+            sample_rate: sampled ? sample_rate : 0
+          )
         )
       end
 
@@ -74,7 +87,7 @@ module Atatus
     end
     # rubocop:enable Metrics/ParameterLists
 
-    attr_accessor :name, :type, :result, :spans, :ruby_time
+    attr_accessor :name, :type, :result, :outcome, :spans, :ruby_time
 
     attr_reader(
       :breakdown_metrics,
@@ -90,7 +103,7 @@ module Atatus
       :started_spans,
       :timestamp,
       :trace_context,
-      :transaction_max_spans 
+      :transaction_max_spans
     )
 
     alias :collect_metrics? :collect_metrics

data/lib/atatus/transport/base.rb

@@ -35,7 +35,6 @@ module Atatus
       include Logging
 
       WATCHER_EXECUTION_INTERVAL = 5
-      WATCHER_TIMEOUT_INTERVAL = 4
       WORKER_JOIN_TIMEOUT = 5
 
       def initialize(config)
@@ -112,8 +111,7 @@ module Atatus
 
       def create_watcher
         @watcher = Concurrent::TimerTask.execute(
-          execution_interval: WATCHER_EXECUTION_INTERVAL,
-          timeout_interval: WATCHER_TIMEOUT_INTERVAL
+          execution_interval: WATCHER_EXECUTION_INTERVAL
         ) { ensure_worker_count }
       end
 

data/lib/atatus/transport/connection/http.rb

@@ -74,8 +74,16 @@ module Atatus
           debug '%s: Closing request with reason %s', thread_str, reason
           @closed.make_true
 
-          @wr&.close(reason)
-          return if @request.nil? || @request&.join(5)
+          @wr&.close
+
+          if @request&.join(5)
+            @rd&.close
+            return
+          end
+
+          @rd&.close
+
+          return if @request.nil?
 
           error(
             '%s: APM Server not responding in time, terminating request',
@@ -85,7 +93,7 @@ module Atatus
         end
 
         def closed?
-          @closed.true?
+          @rd.closed? && @closed.true?
         end
 
         def inspect

data/lib/atatus/transport/connection/proxy_pipe.rb

@@ -62,8 +62,7 @@ module Atatus
             @io = Zlib::GzipWriter.new(io)
           end
 
-          def close(reason = nil)
-            debug("Closing writer with reason #{reason}")
+          def close
             io.close
           end
 

data/lib/atatus/transport/connection.rb

@@ -42,11 +42,12 @@ module Atatus
             Metadata.new(config)
           )
         )
-        @url = config.server_url + '/intake/v2/events'
+        @url = "#{config.server_url}/intake/v2/events"
         @mutex = Mutex.new
       end
 
       attr_reader :http
+
       def write(str)
         return false if @config.disable_send
 
@@ -104,7 +105,7 @@ module Atatus
         @close_task&.cancel
         @close_task =
           Concurrent::ScheduledTask.execute(@config.api_request_time) do
-            flush(:timeout)
+            flush(:scheduled_flush)
           end
       end
     end

data/lib/atatus/transport/filters/hash_sanitizer.rb

@@ -17,59 +17,41 @@
 
 # frozen_string_literal: true
 
+require 'atatus/util/deep_dup'
+
 module Atatus
   module Transport
     module Filters
+      # @api private
       class HashSanitizer
         FILTERED = '[FILTERED]'
 
-        KEY_FILTERS = [
-          /passw(or)?d/i,
-          /auth/i,
-          /^pw$/,
-          /secret/i,
-          /token/i,
-          /api[-._]?key/i,
-          /session[-._]?id/i,
-          /(set[-_])?cookie/i
-        ].freeze
-
-        VALUE_FILTERS = [
-          # (probably) credit card number
-          /^\d{4}[- ]?\d{4}[- ]?\d{4}[- ]?\d{4}$/
-        ].freeze
+        def initialize(key_patterns:)
+          @key_patterns = key_patterns
+        end
 
-        attr_accessor :key_filters
+        attr_accessor :key_patterns
 
-        def initialize
-          @key_filters = KEY_FILTERS
+        def strip_from(obj)
+          strip_from!(Util::DeepDup.dup(obj))
         end
 
-        def strip_from!(obj, key_filters = KEY_FILTERS)
-          return unless obj&.is_a?(Hash)
-
-          obj.each do |k, v|
-            if filter_key?(k)
-              next obj[k] = FILTERED
-            end
+        def strip_from!(obj)
+          return unless obj.is_a?(Hash)
 
+          obj.each_pair do |k, v|
             case v
             when Hash
               strip_from!(v)
-            when String
-              if filter_value?(v)
-                obj[k] = FILTERED
-              end
+            else
+              next unless filter_key?(k)
+              obj[k] = FILTERED
             end
           end
         end
 
         def filter_key?(key)
-          @key_filters.any? { |regex| regex.match(key) }
-        end
-
-        def filter_value?(value)
-          VALUE_FILTERS.any? { |regex| regex.match(value) }
+          @key_patterns.any? { |regex| regex.match(key) }
         end
       end
     end

data/lib/atatus/transport/filters/secrets_filter.rb

@@ -26,21 +26,44 @@ module Atatus
       class SecretsFilter
         def initialize(config)
           @config = config
-          @sanitizer = HashSanitizer.new
-          @sanitizer.key_filters += config.custom_key_filters +
-                                     config.sanitize_field_names
+          @sanitizer =
+            HashSanitizer.new(
+              key_patterns: config.custom_key_filters +
+                            config.sanitize_field_names
+            )
         end
 
         def call(payload)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :headers)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :env)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :cookies)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :response, :headers)
-          @sanitizer.strip_from! payload.dig(:error, :context, :request, :headers)
-          @sanitizer.strip_from! payload.dig(:error, :context, :request, :cookies)
-          @sanitizer.strip_from! payload.dig(:error, :context, :response, :headers)
-          @sanitizer.strip_from! payload.dig(:transaction, :context, :request, :body)
-
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :request, :body)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :request, :cookies)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :request, :env)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :request, :headers)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:transaction, :context, :response, :headers)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :request, :body)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :request, :cookies)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :request, :env)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :request, :headers)
+          )
+          @sanitizer.strip_from!(
+            payload.dig(:error, :context, :response, :headers)
+          )
           payload
         end
       end

data/lib/atatus/transport/serializers/context_serializer.rb

@@ -77,8 +77,7 @@ module Atatus
           return unless socket
 
           {
-            remote_addr: socket.remote_addr,
-            encrypted: socket.encrypted
+            remote_addr: socket.remote_addr
           }
         end