elastic-apm 4.0.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1714ce04cac580fae85d1db089aad12a44e6ae719ae4c077c695ed19331d1862
-  data.tar.gz: 2d2dc08bec25deca316844d1d4f8e878bf552ea473b27447f4476a82cf03872d
+  metadata.gz: 9bd0b20acebcfa91bc6e5d4e580c6a1a5f8da35b06152a4fe949c76380667e58
+  data.tar.gz: 85935357d8a1831233cb8ab837564b38ff800e29a0cf1891fd4ba6263bb1a0d2
 SHA512:
-  metadata.gz: b1fba467b1fffb405b354511485b373d3e25bf141b6ab4404d80f4b9e431b4defc640b2f4c3edbc5e9253914844b09949ad6d617e3a5f0efe0c9f496ea7444ee
-  data.tar.gz: dd749fc5782ab61ae5fe489fbe1d69dec7a33fac44a0a26fbd1c8b95b03f2f372c1e9350987e266f4098ec18cc3d409712a23ac92edfe0a1f25cef5760f64ebb
+  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/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: sucker_punch
+    versions:
+    - "> 2.0"
+  - dependency-name: i18n
+    versions:
+    - 1.8.10
+    - 1.8.8
+    - 1.8.9

data/CHANGELOG.asciidoc

@@ -35,6 +35,61 @@ 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
+
+[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
+
+[float]
+===== Added
+
+- Azure App Services instance metadata {pull}1007[#1007]
+
+[float]
+===== Changed
+
+- `hostname` is now reported split by `configured_hostname` and `detected_hostname` {pull}1009[#1009]
+
+[float]
+===== Fixed
+- `service_node_name` is now correctly reported as `service.node.configured_name` {pull}1009[#1009]
+- Fix JSON parsing when using yajl-ruby {pull}1012[#1012]
+- Fix SpanHelpers when methods take blocks {pull}1013[#1013]
+- Fix missing `environment` param when fetching from Central Config {pull}1014[#1014]
+
 [[release-notes-4.0.0]]
 ==== 4.0.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

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

@@ -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/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/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)
@@ -164,11 +164,12 @@ module ElasticAPM
       @server_url ||=
         config.server_url +
         '/config/v1/agents' \
-        "?service.name=#{CGI.escape(config.service_name)}"
+        "?service.name=#{CGI.escape(config.service_name)}" \
+        "&service.environment=#{CGI.escape(config.environment || '')}"
     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/fields.rb

@@ -0,0 +1,88 @@
+# 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, optional: true
+  #   end
+  #
+  #   MyThing.new(name: 'AJ').to_h
+  #     # => { name: 'AJ' }
+  #   MyThing.new().empty?
+  #     # => true
+  module Fields
+    module InstanceMethods
+      def initialize(**attrs)
+        attrs.each do |key, value|
+          self.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
+        end
+
+        false
+      end
+
+      def to_h
+        self.class.fields.each_with_object({}) do |key, fields|
+          fields[key] = send(key)
+        end
+      end
+
+      private
+
+      def optionals
+        self.class.optionals
+      end
+    end
+
+    module ClassMethods
+      def field(key, optional: false)
+        attr_accessor(key)
+
+        fields.push(key)
+        optionals.push(key) if optional
+      end
+
+      attr_reader :fields, :optionals
+    end
+
+    def self.included(cls)
+      cls.extend(ClassMethods)
+      cls.include(InstanceMethods)
+
+      cls.instance_variable_set(:@fields, [])
+      cls.instance_variable_set(:@optionals, [])
+    end
+  end
+end

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/metadata/cloud_info.rb

@@ -57,9 +57,9 @@ module ElasticAPM
         when "gcp"
           fetch_gcp
         when "azure"
-          fetch_azure
+          fetch_azure || read_azure_app_services
         when "auto"
-          fetch_aws || fetch_gcp || fetch_azure
+          fetch_aws || fetch_gcp || fetch_azure || read_azure_app_services
         when "none"
           nil
         else
@@ -76,7 +76,7 @@ module ElasticAPM
         resp = @client.get(AWS_URI)
 
         return unless resp.status == 200
-        return unless (metadata = JSON.parse(resp.body))
+        return unless (metadata = JSON.parse(resp.body.to_s))
 
         self.provider = "aws"
         self.account_id = metadata["accountId"]
@@ -92,7 +92,7 @@ module ElasticAPM
         resp = @client.headers("Metadata-Flavor" => "Google").get(GCP_URI)
 
         return unless resp.status == 200
-        return unless (metadata = JSON.parse(resp.body))
+        return unless (metadata = JSON.parse(resp.body.to_s))
 
         zone = metadata["instance"]["zone"]&.split("/")&.at(-1)
 
@@ -112,7 +112,7 @@ module ElasticAPM
         resp = @client.headers("Metadata" => "true").get(AZURE_URI)
 
         return unless resp.status == 200
-        return unless (metadata = JSON.parse(resp.body))
+        return unless (metadata = JSON.parse(resp.body.to_s))
 
         self.provider = 'azure'
         self.account_id = metadata["subscriptionId"]
@@ -125,6 +125,33 @@ module ElasticAPM
       rescue HTTP::TimeoutError, HTTP::ConnectionError
         nil
       end
+
+      def read_azure_app_services
+        owner_name, instance_id, site_name, resource_group =
+          ENV.values_at(
+            'WEBSITE_OWNER_NAME',
+            'WEBSITE_INSTANCE_ID',
+            'WEBSITE_SITE_NAME',
+            'WEBSITE_RESOURCE_GROUP'
+          )
+
+        return unless owner_name && instance_id && site_name && resource_group
+
+        self.provider = 'azure'
+        self.instance_id = instance_id
+        self.instance_name = site_name
+        self.project_name = resource_group
+        self.account_id, self.region = parse_azure_app_services_owner_name(owner_name)
+      end
+
+      private
+
+      def parse_azure_app_services_owner_name(owner_name)
+        id, rest = owner_name.split('+')
+        *_, region = rest.split('-')
+        region.gsub!(/webspace.*$/, '')
+        [id, region]
+      end
     end
   end
 end

data/lib/elastic_apm/metadata/system_info.rb

@@ -24,7 +24,8 @@ module ElasticAPM
       def initialize(config)
         @config = config
 
-        @hostname = @config.hostname || self.class.system_hostname
+        @configured_hostname = @config.hostname
+        @detected_hostname = detect_hostname
         @architecture = gem_platform.cpu
         @platform = gem_platform.os
 
@@ -33,14 +34,23 @@ module ElasticAPM
         @kubernetes = container_info.kubernetes
       end
 
-      attr_reader :hostname, :architecture, :platform, :container, :kubernetes
+      attr_reader(
+        :detected_hostname,
+        :configured_hostname,
+        :architecture,
+        :platform,
+        :container,
+        :kubernetes
+      )
 
       def gem_platform
         @gem_platform ||= Gem::Platform.local
       end
 
-      def self.system_hostname
-        @system_hostname ||= `hostname`.chomp
+      private
+
+      def detect_hostname
+        `hostname`.chomp
       end
     end
   end

data/lib/elastic_apm/metrics/cpu_mem_set.rb

@@ -62,8 +62,8 @@ module ElasticAPM
       def initialize(config)
         super
 
-        @sampler = sampler_for_platform(Metrics.platform)
-        read! # set @previous on boot
+        @sampler = sampler_for_os(Metrics.os)
+        read! # set initial values to calculate deltas from
       end
 
       attr_reader :config
@@ -75,11 +75,11 @@ module ElasticAPM
 
       private
 
-      def sampler_for_platform(platform)
-        case platform
-        when :linux then Linux.new
+      def sampler_for_os(os)
+        case os
+        when /^linux/ then Linux.new
         else
-          warn "Disabling system metrics, unsupported platform '#{platform}'"
+          warn "Disabling system metrics, unsupported host OS '#{os}'"
           disable!
           nil
         end

data/lib/elastic_apm/metrics/jvm_set.rb

@@ -0,0 +1,88 @@
+# 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
+
+require 'java'
+
+module ElasticAPM
+  module Metrics
+    # @api private
+    class JVMSet < Set
+      include Logging
+
+      MAX_TRIES = 3
+
+      def initialize(*args)
+        super
+
+        @error_count = 0
+      end
+
+      def collect
+        read!
+        super
+      end
+
+      def read!
+        return if disabled?
+
+        heap = platform_bean.get_heap_memory_usage
+        non_heap = platform_bean.get_non_heap_memory_usage
+
+        gauge(:"jvm.memory.heap.used").value = heap.get_used
+        gauge(:"jvm.memory.heap.committed").value = heap.get_committed
+        gauge(:"jvm.memory.heap.max").value = heap.get_max
+
+        gauge(:"jvm.memory.non_heap.used").value = non_heap.get_used
+        gauge(:"jvm.memory.non_heap.committed").value = non_heap.get_committed
+        gauge(:"jvm.memory.non_heap.max").value = non_heap.get_max
+
+        pool_beans.each do |bean|
+          next unless bean.type.name == "HEAP"
+
+          tags = { name: bean.get_name }
+
+          gauge(:"jvm.memory.heap.pool.used", tags: tags).value = bean.get_usage.get_used
+          gauge(:"jvm.memory.heap.pool.committed", tags: tags).value = bean.get_usage.get_committed
+          gauge(:"jvm.memory.heap.pool.max", tags: tags).value = bean.get_usage.get_max
+        end
+      rescue Exception => e
+        error("JVM metrics encountered error: %s", e)
+        debug("Backtrace:") { e.backtrace.join("\n") }
+
+        @error_count += 1
+        if @error_count >= MAX_TRIES
+          disable!
+          error("Disabling JVM metrics after #{MAX_TRIES} errors", e)
+        end
+      end
+
+      private
+
+      def platform_bean
+        @platform_bean ||= java.lang.management.ManagementFactory.getPlatformMXBean(
+          java.lang.management.MemoryMXBean.java_class
+        )
+      end
+
+      def pool_beans
+        @pool_beans ||= java.lang.management.ManagementFactory.getMemoryPoolMXBeans()
+      end
+    end
+  end
+end