elastic-apm 3.3.0 → 3.8.0

data/lib/elastic_apm/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 ElasticAPM
+  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/elastic_apm/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 'elastic_apm/util/lru_cache'
@@ -18,14 +35,13 @@ module ElasticAPM
     }.freeze
 
     FORMAT = '%s%s'
-    UTF8 = 'UTF-8'
 
     def self.cache
       @cache ||= Util::LruCache.new
     end
 
     def summarize(sql)
-      sql = sql.encode(UTF8, invalid: :replace, undef: :replace)
+      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/elastic_apm/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 ElasticAPM

data/lib/elastic_apm/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 'elastic_apm/naively_hashable'

data/lib/elastic_apm/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 'elastic_apm/stacktrace/frame'
@@ -12,7 +29,12 @@ module ElasticAPM
     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

data/lib/elastic_apm/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'

data/lib/elastic_apm/trace_context.rb

@@ -1,82 +1,118 @@
+# 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 'elastic_apm/trace_context/tracestate'
+require 'elastic_apm/trace_context/traceparent'
+
 module ElasticAPM
   # @api private
   class TraceContext
-    class InvalidTraceparentHeader < StandardError; end
+    extend Forwardable
 
-    VERSION = '00'
-    HEX_REGEX = /[^[:xdigit:]]/.freeze
-
-    TRACE_ID_LENGTH = 16
-    ID_LENGTH = 8
+    class InvalidTraceparentHeader < StandardError; end
 
     def initialize(
-      version: VERSION,
-      trace_id: nil,
-      span_id: nil,
-      id: nil,
-      recorded: true
+      traceparent: nil,
+      tracestate: nil,
+      **legacy_traceparent_attrs
     )
-      @version = version
-      @trace_id = trace_id || hex(TRACE_ID_LENGTH)
-      # TODO: rename to parent_id with next major version bump
-      @parent_id = span_id
-      @id = id || hex(ID_LENGTH)
-      @recorded = recorded
+      @traceparent = traceparent || Traceparent.new(**legacy_traceparent_attrs)
+      @tracestate = tracestate
     end
 
-    attr_accessor :version, :id, :trace_id, :parent_id, :recorded
+    attr_accessor :traceparent, :tracestate
+
+    def_delegators :traceparent,
+      :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
+          raise ArgumentError, 'TraceContext expects env:, metadata: ' \
+            'or single argument header string'
+        end
+
+        if legacy_header
+          legacy_parse_from_header(legacy_header)
+        elsif env
+          trace_context_from_env(env)
+        elsif metadata
+          trace_context_from_metadata(metadata)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      private
 
-    alias :recorded? :recorded
-    def self.parse(header)
-      raise InvalidTraceparentHeader unless header.length == 55
-      raise InvalidTraceparentHeader unless header[0..1] == VERSION
+      def trace_context_from_env(env)
+        return unless (
+          header =
+            env['HTTP_ELASTIC_APM_TRACEPARENT'] || env['HTTP_TRACEPARENT']
+        )
 
-      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])
+        parent = TraceContext::Traceparent.parse(header)
+
+        state =
+          if (header = env['HTTP_TRACESTATE'])
+            TraceContext::Tracestate.parse(header)
           end
 
-        raise InvalidTraceparentHeader if HEX_REGEX =~ t.trace_id
-        raise InvalidTraceparentHeader if HEX_REGEX =~ t.parent_id
+        new(traceparent: parent, tracestate: state)
       end
-    end
 
-    def flags=(flags)
-      @flags = flags
+      def trace_context_from_metadata(metadata)
+        return unless (header = metadata['elastic-apm-traceparent'] ||
+          metadata['traceparent'])
 
-      self.recorded = flags[7] == '1'
-    end
+        parent = TraceContext::Traceparent.parse(header)
 
-    def flags
-      format('0000000%d', recorded? ? 1 : 0)
-    end
+        state =
+          if (header = metadata['tracestate'])
+            TraceContext::Tracestate.parse(header)
+          end
 
-    def hex_flags
-      format('%02x', flags.to_i(2))
-    end
+        new(traceparent: parent, tracestate: state)
+      end
 
-    def ensure_parent_id
-      @parent_id ||= hex(ID_LENGTH)
+      def legacy_parse_from_header(header)
+        parent = Traceparent.parse(header)
+        new(traceparent: parent)
+      end
     end
 
     def child
       dup.tap do |tc|
-        tc.parent_id = tc.id
-        tc.id = hex(ID_LENGTH)
+        tc.traceparent = tc.traceparent.child
       end
     end
 
-    def to_header
-      format('%s-%s-%s-%s', version, trace_id, id, hex_flags)
-    end
+    def apply_headers
+      yield 'Traceparent', traceparent.to_header
+
+      if tracestate
+        yield 'Tracestate', tracestate.to_header
+      end
 
-    private
+      return unless ElasticAPM.agent.config.use_elastic_traceparent_header
 
-    def hex(len)
-      SecureRandom.hex(len)
+      yield 'Elastic-Apm-Traceparent', traceparent.to_header
     end
   end
 end

data/lib/elastic_apm/trace_context/traceparent.rb

@@ -0,0 +1,113 @@
+# 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 ElasticAPM
+  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,
+        tracestate: nil
+      )
+        @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
+        @tracestate = tracestate
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      attr_accessor :version, :id, :trace_id, :parent_id, :recorded, :tracestate
+
+      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