elastic-apm 4.5.1 → 4.6.1

data/docs/configuration.asciidoc

@@ -506,12 +506,12 @@ Elastic APM can instrument your Rake tasks. This is an opt-in field, as they are
 
 [float]
 [[config-log-ecs-formatting]]
-==== `log_ecs_formatting`
+==== `log_ecs_reformatting`
 
 [options="header"]
 |============
 | Environment             | `Config` key | Default
-| `ELASTIC_APM_LOG_ECS_FORMATTING` | `log_ecs_formatting`  | `off`
+| `ELASTIC_APM_LOG_ECS_REFORMATTING` | `log_ecs_reformatting`  | `off`
 |============
 
 This is an experimental option that configures the agent to use the logger from the `ecs-logging` gem. The two
@@ -520,7 +520,7 @@ valid options are `off` and `override`.
 Setting this option to `override` will set the agent logger to a `EcsLogging::Logger` instance and all logged output
 will be in ECS-compatible json.
 
-The `ecs-logging` gem must be installed before the agent is started. If `log_ecs_formatting` is set to `override`,
+The `ecs-logging` gem must be installed before the agent is started. If `log_ecs_reformatting` is set to `override`,
 the agent will attempt to require the gem and if it cannot be loaded, it will fall back to using the standard Ruby
 `::Logger` and log the load error.
 
@@ -556,6 +556,8 @@ A path to a log file.
 
 By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails.
 
+If `log_path` is specified, this will override `Rails.log` to point to that path instead.
+
 This should support both absolute and relative paths. Please be sure the directory exists.
 
 [float]
@@ -654,7 +656,7 @@ when this option is false.
 [options="header"]
 |============
 | Environment                        | `Config` key           | Default                                                                                        | Example
-| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `"password,passwd,pwd,secret,*key,*token*,*session*,*credit*,*card*,authorization,set-cookie"` | `Auth*tion,abc*,*xyz`
+| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `sanitize_field_names` | `"password,passwd,pwd,secret,*key,*token*,*session*,*credit*,*card*,*auth*,set-cookie"` | `Auth*tion,abc*,*xyz`
 |============
 
 Sometimes it is necessary to sanitize the data sent to Elastic APM to remove sensitive values.

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/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/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/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

@@ -37,7 +37,7 @@ module ElasticAPM
         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
@@ -45,7 +45,7 @@ module ElasticAPM
             ElasticAPM.with_span name.to_s, type.to_s do
               super(*args, &block)
             end
-          end
+          end)
         end)
       end
     end

data/lib/elastic_apm/spies/faraday.rb

@@ -102,6 +102,7 @@ module ElasticAPM
           ) do |span|
             ElasticAPM::Spies.without_net_http do
               trace_context = span&.trace_context || transaction.trace_context
+              self.response :elastic_apm_middleware, span # middleware
 
               result = super(method, url, body, headers) do |req|
                 trace_context.apply_headers { |k, v| req[k] = v }
@@ -122,6 +123,28 @@ module ElasticAPM
       # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       def install
+        # This middleware class has to be defined here because it inherits from
+        # ::Faraday::Middleware, which isn't defined when this file loads.
+        tracing_middleware = Class.new ::Faraday::Middleware do
+          attr_reader :span
+
+          def initialize(app, span = nil, options = {})
+            super(app)
+            @span = span
+          end
+
+          def on_complete(env)
+            status = env[:status]
+            http = span&.context&.http
+            if http && status
+              http.status_code = status.to_s
+              span.outcome = Span::Outcome.from_http_status(status)
+            end
+          end
+        end
+        ::Faraday::Response.register_middleware(
+          elastic_apm_middleware: -> { tracing_middleware }
+        )
         ::Faraday::Connection.prepend(Ext)
       end
     end

data/lib/elastic_apm/spies/racecar.rb

@@ -0,0 +1,77 @@
+# 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.
+
+begin
+require 'active_support/notifications'
+require 'active_support/subscriber'
+
+  # frozen_string_literal: true
+  module ElasticAPM
+    # @api private
+    module Spies
+      # @api private
+      class RacecarSpy
+        TYPE = 'kafka'
+        SUBTYPE = 'racecar'
+
+        # @api private
+        class ConsumerSubscriber < ActiveSupport::Subscriber
+          def start_process_message(event)
+            start_process_transaction(event: event, kind: 'process_message')
+          end
+          def process_message(_event)
+            ElasticAPM.end_transaction
+          end
+
+          def start_process_batch(event)
+            start_process_transaction(event: event, kind: 'process_batch')
+          end
+          def process_batch(_event)
+            ElasticAPM.end_transaction
+          end
+
+          private # only public methods will be subscribed
+
+          def start_process_transaction(event:, kind:)
+            ElasticAPM.start_transaction(kind, TYPE)
+            ElasticAPM.current_transaction.context.set_service(framework_name: 'racecar', framework_version: Racecar::VERSION)
+          end
+        end
+
+        class ProducerSubscriber < ActiveSupport::Subscriber
+          def start_deliver_message(event)
+            ElasticAPM.start_transaction('deliver_message',TYPE)
+            ElasticAPM.current_transaction.context.set_service(framework_name: 'racecar', framework_version: Racecar::VERSION)
+          end
+
+          def deliver_message(_event)
+            ElasticAPM.end_transaction
+          end
+        end
+
+        def install
+          ConsumerSubscriber.attach_to(:racecar)
+          ProducerSubscriber.attach_to(:racecar)
+        end
+      end
+      register 'Racecar', 'racecar', RacecarSpy.new
+    end
+  end
+
+rescue LoadError
+  # no active support available
+end

data/lib/elastic_apm/spies/redis.rb

@@ -25,7 +25,7 @@ module ElasticAPM
       # @api private
       module Ext
         def call(command, &block)
-          name = command[0].upcase
+          name = command[0].to_s.upcase
 
           return super(command, &block) if command[0] == :auth
 

data/lib/elastic_apm/spies/sequel.rb

@@ -44,8 +44,17 @@ module ElasticAPM
           name =
             ElasticAPM::Spies::SequelSpy.summarizer.summarize sql
 
+          db_name = ''
+          # postgresql shows current database
+          db_name = connection&.db.to_s if connection.respond_to?(:db)
+          # sqlite may expose a filename
+          db_name = connection&.filename.to_s if db_name == '' && connection.respond_to?(:filename)
+          # fall back to adapter class name
+          db_name = connection.class.to_s if db_name == ''
+
           context = ElasticAPM::Span::Context.new(
             db: { statement: sql, type: 'sql', user: opts[:user] },
+            service: {target: {type: subtype, name: db_name }},
             destination: { service: { resource: subtype } }
           )
 

data/lib/elastic_apm/spies/sqs.rb

@@ -56,6 +56,7 @@ module ElasticAPM
             service: { resource: "#{SUBTYPE}/#{queue_name}" },
             cloud: { region: region }
           }
+          # span links added here?
         )
       end
 

data/lib/elastic_apm/trace_context/tracestate.rb

@@ -92,6 +92,8 @@ module ElasticAPM
 
       extend Forwardable
 
+      ENTRY_SPLIT_REGEX = /\s*[\n,]+\s*/
+
       def initialize(entries: {}, sample_rate: nil)
         @entries = entries
 
@@ -107,7 +109,7 @@ module ElasticAPM
           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)
@@ -140,7 +142,7 @@ module ElasticAPM
           # 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
+          String(str).split(ENTRY_SPLIT_REGEX).flatten
         end
       end
     end

data/lib/elastic_apm/trace_context.rb

@@ -96,7 +96,7 @@ module ElasticAPM
     def apply_headers
       yield 'Traceparent', traceparent.to_header
 
-      if tracestate
+      if tracestate && !tracestate.to_header.empty?
         yield 'Tracestate', tracestate.to_header
       end
 

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

@@ -75,7 +75,15 @@ module ElasticAPM
           @closed.make_true
 
           @wr&.close
-          return if @request.nil? || @request&.join(5)
+
+          if @request&.join(5)
+            @rd&.close
+            return
+          end
+
+          @rd&.close
+
+          return if @request.nil?
 
           error(
             '%s: APM Server not responding in time, terminating request',
@@ -117,8 +125,6 @@ module ElasticAPM
               error(
                 "Couldn't establish connection to APM Server:\n%p", e.inspect
               )
-            ensure
-              @rd&.close
             end
           end
         end