atatus 1.3.0 → 1.6.1

data/lib/atatus/sql/tokenizer.rb

@@ -0,0 +1,264 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require 'strscan'
+require 'atatus/sql/tokens'
+
+module Atatus
+  module Sql
+    # @api private
+    class Tokenizer
+      include Tokens
+
+      ALPHA = /[[:alpha:]]/.freeze
+      DIGIT = /[[:digit:]]/.freeze
+      SPACE = /[[:space:]]+/.freeze
+
+      def initialize(input)
+        @input = input
+
+        @scanner = StringScanner.new(input)
+        @byte_start = 0
+      end
+
+      attr_reader :input, :scanner, :token
+
+      def text
+        @input.byteslice(@byte_start, @byte_end - @byte_start)
+      end
+
+      def scan
+        scanner.skip(SPACE)
+
+        @byte_start = scanner.pos
+        char = next_char
+
+        return false unless char
+
+        @token = next_token(char)
+
+        true
+      end
+
+      private
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def next_token(char)
+        case char
+        when '_'   then scan_keyword_or_identifier(possible_keyword: false)
+        when '.'   then PERIOD
+        when '$'   then scan_dollar_sign
+        when '`'   then scan_quoted_indentifier('`')
+        when '"'   then scan_quoted_indentifier('"')
+        when '['   then scan_quoted_indentifier(']')
+        when '('   then LPAREN
+        when ')'   then RPAREN
+        when '/'   then scan_bracketed_comment
+        when '-'   then scan_simple_comment
+        when "'"   then scan_string_literal
+        when ALPHA then scan_keyword_or_identifier(possible_keyword: true)
+        when DIGIT then scan_numeric_literal
+        else            OTHER
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def next_char
+        char = @scanner.getch
+        @byte_end = @scanner.pos
+        char
+      end
+
+      # StringScanner#peek returns next byte which could be an incomplete utf
+      # multi-byte character
+      def peek_char(length = 1)
+        # The maximum byte count of utf chars is 4:
+        # > In UTF-8, characters from the U+0000..U+10FFFF range (the UTF-16
+        #   accessible range) are encoded using sequences of 1 to 4 octets.
+        # # https://tools.ietf.org/html/rfc3629
+        return nil if length > 4
+
+        char = @scanner.peek(length)
+
+        return nil if char.empty?
+        return char if char.valid_encoding?
+
+        peek_char(length + 1)
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def scan_keyword_or_identifier(possible_keyword:)
+        while (peek = peek_char)
+          if peek == '_' || peek == '$' || peek =~ DIGIT
+            possible_keyword = false
+            next next_char
+          end
+
+          next next_char if peek =~ ALPHA
+
+          break
+        end
+
+        return IDENT unless possible_keyword
+
+        snap = text
+
+        if snap.length < KEYWORD_MIN_LENGTH || snap.length > KEYWORD_MAX_LENGTH
+          return IDENT
+        end
+
+        keyword = KEYWORDS[snap.length].find { |kw| snap.upcase == kw.to_s }
+        return keyword if keyword
+
+        IDENT
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      def scan_dollar_sign
+        while (peek = peek_char)
+          case peek
+          when DIGIT
+            next_char while peek_char =~ DIGIT
+          when '$', '_', ALPHA, SPACE
+            # PostgreSQL supports dollar-quoted string literal syntax,
+            # like $foo$...$foo$. The tag (foo in this case) is optional,
+            # and if present follows identifier rules.
+            while (char = next_char)
+              case char
+              when '$'
+                # This marks the end of the initial $foo$.
+                snap = text
+                slice = input.slice(scanner.pos, input.length)
+                index = slice.index(snap)
+                next unless index && index >= 0
+
+                delta = index + snap.bytesize
+                @byte_end += delta
+                scanner.pos += delta
+                return STRING
+              when SPACE
+                # Unknown token starting with $, consume chars until space.
+                @byte_end -= char.bytesize
+                return OTHER
+              end
+            end
+          else break
+          end
+        end
+
+        OTHER
+      end
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+
+      def scan_quoted_indentifier(delimiter)
+        while (char = next_char)
+          next unless char == delimiter
+
+          if delimiter == '"' && peek_char == delimiter
+            next next_char
+          end
+
+          break
+        end
+
+        # Remove quotes from identifier
+        @byte_start += char.bytesize
+        @byte_end -= char.bytesize
+
+        IDENT
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def scan_bracketed_comment
+        return OTHER unless peek_char == '*'
+
+        nesting = 1
+
+        while (char = next_char)
+          case char
+          when '/'
+            next unless peek_char == '*'
+            next_char
+            nesting += 1
+          when '*'
+            next unless peek_char == '/'
+            next_char
+            nesting -= 1
+            return COMMENT if nesting == 0
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def scan_simple_comment
+        return OTHER unless peek_char == '-'
+
+        while (char = next_char)
+          break if char == "\n"
+        end
+
+        COMMENT
+      end
+
+      def scan_string_literal
+        delimiter = "'"
+
+        while (char = next_char)
+          if char == '\\'
+            # Skip escaped character, e.g. 'what\'s up?'
+            next_char
+            next
+          end
+
+          next unless char == delimiter
+
+          return STRING unless peek_char
+          return STRING if peek_char != delimiter
+
+          next_char
+        end
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def scan_numeric_literal
+        period = false
+        exponent = false
+
+        while (peek = peek_char)
+          case peek
+          when DIGIT then next_char
+          when '.'
+            return NUMBER if period
+            next_char
+            period = true
+          when 'e', 'E'
+            return NUMBER if exponent
+            next_char
+            next_char if peek_char =~ /[+-]/
+          else break
+          end
+        end
+
+        NUMBER
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+    end
+  end
+end

data/lib/atatus/sql/tokens.rb

@@ -0,0 +1,63 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  module Sql
+    # @api private
+    module Tokens
+      OTHER = :OTHER
+      COMMENT = :COMMENT
+      IDENT = :IDENT
+      NUMBER = :NUMBER
+      STRING = :STRING
+
+      PERIOD = :PERIOD
+      COMMA = :COMMA
+      LPAREN = :LPAREN
+      RPAREN = :RPAREN
+
+      AS = :AS
+      CALL = :CALL
+      DELETE = :DELETE
+      FROM = :FROM
+      INSERT = :INSERT
+      INTO = :INTO
+      OR = :OR
+      REPLACE = :REPLACE
+      SELECT = :SELECT
+      SET = :SET
+      TABLE = :TABLE
+      TRUNCATE = :TRUNCATE
+      UPDATE = :UPDATE
+
+      KEYWORDS = {
+        2 => [AS, OR],
+        3 => [SET],
+        4 => [CALL, FROM, INTO],
+        5 => [TABLE],
+        6 => [DELETE, INSERT, SELECT, UPDATE],
+        7 => [REPLACE],
+        8 => [TRUNCATE]
+      }.freeze
+
+      KEYWORD_MIN_LENGTH = KEYWORDS.keys.first
+      KEYWORD_MAX_LENGTH = KEYWORDS.keys.last
+    end
+  end
+end

data/lib/atatus/sql.rb

@@ -0,0 +1,36 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  # @api private
+  module Sql
+    # This method is only here as a shortcut while the agent ships with
+    # both implementations ~mikker
+    def self.summarizer
+      @summarizer ||=
+        if Atatus.agent&.config&.use_legacy_sql_parser
+          require 'atatus/sql_summarizer'
+          SqlSummarizer.new
+        else
+          require 'atatus/sql/signature'
+          Sql::Signature::Summarizer.new
+        end
+    end
+  end
+end

data/lib/atatus/sql_summarizer.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'atatus/util/lru_cache'
@@ -9,12 +26,12 @@ module Atatus
     TABLE_REGEX = %{["'`]?([A-Za-z0-9_]+)["'`]?}
 
     REGEXES = {
-      /^BEGIN/i => 'BEGIN',
-      /^COMMIT/i => 'COMMIT',
-      /^SELECT .* FROM #{TABLE_REGEX}/i => 'SELECT FROM ',
-      /^INSERT INTO #{TABLE_REGEX}/i => 'INSERT INTO ',
-      /^UPDATE #{TABLE_REGEX}/i => 'UPDATE ',
-      /^DELETE FROM #{TABLE_REGEX}/i => 'DELETE FROM '
+      /^BEGIN/iu => 'BEGIN',
+      /^COMMIT/iu => 'COMMIT',
+      /^SELECT .* FROM #{TABLE_REGEX}/iu => 'SELECT FROM ',
+      /^INSERT INTO #{TABLE_REGEX}/iu => 'INSERT INTO ',
+      /^UPDATE #{TABLE_REGEX}/iu => 'UPDATE ',
+      /^DELETE FROM #{TABLE_REGEX}/iu => 'DELETE FROM '
     }.freeze
 
     FORMAT = '%s%s'
@@ -24,6 +41,7 @@ module Atatus
     end
 
     def summarize(sql)
+      sql = sql.encode('utf-8', invalid: :replace, undef: :replace)
       self.class.cache[sql] ||=
         REGEXES.find do |regex, sig|
           if (match = sql[0...1000].match(regex))

data/lib/atatus/stacktrace/frame.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'atatus/naively_hashable'
@@ -21,8 +38,6 @@ module Atatus
         :module,
         :colno
       )
-
-      # rubocop:disable Metrics/AbcSize
       def build_context(context_line_count)
         return unless abs_path && context_line_count > 0
 
@@ -38,7 +53,6 @@ module Atatus
         self.pre_context  = file_lines.first(padding)
         self.post_context = file_lines.last(padding)
       end
-      # rubocop:enable Metrics/AbcSize
 
       private
 

data/lib/atatus/stacktrace.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 module Atatus

data/lib/atatus/stacktrace_builder.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'atatus/stacktrace/frame'
@@ -12,7 +29,12 @@ module Atatus
     RUBY_VERS_REGEX = %r{ruby(/gems)?[-/](\d+\.)+\d}.freeze
     JRUBY_ORG_REGEX = %r{org/jruby}.freeze
 
-    GEMS_PATH = defined?(Bundler) ? Bundler.bundle_path.to_s : Gem.dir
+    GEMS_PATH =
+      if defined?(Bundler) && Bundler.default_bundle_dir
+        Bundler.bundle_path.to_s
+      else
+        Gem.dir
+      end
 
     def initialize(config)
       @config = config
@@ -31,7 +53,6 @@ module Atatus
 
     private
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def build_frame(cache, keys)
       line, type = keys
       abs_path, lineno, function, _module_name = parse_line(line)
@@ -49,7 +70,6 @@ module Atatus
 
       cache[[line, type]] = frame
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def parse_line(line)
       ruby_match = line.match(RUBY_FORMAT)

data/lib/atatus/subscriber.rb

@@ -1,3 +1,20 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
 # frozen_string_literal: true
 
 require 'active_support/notifications'
@@ -28,8 +45,6 @@ module Atatus
     # AS::Notifications API
 
     Notification = Struct.new(:id, :span)
-
-    # rubocop:disable Metrics/MethodLength
     def start(name, id, payload)
       return unless (transaction = @agent.current_transaction)
 
@@ -52,9 +67,9 @@ module Atatus
 
       transaction.notifications << Notification.new(id, span)
     end
-    # rubocop:enable Metrics/MethodLength
 
-    def finish(_name, id, _payload)
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def finish(name, id, payload)
       # debug "AS::Notification#finish:#{name}:#{id}"
       return unless (transaction = @agent.current_transaction)
 
@@ -62,11 +77,15 @@ module Atatus
         next unless notification.id == id
 
         if (span = notification.span)
+          if @agent.config.span_frames_min_duration?
+            span.original_backtrace ||= @normalizers.backtrace(name, payload)
+          end
           @agent.end_span if span == @agent.current_span
         end
         return
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     private
 

data/lib/atatus/trace_context/traceparent.rb

@@ -0,0 +1,111 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+module Atatus
+  class TraceContext
+    # @api private
+    class Traceparent
+      VERSION = '00'
+      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,
+        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
+        @id = id || hex(ID_LENGTH)
+        @recorded = recorded
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      attr_accessor :version, :id, :trace_id, :parent_id, :recorded
+
+      alias :recorded? :recorded
+
+      def self.parse(header)
+        raise_invalid(header) unless header.length == 55
+        raise_invalid(header) unless header[0..1] == VERSION
+
+        new.tap do |t|
+          t.version, t.trace_id, t.parent_id, t.flags =
+            header.split('-').tap do |values|
+              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
+        end
+      end
+
+      class << self
+        private
+
+        def raise_invalid(header)
+          raise InvalidTraceparentHeader,
+            "Couldn't parse invalid traceparent header: #{header.inspect}"
+        end
+      end
+
+      def flags=(flags)
+        @flags = flags
+
+        self.recorded = flags[7] == '1'
+      end
+
+      def flags
+        format('0000000%d', recorded? ? 1 : 0)
+      end
+
+      def hex_flags
+        format('%02x', flags.to_i(2))
+      end
+
+      def ensure_parent_id
+        @parent_id ||= hex(ID_LENGTH)
+      end
+
+      def child
+        dup.tap do |copy|
+          copy.parent_id = id
+          copy.id = hex(ID_LENGTH)
+        end
+      end
+
+      def to_header
+        format('%s-%s-%s-%s', version, trace_id, id, hex_flags)
+      end
+
+      private
+
+      def hex(len)
+        SecureRandom.hex(len)
+      end
+    end
+  end
+end