elastic-apm 4.5.1 → 4.7.2

data/elastic-apm.gemspec

@@ -22,8 +22,8 @@ require 'elastic_apm/version'
 Gem::Specification.new do |spec|
   spec.name    = 'elastic-apm'
   spec.version = ElasticAPM::VERSION
-  spec.authors = ['Mikkel Malmberg']
-  spec.email   = ['mikkel@elastic.co']
+  spec.authors = ['Mikkel Malmberg', 'Emily Stolfo']
+  spec.email   = ['info@elastic.co']
 
   spec.summary  = 'The official Elastic APM agent for Ruby'
   spec.homepage = 'https://github.com/elastic/apm-agent-ruby'
@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency('concurrent-ruby', '~> 1.0')
   spec.add_dependency('http', '>= 3.0')
+  spec.add_runtime_dependency('ruby2_keywords')
 
   spec.require_paths = ['lib']
 end

data/lib/elastic_apm/central_config.rb

@@ -181,6 +181,11 @@ module ElasticAPM
           DEFAULT_MAX_AGE
         end
 
+      if seconds < 5
+        debug "Next fetch is too low (#{seconds}s) - increasing to default"
+        seconds = 5
+      end
+
       @scheduled_task =
         Concurrent::ScheduledTask
         .execute(seconds) { fetch_and_apply_config }

data/lib/elastic_apm/config/server_info.rb

@@ -0,0 +1,50 @@
+# 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 Config
+    # @api private
+    class ServerInfo
+      attr_reader :payload, :config, :http
+
+      VERSION_8_0 = '8.0'
+      VERSION_0 = '0'
+
+      def initialize(config)
+        @config = config
+        @http = Transport::Connection::Http.new(config)
+      end
+
+      def execute
+        resp = http.get(config.server_url)
+        @payload = JSON.parse(resp.body)
+      rescue
+        @payload = { "version" => VERSION_0 }
+      end
+
+      def version
+        @version ||= begin
+          execute
+          payload["version"] ? payload["version"].to_s : VERSION_0
+        end
+      end
+    end
+  end
+end
+  

data/lib/elastic_apm/config.rb

@@ -24,14 +24,17 @@ require 'elastic_apm/config/options'
 require 'elastic_apm/config/round_float'
 require 'elastic_apm/config/regexp_list'
 require 'elastic_apm/config/wildcard_pattern_list'
+require 'elastic_apm/deprecations'
+require 'elastic_apm/config/server_info'
 
 module ElasticAPM
   # @api private
   class Config
     extend Options
+    extend Deprecations
 
     SANITIZE_FIELD_NAMES_DEFAULT =
-      %w[password passwd pwd secret *key *token* *session* *credit* *card* authorization set-cookie].freeze
+      %w[password passwd pwd secret *key *token* *session* *credit* *card* *auth* set-cookie].freeze
 
     # rubocop:disable Layout/LineLength, Layout/ExtraSpacing
     option :config_file,                       type: :string, default: 'config/elastic_apm.yml'
@@ -70,7 +73,7 @@ module ElasticAPM
     option :ignore_url_patterns,               type: :list,   default: [],      converter: RegexpList.new
     option :instrument,                        type: :bool,   default: true
     option :instrumented_rake_tasks,           type: :list,   default: []
-    option :log_ecs_formatting,                type: :string, default: 'off'
+    option :log_ecs_reformatting,              type: :string, default: 'off'
     option :log_level,                         type: :int,    default: Logger::INFO, converter: LogLevelMap.new
     option :log_path,                          type: :string
     option :metrics_interval,                  type: :int,    default: '30s',   converter: Duration.new
@@ -98,6 +101,16 @@ module ElasticAPM
     option :use_elastic_traceparent_header,    type: :bool,   default: true
     option :verify_server_cert,                type: :bool,   default: true
 
+    def log_ecs_formatting
+      log_ecs_reformatting
+    end
+
+    def log_ecs_formatting=(value)
+      @options[:log_ecs_reformatting].set(value)
+    end
+
+    deprecate :log_ecs_formatting, :log_ecs_reformatting
+
     # rubocop:enable Layout/LineLength, Layout/ExtraSpacing
     def initialize(options = {})
       @options = load_schema
@@ -116,7 +129,9 @@ module ElasticAPM
 
       yield self if block_given?
 
-      self.logger ||= build_logger
+      if self.logger.nil? || self.log_path
+        self.logger = build_logger
+      end
 
       @__view_paths ||= []
       @__root_path ||= Dir.pwd
@@ -144,6 +159,7 @@ module ElasticAPM
         mongo
         net_http
         rake
+        racecar
         redis
         resque
         s3
@@ -229,6 +245,10 @@ module ElasticAPM
       super.split.first + '>'
     end
 
+    def version
+      @version ||= ServerInfo.new(self).version
+    end
+
     private
 
     def load_config_file
@@ -247,7 +267,7 @@ module ElasticAPM
     end
 
     def build_logger
-      if self.log_ecs_formatting == 'override'
+      if self.log_ecs_reformatting == 'override'
         begin
           return build_ecs_logger
         rescue LoadError
@@ -294,6 +314,7 @@ module ElasticAPM
       self.framework_name ||= 'Ruby on Rails'
       self.framework_version ||= ::Rails::VERSION::STRING
       self.logger ||= ::Rails.logger
+      self.log_level ||= ::Rails.logger.log_level
 
       self.__root_path = ::Rails.root.to_s
       self.__view_paths = app.config.paths['app/views'].existent +

data/lib/elastic_apm/context_builder.rb

@@ -44,7 +44,7 @@ module ElasticAPM
       request = context.request
 
       request.socket = Context::Request::Socket.new(req)
-      request.http_version = build_http_version rack_env
+      request.http_version = build_http_version req
       request.method = req.request_method
       request.url = Context::Request::Url.new(req)
 
@@ -55,6 +55,9 @@ module ElasticAPM
       request.env = env if config.capture_env?
 
       request.cookies = req.cookies.dup
+      unless request.cookies.empty?
+        request.headers['Cookie'] = SKIPPED if request.headers.has_key?('Cookie')
+      end
 
       context
     end
@@ -104,8 +107,8 @@ module ElasticAPM
       key.gsub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
     end
 
-    def build_http_version(rack_env)
-      return unless (http_version = rack_env['HTTP_VERSION'])
+    def build_http_version(req)
+      return unless (http_version = req.env['HTTP_VERSION'])
       http_version.gsub(%r{HTTP/}, '')
     end
   end

data/lib/elastic_apm/error.rb

@@ -33,7 +33,7 @@ module ElasticAPM
     end
 
     attr_accessor :id, :culprit, :exception, :log, :transaction_id,
-      :transaction, :context, :parent_id, :trace_id
+      :transaction_name, :transaction, :context, :parent_id, :trace_id
     attr_reader :timestamp
 
     def inspect
@@ -41,6 +41,7 @@ module ElasticAPM
         " culprit:#{culprit}" \
         " timestamp:#{timestamp}" \
         " transaction_id:#{transaction_id}" \
+        " transaction_name:#{transaction_name}" \
         " trace_id:#{trace_id}" \
         " exception:#{exception.inspect}" \
         '>'

data/lib/elastic_apm/error_builder.rb

@@ -74,6 +74,7 @@ module ElasticAPM
       return unless transaction
 
       error.transaction_id = transaction.id
+      error.transaction_name = transaction.name
       error.transaction = {
         sampled: transaction.sampled?,
         type: transaction.type

data/lib/elastic_apm/instrumenter.rb

@@ -124,7 +124,7 @@ module ElasticAPM
         sample_rate = trace_context.tracestate.sample_rate
       else
         sampled = random_sample?(config)
-        sample_rate = config.transaction_sample_rate
+        sample_rate = sampled ? config.transaction_sample_rate : 0
       end
 
       transaction =
@@ -150,7 +150,9 @@ module ElasticAPM
 
       transaction.done result
 
-      enqueue.call transaction
+      if transaction.sampled? || @config.version < Config::ServerInfo::VERSION_8_0
+        enqueue.call transaction
+      end
 
       update_transaction_metrics(transaction)
 

data/lib/elastic_apm/metadata/cloud_info.rb

@@ -94,16 +94,18 @@ module ElasticAPM
         return unless resp.status == 200
         return unless (metadata = JSON.parse(resp.body.to_s))
 
-        zone = metadata["instance"]["zone"]&.split("/")&.at(-1)
-
         self.provider = "gcp"
-        self.instance_id = metadata["instance"]["id"]
-        self.instance_name = metadata["instance"]["name"]
-        self.project_id = metadata["project"]["numericProjectId"]
-        self.project_name = metadata["project"]["projectId"]
+        self.project_id = metadata["project"]["projectId"]
+
+        return unless metadata['instance']
+
+        zone = metadata["instance"]["zone"]&.split("/")&.at(-1)
         self.availability_zone = zone
         self.region = zone.split("-")[0..-2].join("-")
-        self.machine_type = metadata["instance"]["machineType"]
+
+        self.instance_id = metadata["instance"]["id"].to_s
+        self.instance_name = metadata["instance"]["name"]
+        self.machine_type = metadata["instance"]["machineType"]&.split("/")&.at(-1)
       rescue HTTP::TimeoutError, HTTP::ConnectionError
         nil
       end

data/lib/elastic_apm/metadata/system_info/container_info.rb

@@ -33,14 +33,15 @@ module ElasticAPM
 
         attr_reader :cgroup_path
 
-        def read!
+        def read!(hostname)
           read_from_cgroup!
+          self.kubernetes_pod_name = hostname if kubernetes_pod_uid
           read_from_env!
           self
         end
 
-        def self.read!
-          new.read!
+        def self.read!(hostname)
+          new.read!(hostname)
         end
 
         def container

data/lib/elastic_apm/metadata/system_info.rb

@@ -29,7 +29,7 @@ module ElasticAPM
         @architecture = gem_platform.cpu
         @platform = gem_platform.os
 
-        container_info = ContainerInfo.read!
+        container_info = ContainerInfo.read!(@detected_hostname)
         @container = container_info.container
         @kubernetes = container_info.kubernetes
       end

data/lib/elastic_apm/metrics.rb

@@ -50,27 +50,9 @@ module ElasticAPM
           return
         end
 
-        debug 'Starting metrics'
-
-        # Only set the @sets once, in case we stop
-        # and start again.
-        if @sets.nil?
-          sets = {
-            system: CpuMemSet,
-            vm: VMSet,
-            breakdown: BreakdownSet,
-            transaction: TransactionSet
-          }
-          if defined?(JVMSet)
-            debug "Enabling JVM metrics collection"
-            sets[:jvm] = JVMSet
-          end
+        define_sets
 
-          @sets = sets.each_with_object({}) do |(key, kls), _sets_|
-            debug "Adding metrics collector '#{kls}'"
-            _sets_[key] = kls.new(config)
-          end
-        end
+        debug 'Starting metrics'
 
         @timer_task = Concurrent::TimerTask.execute(
           run_now: true,
@@ -135,6 +117,28 @@ module ElasticAPM
           arr.concat(samples)
         end
       end
+
+      def define_sets
+        # Only set the @sets once, in case we stop
+        # and start again.
+        return unless @sets.nil?
+
+        sets = {
+          system: CpuMemSet,
+          vm: VMSet,
+          breakdown: BreakdownSet,
+          transaction: TransactionSet
+        }
+        if defined?(JVMSet)
+          debug "Enabling JVM metrics collection"
+          sets[:jvm] = JVMSet
+        end
+
+        @sets = sets.each_with_object({}) do |(key, kls), _sets_|
+          debug "Adding metrics collector '#{kls}'"
+          _sets_[key] = kls.new(config)
+        end
+      end
     end
   end
 end

data/lib/elastic_apm/span/context/links.rb

@@ -0,0 +1,32 @@
+# 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 Span
+      class Context
+        # @api private
+        class Links < Array
+          # @api private
+          class Link < Struct.new(:trace_id, :span_id)
+          end
+        end
+      end
+    end
+  end
+  

data/lib/elastic_apm/span/context/service.rb

@@ -0,0 +1,55 @@
+# 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 Span
+    class Context
+      # @api private
+      class Service
+        include Fields
+
+        field :target
+
+        # @api private
+        class Target
+          include Fields
+
+          field :name, default: ''
+          field :type, default: ''
+        end
+
+        def initialize(target: nil, **attrs)
+          super(**attrs)
+
+          self.target = build_target(target)
+        end
+
+        private
+
+        def build_target(target = nil)
+          return Target.new unless target
+          return target if target.is_a?(Target)
+
+          Target.new(**target)
+        end
+      end
+    end
+  end
+end
+  

data/lib/elastic_apm/span/context.rb

@@ -27,7 +27,9 @@ module ElasticAPM
         http: nil,
         labels: {},
         sync: nil,
-        message: nil
+        message: nil,
+        service: nil,
+        links: nil
       )
         @sync = sync
         @db = db && Db.new(**db)
@@ -43,6 +45,16 @@ module ElasticAPM
           when Hash then Message.new(**message)
           end
         @labels = labels
+        @service =
+          case service
+          when Service then service
+          when Hash then Service.new(**service)
+          end
+        @links =
+          case links
+          when Links then links
+          when Array then Links.new(links)
+          end
       end
 
       attr_reader(
@@ -50,10 +62,11 @@ module ElasticAPM
         :http,
         :labels,
         :sync,
-        :message
+        :message,
+        :links
       )
 
-      attr_accessor :destination
+      attr_accessor :destination, :service
     end
   end
 end
@@ -62,3 +75,6 @@ require 'elastic_apm/span/context/db'
 require 'elastic_apm/span/context/http'
 require 'elastic_apm/span/context/destination'
 require 'elastic_apm/span/context/message'
+require 'elastic_apm/span/context/service'
+require 'elastic_apm/span/context/links'
+

data/lib/elastic_apm/span.rb

@@ -145,6 +145,9 @@ module ElasticAPM
         service: service,
         cloud: cloud
       )
+      context.service = Span::Context::Service.new(
+        target: Span::Context::Service::Target.new(name: context.destination.service.name, type: context.destination.service.type )
+      )
     end
 
     def inspect

data/lib/elastic_apm/span_helpers.rb

@@ -22,30 +22,30 @@ module ElasticAPM
   module SpanHelpers
     # @api private
     module ClassMethods
-      def span_class_method(method, name = nil, type = nil)
-        __span_method_on(singleton_class, method, name, type)
+      def span_class_method(method, name = nil, type = nil, **kwargs)
+        __span_method_on(singleton_class, method, name, type, **kwargs)
       end
 
-      def span_method(method, name = nil, type = nil)
-        __span_method_on(self, method, name, type)
+      def span_method(method, name = nil, type = nil, **kwargs)
+        __span_method_on(self, method, name, type, **kwargs)
       end
 
       private
 
-      def __span_method_on(klass, method, name = nil, type = nil)
+      def __span_method_on(klass, method, name = nil, type = nil, **kwargs)
         name ||= method.to_s
         type ||= Span::DEFAULT_TYPE
 
         klass.prepend(Module.new do
-          define_method(method) do |*args, &block|
+          ruby2_keywords(define_method(method) do |*args, &block|
             unless ElasticAPM.current_transaction
               return super(*args, &block)
             end
 
-            ElasticAPM.with_span name.to_s, type.to_s do
+            ElasticAPM.with_span name.to_s, type.to_s, **kwargs do
               super(*args, &block)
             end
-          end
+          end)
         end)
       end
     end

data/lib/elastic_apm/spies/action_dispatch.rb

@@ -24,11 +24,19 @@ module ElasticAPM
     class ActionDispatchSpy
       # @api private
       module Ext
-        def render_exception(env, exception)
-          context = ElasticAPM.build_context(rack_env: env, for_type: :error)
+        def render_exception(request, exception_or_wrapper)
+          context = ElasticAPM.build_context(
+            rack_env: request, for_type: :error
+          )
+          exception =
+            if exception_or_wrapper.is_a?(ActionDispatch::ExceptionWrapper)
+              exception_or_wrapper.exception
+            else
+              exception_or_wrapper
+            end
           ElasticAPM.report(exception, context: context, handled: false)
 
-          super(env, exception)
+          super(request, exception_or_wrapper)
         end
       end
 

data/lib/elastic_apm/spies/faraday.rb

@@ -103,10 +103,26 @@ module ElasticAPM
             ElasticAPM::Spies.without_net_http do
               trace_context = span&.trace_context || transaction.trace_context
 
-              result = super(method, url, body, headers) do |req|
-                trace_context.apply_headers { |k, v| req[k] = v }
-
-                yield req if block
+              begin
+                result = super(method, url, body, headers) do |req|
+                  trace_context.apply_headers { |k, v| req[k] = v }
+                  yield req if block
+                end
+              rescue Faraday::ClientError, Faraday::ServerError => e # Faraday::Response::RaiseError
+                status =
+                  if e.respond_to?(:response_status)
+                    e.response_status
+                  elsif e.response && e.response.respond_to?(:status)
+                    e.response.status
+                  elsif e.response && e.response.respond_to?(:fetch)
+                    e.response[:status]
+                  end
+                http = span&.context&.http
+                if http && status
+                  http.status_code = status.to_s
+                  span.outcome = Span::Outcome.from_http_status(status)
+                end
+                raise e
               end
 
               if (http = span&.context&.http)