elastic-apm 4.1.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9c57d8f754de9ab6d024f95f2822b0eae82f17a00cd3edae13d290c9b850393
-  data.tar.gz: 4d32a175d46dac86cabdf97de023a49e7e5eb155a21be11eb227bf61afdb8ffc
+  metadata.gz: c396bc981217532f2d6775de89e9a2aa7a1bcd501100588bbd700d0f4f2eb590
+  data.tar.gz: 94f859585a09fc99f02a4bbd261193e0ed1f74bdb9463968692a16f277b1e4f0
 SHA512:
-  metadata.gz: '09cddb89d0d5265c7c12e8838702cde336754e197d8f4e6647f3885ccde3f6fc806f91b22ab054cf8c5c465373e34bf0f46580a2ab01513da5246d9ea443bb2c'
-  data.tar.gz: 10732912f09d131204363dd0191e59f689d9560935af8df0b195cd4a145e9402c4a5f3cc3ed136399471f1a406efd7202a7d8384772bc6356b4a64752333cd03
+  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/.ci/jobs/apm-agent-ruby-mbp.yml

@@ -15,6 +15,7 @@
         repo: apm-agent-ruby
         repo-owner: elastic
         credentials-id: 2a9602aa-ab9f-4e52-baf3-b71ca88469c7-UserAndToken
+        head-filter-regex: '^(master|PR-.*|[3-4]\.x)$'
         ssh-checkout:
           credentials: f6c7695a-671e-4f4f-a331-acdce44ff9ba
         build-strategies:

data/CHANGELOG.asciidoc

@@ -35,6 +35,57 @@ 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
+
+[float]
+===== Added
+- Optional span to be ended instead of current span {pull}1039[#1039]
+- Config option `log_ecs_formatting` {pull}1053[#1053]
+
+[float]
+===== Fixed
+- Fixed detecting Linux on Alpine for CPU/MEM metrics {pull}1057[#1057]
+
+[[release-notes-4.3.0]]
+==== 4.3.0
+
+[float]
+===== Added
+
+- Add JVM memory metrics {pull}1040[#1040]
+
+[[release-notes-4.2.0]]
+==== 4.2.0
+
+[float]
+===== Added
+
+- Add support for AWS Storage Table/CosmosDB {pull}999[#999]
+
+[float]
+===== Fixed
+
+- Align HTTP span types/subtypes with spec {pull}1014[#1014]
+- Passing a full URL as a path to `Net::HTTP` {pull}1029[#1029]
+- Fix growing number of open file descriptors {pull}1033[#1033]
+
 [[release-notes-4.1.0]]
 ==== 4.1.0
 

data/Gemfile

@@ -36,6 +36,8 @@ gem 'aws-sdk-dynamodb', require: nil
 gem 'aws-sdk-s3', require: nil
 gem 'aws-sdk-sqs', require: nil
 gem 'aws-sdk-sns', require: nil
+gem 'azure-storage-table', require: nil if RUBY_VERSION < '3.0'
+gem 'ecs-logging', require: 'ecs_logging/logger'
 gem 'elasticsearch', require: nil
 gem 'fakeredis', require: nil
 gem 'faraday', require: nil
@@ -60,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',
@@ -99,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/SECURITY.md

@@ -0,0 +1,7 @@
+# Security Policy
+
+Thanks for your interest in the security of our products.
+Our security policy can be found at [https://www.elastic.co/community/security](https://www.elastic.co/community/security).
+
+## Reporting a Vulnerability
+Please send security vulnerability reports to security@elastic.co.

data/docker-compose.yml

@@ -11,7 +11,7 @@ services:
     build:
       context: .
       args:
-        BUNDLER_VERSION: '2.0.2'
+        BUNDLER_VERSION: '2.2.21'
     image: '$IMAGE_NAME'
     environment:
       HOME: '/tmp'

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,31 @@ 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]]
+==== `log_ecs_formatting`
+
+[options="header"]
+|============
+| Environment             | `Config` key | Default
+| `ELASTIC_APM_LOG_ECS_FORMATTING` | `log_ecs_formatting`  | `off`
+|============
+
+This is an experimental option that configures the agent to use the logger from the `ecs-logging` gem. The two
+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 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.
+
+Note that if you're using Rails, the agent will ignore this option and use the Rails logger. If you want to use a
+`EcsLogging::Logger` when using Rails, set the agent's logger config option explicitly to a `EcsLogging::Logger`
+instance.
 
 [float]
 [[config-log-level]]

data/docs/metrics.asciidoc

@@ -141,3 +141,95 @@ The total time spent in garbage collection.
 
 **NB:** You need to enable Ruby's GC Profiler for this to get reported.
 You can do this at any time when your application boots by calling `GC::Profiler.enable`.
+
+[float]
+[[metrics-jvm-metrics]]
+=== JVM Metrics
+
+The following metrics are available when using JRuby. They use the ruby java API to gather metrics via MXBean.
+
+[float]
+[[metric-jvm.memory.heap.used]]
+==== `jvm.memory.heap.used`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The amount of used heap memory in bytes.
+
+[float]
+[[metric-jvm.memory.heap.committed]]
+==== `jvm.memory.heap.committed`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The amount of heap memory in bytes that is committed for the Java virtual machine to use. This amount of memory is
+guaranteed for the Java virtual machine to use.
+
+[float]
+[[metric-jvm.memory.heap.max]]
+==== `jvm.memory.heap.max`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The amount of heap memory in bytes that is committed for the Java virtual machine to use. This amount of memory is
+guaranteed for the Java virtual machine to use.
+
+[float]
+[[metric-jvm.memory.non_heap.used]]
+==== `jvm.memory.non_heap.used`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The amount of used non-heap memory in bytes.
+
+[float]
+[[metric-jvm.memory.non_heap.committed]]
+==== `jvm.memory.non_heap.committed`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The amount of non-heap memory in bytes that is committed for the Java virtual machine to use. This amount of memory is
+guaranteed for the Java virtual machine to use.
+
+[float]
+[[metric-jvm.memory.non_heap.max]]
+==== `jvm.memory.non_heap.max`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The maximum amount of non-heap memory in bytes that can be used for memory management. If the maximum memory size is
+undefined, the value is -1.
+
+[float]
+[[metric-jvm.memory.heap.pool.used]]
+==== `jvm.memory.heap.pool.used`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The amount of used memory in bytes of the memory pool.
+
+[float]
+[[metric-jvm.memory.heap.pool.committed]]
+==== `jvm.memory.heap.pool.committed`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The amount of memory in bytes that is committed for the memory pool. This amount of memory is guaranteed for this
+specific pool.
+
+[float]
+[[metric-jvm.memory.heap.pool.max]]
+==== `jvm.memory.heap.pool.max`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The maximum amount of memory in bytes that can be used for the memory pool.

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/agent.rb

@@ -211,8 +211,8 @@ module ElasticAPM
     end
     # rubocop:enable Metrics/ParameterLists
 
-    def end_span
-      instrumenter.end_span
+    def end_span(span = nil)
+      instrumenter.end_span(span)
     end
 
     def set_label(key, value)
@@ -280,8 +280,8 @@ module ElasticAPM
     def detect_forking!
       return if @pid == Process.pid
 
-      config.logger.debug "Forked process detected,
-        restarting threads in process [PID:#{Process.pid}]"
+      config.logger.debug(
+        "Forked process detected, restarting threads in process [PID:#{Process.pid}]")
 
       central_config.handle_forking!
       transport.handle_forking!

data/lib/elastic_apm/central_config.rb

@@ -119,7 +119,7 @@ module ElasticAPM
       end
 
       if resp.status == 304
-        info 'Received 304 Not Modified'
+        debug 'Received 304 Not Modified'
       else
         if resp.body && !resp.body.empty?
           update = JSON.parse(resp.body.to_s)
@@ -169,7 +169,7 @@ module ElasticAPM
     end
 
     def headers
-      { 'Etag': @etag }
+      { 'If-None-Match': @etag }
     end
 
     def schedule_next_fetch(resp = nil)

data/lib/elastic_apm/config.rb

@@ -70,6 +70,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_level,                         type: :int,    default: Logger::INFO, converter: LogLevelMap.new
     option :log_path,                          type: :string
     option :metrics_interval,                  type: :int,    default: '30s',   converter: Duration.new
@@ -133,6 +134,7 @@ module ElasticAPM
     def available_instrumentations
       %w[
         action_dispatch
+        azure_storage_table
         delayed_job
         dynamo_db
         elasticsearch
@@ -245,11 +247,29 @@ module ElasticAPM
     end
 
     def build_logger
+      if self.log_ecs_formatting == 'override'
+        begin
+          return build_ecs_logger
+        rescue LoadError
+          logger.info "Attempted to use EcsLogging::Logger but the gem couldn't be " \
+            "loaded so a ::Logger was created instead. Check if you have the `ecs-logging` " \
+            "gem installed and attempt to start the agent again."
+        end
+      end
+
       Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
         logger.level = log_level
       end
     end
 
+    def build_ecs_logger
+      require 'ecs_logging/logger'
+
+      ::EcsLogging::Logger.new(log_path == '-' ? $stdout : log_path).tap do |logger|
+        logger.level = log_level
+      end
+    end
+
     def app_type?(app)
       if defined?(::Rails::Application) && app.is_a?(::Rails::Application)
         return :rails

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

@@ -0,0 +1,98 @@
+# 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
+  # An interface for creating simple, value holding objects that correspond to
+  # object fields in the API.
+  #
+  # Example:
+  #   class MyThing
+  #     include Fields
+  #     field :name
+  #     field :address, default: 'There'
+  #   end
+  #
+  #   MyThing.new(name: 'AJ').to_h
+  #     # => { name: 'AJ' }
+  #   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|
+          send(:"#{key}=", value)
+        end
+
+        super()
+      end
+
+      def empty?
+        self.class.schema.each do |key, field|
+          next if send(key).nil?
+          return false
+        end
+
+        true
+      end
+
+      def to_h
+        schema.each_with_object({}) do |(key, field), hsh|
+          hsh[key] = send(key)
+        end
+      end
+
+      private
+
+      def schema
+        self.class.schema
+      end
+    end
+
+    module ClassMethods
+      def field(key, default: nil)
+        field = Field.new(key, default: default)
+        schema[key] = field
+
+        attr_accessor(key)
+      end
+
+      attr_reader :schema
+    end
+
+    def self.included(cls)
+      cls.extend(ClassMethods)
+      cls.include(InstanceMethods)
+
+      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