elastic-apm 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc66ce3466effa6740c0b8c9dbb0d74358b54d9039ceebe2938674170e68662b
-  data.tar.gz: d3288b6cf41bbe33fb6594789371d36fcb66ccc2b9ec9d8d2f6aed08f4d212f7
+  metadata.gz: 9bd0b20acebcfa91bc6e5d4e580c6a1a5f8da35b06152a4fe949c76380667e58
+  data.tar.gz: 85935357d8a1831233cb8ab837564b38ff800e29a0cf1891fd4ba6263bb1a0d2
 SHA512:
-  metadata.gz: 6fcdb201cf7b1824776fffff92e8fc538613928b4ae977f694f67239c15a9e10f14a1ceb4669248eb658c4b2fd439398d0badd231292367e8371655cd2bae738
-  data.tar.gz: 72fdb5641db042a4c7ccd6fcdfc97d43949d1f8ed0b561029e6beffa640262d04c2a639f5f75944b944c1283dae8b2c929f0a3aae14e7e2547af3e942e4307a8
+  metadata.gz: 6eabaee4c14440607bdc5b5a0e53fd8b3844e0756a16cf6ef0da4b2a5431e7c1b441d0ef6329baf7d89f165f44031aa6a8396541930576acf54b254a787994cc
+  data.tar.gz: e601985643738456350d49ba9c261ccc17a0259651830230cf353d20c241403846f73c3ce371ab5b6f1a97b1223ac797ddfc1b764333e51055ff53104becd212

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,18 @@ endif::[]
 [[release-notes-4.x]]
 === Ruby Agent version 4.x
 
+[[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
 

data/Gemfile

@@ -37,6 +37,7 @@ 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

data/docs/configuration.asciidoc

@@ -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. Theis 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/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)

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
@@ -246,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/instrumenter.rb

@@ -222,8 +222,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
 

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!

data/lib/elastic_apm/metrics.rb

@@ -29,7 +29,7 @@ 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

data/lib/elastic_apm/version.rb

@@ -18,5 +18,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '4.3.0'
+  VERSION = '4.4.0'
 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.4.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -273,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: The official Elastic APM agent for Ruby