elastic-apm 4.3.0 → 4.5.1

data/lib/elastic_apm/fields.rb

@@ -25,7 +25,7 @@ module ElasticAPM
   #   class MyThing
   #     include Fields
   #     field :name
-  #     field :address, optional: true
+  #     field :address, default: 'There'
   #   end
   #
   #   MyThing.new(name: 'AJ').to_h
@@ -33,56 +33,66 @@ module ElasticAPM
   #   MyThing.new().empty?
   #     # => true
   module Fields
+    class Field
+      def initialize(key, default: nil)
+        @key = key
+        @default = default
+      end
+
+      attr_reader :key, :default
+    end
+
     module InstanceMethods
       def initialize(**attrs)
+        schema.each do |key, field|
+          send(:"#{key}=", field.default)
+        end
+
         attrs.each do |key, value|
-          self.send(:"#{key}=", value)
+          send(:"#{key}=", value)
         end
 
         super()
       end
 
       def empty?
-        self.class.fields.each do |key|
-          next if send(key)
-          next if optionals.include?(key)
-
-          return true
+        self.class.schema.each do |key, field|
+          next if send(key).nil?
+          return false
         end
 
-        false
+        true
       end
 
       def to_h
-        self.class.fields.each_with_object({}) do |key, fields|
-          fields[key] = send(key)
+        schema.each_with_object({}) do |(key, field), hsh|
+          hsh[key] = send(key)
         end
       end
 
       private
 
-      def optionals
-        self.class.optionals
+      def schema
+        self.class.schema
       end
     end
 
     module ClassMethods
-      def field(key, optional: false)
-        attr_accessor(key)
+      def field(key, default: nil)
+        field = Field.new(key, default: default)
+        schema[key] = field
 
-        fields.push(key)
-        optionals.push(key) if optional
+        attr_accessor(key)
       end
 
-      attr_reader :fields, :optionals
+      attr_reader :schema
     end
 
     def self.included(cls)
       cls.extend(ClassMethods)
       cls.include(InstanceMethods)
 
-      cls.instance_variable_set(:@fields, [])
-      cls.instance_variable_set(:@optionals, [])
+      cls.instance_variable_set(:@schema, {})
     end
   end
 end

data/lib/elastic_apm/instrumenter.rb

@@ -179,7 +179,8 @@ module ElasticAPM
       context: nil,
       trace_context: nil,
       parent: nil,
-      sync: nil
+      sync: nil,
+      exit_span: nil
     )
 
       transaction =
@@ -197,6 +198,15 @@ module ElasticAPM
 
       parent ||= (current_span || current_transaction)
 
+      # To not mess with breakdown metric stats, exit spans MUST not add
+      # sub-spans unless they share the same type and subtype.
+      if parent && parent.is_a?(Span) && parent.exit_span?
+        if parent.type != type || parent.subtype != subtype
+          debug "Skipping new span '#{name}' as its parent is an exit_span"
+          return
+        end
+      end
+
       span = Span.new(
         name: name,
         subtype: subtype,
@@ -207,7 +217,8 @@ module ElasticAPM
         type: type,
         context: context,
         stacktrace_builder: stacktrace_builder,
-        sync: sync
+        sync: sync,
+        exit_span: exit_span
       )
 
       if backtrace && transaction.span_frames_min_duration
@@ -222,8 +233,14 @@ module ElasticAPM
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
 
-    def end_span
-      return unless (span = current_spans.pop)
+    def end_span(span = nil)
+      if span
+        current_spans.delete(span)
+      else
+        span = current_spans.pop
+      end
+
+      return unless span
 
       span.done
 
@@ -273,24 +290,9 @@ module ElasticAPM
         'transaction.type': transaction.type
       }
 
-      @metrics.get(:transaction).timer(
-        :'transaction.duration.sum.us',
-        tags: tags, reset_on_collect: true
-      ).update(transaction.duration)
-
-      @metrics.get(:transaction).counter(
-        :'transaction.duration.count',
-        tags: tags, reset_on_collect: true
-      ).inc!
-
       return unless transaction.sampled?
       return unless transaction.breakdown_metrics
 
-      @metrics.get(:breakdown).counter(
-        :'transaction.breakdown.count',
-        tags: tags, reset_on_collect: true
-      ).inc!
-
       span_tags = tags.merge('span.type': 'app')
 
       @metrics.get(:breakdown).timer(

data/lib/elastic_apm/metadata/service_info.rb

@@ -49,7 +49,7 @@ module ElasticAPM
         )
         @language = Language.new(name: 'ruby', version: RUBY_VERSION)
         @runtime = lookup_runtime
-        @version = @config.service_version || Util.git_sha
+        @version = @config.service_version
       end
 
       attr_reader :name, :node_name, :environment, :agent, :framework,

data/lib/elastic_apm/metadata/system_info.rb

@@ -50,7 +50,8 @@ module ElasticAPM
       private
 
       def detect_hostname
-        `hostname`.chomp
+        Socket.gethostname.chomp
+      rescue
       end
     end
   end

data/lib/elastic_apm/metrics/cpu_mem_set.rb

@@ -77,7 +77,7 @@ module ElasticAPM
 
       def sampler_for_os(os)
         case os
-        when :linux then Linux.new
+        when /^linux/ then Linux.new
         else
           warn "Disabling system metrics, unsupported host OS '#{os}'"
           disable!
@@ -116,6 +116,9 @@ module ElasticAPM
         process_cpu_usage =
           current.process_cpu_usage - previous.process_cpu_usage
 
+        # No change / avoid dividing by 0
+        return [0, 0] if system_cpu_total == 0
+
         cpu_usage_pct = system_cpu_usage.to_f / system_cpu_total
         cpu_process_pct = process_cpu_usage.to_f / system_cpu_total
 

data/lib/elastic_apm/metrics/metric.rb

@@ -57,6 +57,8 @@ module ElasticAPM
         @mutex.synchronize do
           collected = @value
 
+          return nil if collected.is_a?(Float) && !collected.finite?
+
           @value = initial_value if reset_on_collect?
 
           return nil if reset_on_collect? && collected == 0

data/lib/elastic_apm/metrics.rb

@@ -29,15 +29,13 @@ module ElasticAPM
     end
 
     def self.os
-      @platform ||= RbConfig::CONFIG.fetch('host_os', 'unknown').to_sym
+      @os ||= RbConfig::CONFIG.fetch('host_os', 'unknown').to_sym
     end
 
     # @api private
     class Registry
       include Logging
 
-      TIMEOUT_INTERVAL = 5 # seconds
-
       def initialize(config, &block)
         @config = config
         @callback = block
@@ -76,8 +74,7 @@ module ElasticAPM
 
         @timer_task = Concurrent::TimerTask.execute(
           run_now: true,
-          execution_interval: config.metrics_interval,
-          timeout_interval: TIMEOUT_INTERVAL
+          execution_interval: config.metrics_interval
         ) do
           begin
             debug 'Collecting metrics'

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

@@ -33,8 +33,8 @@ module ElasticAPM
         class Service
           include Fields
 
-          field :name
-          field :type
+          field :name, default: ''
+          field :type, default: ''
           field :resource
         end
 

data/lib/elastic_apm/span.rb

@@ -49,7 +49,8 @@ module ElasticAPM
       action: nil,
       context: nil,
       stacktrace_builder: nil,
-      sync: nil
+      sync: nil,
+      exit_span: false
     )
       @name = name
 
@@ -68,6 +69,8 @@ module ElasticAPM
 
       @context = context || Span::Context.new(sync: sync)
       @stacktrace_builder = stacktrace_builder
+
+      @exit_span = exit_span
     end
     # rubocop:enable Metrics/ParameterLists
 
@@ -75,6 +78,7 @@ module ElasticAPM
 
     attr_accessor(
       :action,
+      :exit_span,
       :name,
       :original_backtrace,
       :outcome,
@@ -93,6 +97,8 @@ module ElasticAPM
       :transaction
     )
 
+    alias :exit_span? :exit_span
+
     # life cycle
 
     def start(clock_start = Util.monotonic_micros)
@@ -107,17 +113,6 @@ module ElasticAPM
       @parent.child_stopped
       @self_time = @duration - child_durations.duration
 
-      if exit_span?
-        context.destination ||= Context::Destination.new
-        context.destination.service ||= Context::Destination::Service.new
-        context.destination.service.resource ||= (subtype || type)
-
-        # Deprecated fields but required by some versions of APM Server, so
-        # we auto-infer them from existing fields
-        context.destination.service.name ||= (subtype || type)
-        context.destination.service.type ||= type
-      end
-
       self
     end
 
@@ -158,6 +153,7 @@ module ElasticAPM
         " type:#{type.inspect}" \
         " subtype:#{subtype.inspect}" \
         " action:#{action.inspect}" \
+        " exit_span:#{exit_span.inspect}" \
         '>'
     end
 
@@ -180,9 +176,5 @@ module ElasticAPM
 
       duration >= min_duration
     end
-
-    def exit_span?
-      context.destination || context.db || context.message || context.http
-    end
   end
 end

data/lib/elastic_apm/spies/dynamo_db.rb

@@ -22,9 +22,9 @@ module ElasticAPM
   module Spies
     # @api private
     class DynamoDBSpy
-      NAME = 'dynamodb'
       TYPE = 'db'
       SUBTYPE = 'dynamodb'
+      ACTION = 'query'
 
       @@formatted_op_names = Concurrent::Map.new
 
@@ -63,7 +63,12 @@ module ElasticAPM
                   statement: params[:key_condition_expression]
                 },
                 destination: {
-                  service: { resource: "#{SUBTYPE}/#{config.region}" },
+                  address: config.endpoint.host,
+                  port: config.endpoint.port,
+                  service: {
+                      name: SUBTYPE,
+                      type: TYPE,
+                      resource: SUBTYPE },
                   cloud: { region: config.region }
                 }
               )
@@ -72,7 +77,7 @@ module ElasticAPM
                 ElasticAPM::Spies::DynamoDBSpy.span_name(operation_name, params),
                 TYPE,
                 subtype: SUBTYPE,
-                action: operation_name,
+                action: ACTION,
                 context: context
               ) do
                 ElasticAPM::Spies::DynamoDBSpy.without_net_http do

data/lib/elastic_apm/spies/elasticsearch.rb

@@ -79,7 +79,11 @@ module ElasticAPM
       end
 
       def install
-        ::Elasticsearch::Transport::Client.prepend(Ext)
+        if defined?(::Elastic::Transport::Client)
+          ::Elastic::Transport::Client.prepend(Ext)
+        elsif defined?(::Elasticsearch::Transport::Client)
+          ::Elasticsearch::Transport::Client.prepend(Ext)
+        end
       end
     end
 
@@ -88,5 +92,11 @@ module ElasticAPM
       'elasticsearch-transport',
       ElasticsearchSpy.new
     )
+
+    register(
+      'Elastic::Transport::Client',
+      'elastic-transport',
+      ElasticsearchSpy.new
+    )
   end
 end

data/lib/elastic_apm/spies/mongo.rb

@@ -35,8 +35,10 @@ module ElasticAPM
         SUBTYPE = 'mongodb'
         ACTION = 'query'
 
-        def initialize
-          @events = {}
+        EVENT_KEY = :__elastic_instrumenter_mongo_events_key
+
+        def events
+          Thread.current[EVENT_KEY] ||= []
         end
 
         def started(event)
@@ -70,7 +72,7 @@ module ElasticAPM
           # and the collection name is at the key `collection`
           collection =
             if event.command[event.command_name] == 1 ||
-               event.command[event.command_name].is_a?(BSON::Int64)
+              event.command[event.command_name].is_a?(BSON::Int64)
               event.command[:collection]
             else
               event.command[event.command_name]
@@ -89,14 +91,13 @@ module ElasticAPM
               context: build_context(event)
             )
 
-          @events[event.operation_id] = span
+          events << span
         end
 
         def pop_event(event)
-          span = @events.delete(event.operation_id)
           return unless (curr = ElasticAPM.current_span)
 
-          curr == span && ElasticAPM.end_span
+          curr == events[-1] && ElasticAPM.end_span(events.pop)
         end
 
         def build_context(event)

data/lib/elastic_apm/spies/s3.rb

@@ -87,8 +87,17 @@ module ElasticAPM
 
               resource = "#{SUBTYPE}/#{bucket_name || 'unknown-bucket'}"
               context = ElasticAPM::Span::Context.new(
+                db: {
+                  instance: config.region,
+                  type: SUBTYPE
+                },
                 destination: {
-                  service: { resource: resource },
+                  address: config.endpoint.host,
+                  port: config.endpoint.port,
+                  service: {
+                    name: SUBTYPE,
+                    type: TYPE,
+                    resource: resource },
                   cloud: { region: region }
                 }
               )

data/lib/elastic_apm/spies/sns.rb

@@ -38,7 +38,7 @@ module ElasticAPM
       end
 
       def self.get_topic(params)
-        return '<PHONE_NUMBER>' if params[:phone_number]
+        return '[PHONENUMBER]' if params[:phone_number]
 
         last_after_slash_or_colon(
           params[:topic_arn] || params[:target_arn]

data/lib/elastic_apm/transport/base.rb

@@ -35,7 +35,6 @@ module ElasticAPM
       include Logging
 
       WATCHER_EXECUTION_INTERVAL = 5
-      WATCHER_TIMEOUT_INTERVAL = 4
       WORKER_JOIN_TIMEOUT = 5
 
       def initialize(config)
@@ -112,8 +111,7 @@ module ElasticAPM
 
       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/elastic_apm/transport/serializers/context_serializer.rb

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

data/lib/elastic_apm/transport/serializers/metadata_serializer.rb

@@ -80,14 +80,18 @@ module ElasticAPM
         end
 
         def build_system(system)
-          {
-            detected_hostname: keyword_field(system.detected_hostname),
+          base = {
             configured_hostname: keyword_field(system.configured_hostname),
             architecture: keyword_field(system.architecture),
             platform: keyword_field(system.platform),
             kubernetes: keyword_object(system.kubernetes),
             container: keyword_object(system.container)
           }
+          if system.detected_hostname
+            base[:detected_hostname] = keyword_field(system.detected_hostname)
+          end
+
+          base
         end
 
         def build_cloud(cloud)

data/lib/elastic_apm/transport/serializers/span_serializer.rb

@@ -100,12 +100,12 @@ module ElasticAPM
               port: destination.port
             }
 
-            unless destination.service&.empty?
-              base[:service] = destination.service.to_h
+            if (service = destination.service) && !service.empty?
+              base[:service] = service.to_h
             end
 
-            unless destination.cloud&.empty?
-              base[:cloud] = destination.cloud.to_h
+            if (cloud = destination.cloud) && !cloud.empty?
+              base[:cloud] = cloud.to_h
             end
 
             base

data/lib/elastic_apm/transport/user_agent.rb

@@ -37,12 +37,18 @@ module ElasticAPM
 
         [
           "elastic-apm-ruby/#{@version}",
-          HTTP::Request::USER_AGENT,
-          [
-            service.runtime.name,
-            service.runtime.version
-          ].join('/')
-        ].join(' ')
+          formatted_service_info(service)
+        ].compact.join(' ')
+      end
+
+      def formatted_service_info(service)
+        if service.name
+          "(#{[
+                service.name,
+                service.version
+               ].compact.join(' ')
+             })"
+        end
       end
     end
   end

data/lib/elastic_apm/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '4.3.0'
+  VERSION = '4.5.1'
 end

data/lib/elastic_apm.rb

@@ -243,9 +243,12 @@ module ElasticAPM
 
     # Ends the current span
     #
+    # @param span [Span] Optional span to be ended instead of the last span
+    #   created, useful for asynchronous environments where multiple spans are created in parallel
+    #
     # @return [Span]
-    def end_span
-      agent&.end_span
+    def end_span(span = nil)
+      agent&.end_span(span)
     end
 
     # rubocop:disable Metrics/ParameterLists

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.1
 platform: ruby
 authors:
 - Mikkel Malmberg
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-description:
+description: 
 email:
 - mikkel@elastic.co
 executables: []
@@ -48,7 +48,7 @@ files:
 - ".ci/.jenkins_codecov.yml"
 - ".ci/.jenkins_exclude.yml"
 - ".ci/.jenkins_framework.yml"
-- ".ci/.jenkins_master_framework.yml"
+- ".ci/.jenkins_main_framework.yml"
 - ".ci/.jenkins_ruby.yml"
 - ".ci/Jenkinsfile"
 - ".ci/docker/jruby/11-jdk/Dockerfile"
@@ -258,7 +258,7 @@ licenses:
 - Apache-2.0
 metadata:
   source_code_uri: https://github.com/elastic/apm-agent-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -273,8 +273,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: The official Elastic APM agent for Ruby
 test_files: []