elastic-apm 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bd0b20acebcfa91bc6e5d4e580c6a1a5f8da35b06152a4fe949c76380667e58
-  data.tar.gz: 85935357d8a1831233cb8ab837564b38ff800e29a0cf1891fd4ba6263bb1a0d2
+  metadata.gz: c396bc981217532f2d6775de89e9a2aa7a1bcd501100588bbd700d0f4f2eb590
+  data.tar.gz: 94f859585a09fc99f02a4bbd261193e0ed1f74bdb9463968692a16f277b1e4f0
 SHA512:
-  metadata.gz: 6eabaee4c14440607bdc5b5a0e53fd8b3844e0756a16cf6ef0da4b2a5431e7c1b441d0ef6329baf7d89f165f44031aa6a8396541930576acf54b254a787994cc
-  data.tar.gz: e601985643738456350d49ba9c261ccc17a0259651830230cf353d20c241403846f73c3ce371ab5b6f1a97b1223ac797ddfc1b764333e51055ff53104becd212
+  metadata.gz: ae66a68c4651f695361b2028bf76132e8bc257fc141d3ad2872786bbab10b8e19bc3609a84478de53e56ad0c15695ad7debbcf62c4af8997833d0cf7cc7f6d23
+  data.tar.gz: c6b9fd6f80de4139cac0dd040e45d56f869eb2ff8b3db38df376e898490b8c2a5523a9bb3f1ba73a8583356ae5647ec67835b994597dc3db8d72c62ee506794f

data/.ci/Jenkinsfile

@@ -39,7 +39,7 @@ pipeline {
     quietPeriod(10)
   }
   triggers {
-    issueCommentTrigger('(?i).*(?:jenkins\\W+)?run\\W+(?:the\\W+)?(?:benchmark\\W+)?tests(?:\\W+please)?.*')
+    issueCommentTrigger("(${obltGitHubComments()}|^run benchmark tests)")
   }
   parameters {
     booleanParam(name: 'Run_As_Master_Branch', defaultValue: false, description: 'Allow to run any steps on a PR, some steps normally only run on master branch.')

data/.ci/docker/jruby/11-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_VERSION 9.2.16.0
 ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
 
 RUN mkdir -p /opt/jruby \

data/.ci/docker/jruby/12-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_VERSION 9.3.1.0
 ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
 
 RUN mkdir -p /opt/jruby \

data/.ci/docker/jruby/13-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_VERSION 9.3.1.0
 ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
 
 RUN mkdir -p /opt/jruby \

data/.ci/docker/jruby/7-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.1.17.0
+ENV JRUBY_VERSION 9.3.1.0
 ENV JRUBY_SHA256 6a22f7bf8fef1a52530a9c9781a9d374ad07bbbef0d3d8e2af0ff5cbead0dfd5
 
 RUN mkdir -p /opt/jruby \

data/.ci/docker/jruby/8-jdk/Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update \
     && apt-get install -y gcc \
     && rm -rf /var/lib/apt/lists/*
 
-ENV JRUBY_VERSION 9.2.10.0
+ENV JRUBY_VERSION 9.2.14.0
 ENV JRUBY_SHA256 9199707712c683c525252ccb1de5cb8e75f53b790c5b57a18f6367039ec79553
 
 RUN mkdir -p /opt/jruby \

data/CHANGELOG.asciidoc

@@ -35,6 +35,22 @@ endif::[]
 [[release-notes-4.x]]
 === Ruby Agent version 4.x
 
+[[release-notes-4.5.0]]
+==== 4.5.0
+
+[float]
+===== Changed
+
+- Stop collecting the field `http.request.socket.encrypted` {pull}1181[#1181]
+
+[float]
+===== Fixed
+
+- Fixed MongoDB spy thread safety {pull}1202[#1202]
+- Fixed span context fields for DynamoDB instrumentation {pull}1178[#1178]
+- Fixed span context fields for S3 instrumentation {pull}1179[#1179]
+- Update user agent info to match spec {pull}1182[#1182]
+
 [[release-notes-4.4.0]]
 ==== 4.4.0
 

data/Gemfile

@@ -62,10 +62,6 @@ gem 'sucker_punch', '~> 2.0', require: nil
 gem 'yard', require: nil
 gem 'yarjuf'
 
-# See issue #6547 in the JRuby repo. When that bug is fixed,
-# we can use the latest version of the i18n gem.
-gem 'i18n', '< 1.8.8'
-
 ## Install Framework
 GITHUB_REPOS = {
   'grape' => 'ruby-grape/grape',
@@ -101,6 +97,9 @@ if frameworks_versions.key?('rails')
 end
 
 if RUBY_PLATFORM == 'java'
+  # See issue #6547 in the JRuby repo. It is fixed in JRuby 9.3
+  gem 'i18n', '< 1.8.8' if JRUBY_VERSION < '9.3'
+
   case rails = frameworks_versions['rails']
   when 'main'
     gem 'activerecord-jdbcsqlite3-adapter', git: 'https://github.com/jruby/activerecord-jdbc-adapter', glob: 'activerecord-jdbcsqlite3-adapter/*.gemspec'

data/docs/configuration.asciidoc

@@ -240,7 +240,7 @@ NOTE: This feature requires APM Server and Kibana >= 7.3.
 <<dynamic-configuration, image:./images/dynamic-config.svg[] >>
 
 |============
-| Environment                | `Config` key   | Default | Example |
+| Environment                | `Config` key   | Default | Example
 | `ELASTIC_APM_CAPTURE_BODY` | `capture_body` | `"off"` | `"all"`
 |============
 
@@ -502,7 +502,7 @@ Use this option to ignore certain URL patterns such as healthchecks or admin sec
 | `ELASTIC_APM_INSTRUMENTED_RAKE_TASKS` | `instrumented_rake_tasks` | `[]`    | `['my_task']`
 |============
 
-Elastic APM can instrument your Rake tasks. Theis is an opt-in field, as they are used are for a multitude of things.
+Elastic APM can instrument your Rake tasks. This is an opt-in field, as they are used are for a multitude of things.
 
 [float]
 [[config-log-ecs-formatting]]

data/elastic-apm.gemspec

@@ -20,15 +20,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 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.name    = 'elastic-apm'
+  spec.version = ElasticAPM::VERSION
+  spec.authors = ['Mikkel Malmberg']
+  spec.email   = ['mikkel@elastic.co']
 
-  spec.summary       = 'The official Elastic APM agent for Ruby'
-  spec.homepage      = 'https://github.com/elastic/apm-agent-ruby'
-  spec.metadata     = { 'source_code_uri' => 'https://github.com/elastic/apm-agent-ruby' }
-  spec.license       = 'Apache-2.0'
+  spec.summary  = 'The official Elastic APM agent for Ruby'
+  spec.homepage = 'https://github.com/elastic/apm-agent-ruby'
+  spec.metadata = { 'source_code_uri' => 'https://github.com/elastic/apm-agent-ruby' }
+  spec.license  = 'Apache-2.0'
   spec.required_ruby_version = ">= 2.3.0"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

data/lib/elastic_apm/context/request/socket.rb

@@ -26,10 +26,9 @@ module ElasticAPM
       class Socket
         def initialize(req)
           @remote_addr = req.env['REMOTE_ADDR']
-          @encrypted = req.scheme == 'https'
         end
 
-        attr_reader :remote_addr, :encrypted
+        attr_reader :remote_addr
       end
     end
   end

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
@@ -279,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

@@ -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/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/mongo.rb

@@ -35,8 +35,16 @@ module ElasticAPM
         SUBTYPE = 'mongodb'
         ACTION = 'query'
 
+        EVENT_KEY = :__elastic_instrumenter_mongo_events_key
+
+        class Collection
+          def events
+            Thread.current[EVENT_KEY] ||= {}
+          end
+        end
+
         def initialize
-          @events = {}
+          @collection = Collection.new
         end
 
         def started(event)
@@ -89,11 +97,11 @@ module ElasticAPM
               context: build_context(event)
             )
 
-          @events[event.operation_id] = span
+          @collection.events[event.operation_id] = span
         end
 
         def pop_event(event)
-          span = @events.delete(event.operation_id)
+          span = @collection.events.delete(event.operation_id)
           return unless (curr = ElasticAPM.current_span)
 
           curr == span && ElasticAPM.end_span

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/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.4.0'
+  VERSION = '4.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby