elastic-apm 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81641cee86d90236fac69836ed6b6e4e858e0650d099c7cf0ab2fbc58e9d8550
-  data.tar.gz: a8f13b6c5b4b430c4cba21f92167b784634bc151ef802472e9a4fc1af6f95c1b
+  metadata.gz: bc66ce3466effa6740c0b8c9dbb0d74358b54d9039ceebe2938674170e68662b
+  data.tar.gz: d3288b6cf41bbe33fb6594789371d36fcb66ccc2b9ec9d8d2f6aed08f4d212f7
 SHA512:
-  metadata.gz: 3db0a577687ac11af79c29de68c3935cb0df9572bed2583c5d9666dd15aefabb97a0ab0a081b79fd41ee7e53e1e3319700d0ebd74a30883eaa55b45684ea9862
-  data.tar.gz: a191284ee54fd8be1511927ff1af81f13bb129c6f282d2078099cf8a79fe124ec5f995243260d66a23920f6d82fdb1955614cdbe260b58413bb9863ee0226a3a
+  metadata.gz: 6fcdb201cf7b1824776fffff92e8fc538613928b4ae977f694f67239c15a9e10f14a1ceb4669248eb658c4b2fd439398d0badd231292367e8371655cd2bae738
+  data.tar.gz: 72fdb5641db042a4c7ccd6fcdfc97d43949d1f8ed0b561029e6beffa640262d04c2a639f5f75944b944c1283dae8b2c929f0a3aae14e7e2547af3e942e4307a8

data/CHANGELOG.asciidoc

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

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

@@ -28,6 +28,10 @@ module ElasticAPM
       @platform ||= Gem::Platform.local.os.to_sym
     end
 
+    def self.os
+      @platform ||= RbConfig::CONFIG.fetch('host_os', 'unknown').to_sym
+    end
+
     # @api private
     class Registry
       include Logging
@@ -37,6 +41,7 @@ module ElasticAPM
       def initialize(config, &block)
         @config = config
         @callback = block
+        @sets = nil
       end
 
       attr_reader :config, :sets, :callback
@@ -51,14 +56,22 @@ module ElasticAPM
 
         # Only set the @sets once, in case we stop
         # and start again.
-        @sets ||= {
-          system: CpuMemSet,
-          vm: VMSet,
-          breakdown: BreakdownSet,
-          transaction: TransactionSet
-        }.each_with_object({}) do |(key, kls), sets|
-          debug "Adding metrics collector '#{kls}'"
-          sets[key] = kls.new(config)
+        if @sets.nil?
+          sets = {
+            system: CpuMemSet,
+            vm: VMSet,
+            breakdown: BreakdownSet,
+            transaction: TransactionSet
+          }
+          if defined?(JVMSet)
+            debug "Enabling JVM metrics collection"
+            sets[:jvm] = JVMSet
+          end
+
+          @sets = sets.each_with_object({}) do |(key, kls), _sets_|
+            debug "Adding metrics collector '#{kls}'"
+            _sets_[key] = kls.new(config)
+          end
         end
 
         @timer_task = Concurrent::TimerTask.execute(
@@ -136,6 +149,7 @@ require 'elastic_apm/metrics/set'
 
 require 'elastic_apm/metrics/cpu_mem_set'
 require 'elastic_apm/metrics/vm_set'
+require 'elastic_apm/metrics/jvm_set' if defined?(JRUBY_VERSION)
 require 'elastic_apm/metrics/span_scoped_set'
 require 'elastic_apm/metrics/transaction_set'
 require 'elastic_apm/metrics/breakdown_set'

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
+      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

data/lib/elastic_apm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Mikkel Malmberg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-07-26 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: []
@@ -165,6 +165,7 @@ files:
 - lib/elastic_apm/metrics.rb
 - lib/elastic_apm/metrics/breakdown_set.rb
 - lib/elastic_apm/metrics/cpu_mem_set.rb
+- lib/elastic_apm/metrics/jvm_set.rb
 - lib/elastic_apm/metrics/metric.rb
 - lib/elastic_apm/metrics/set.rb
 - lib/elastic_apm/metrics/span_scoped_set.rb
@@ -257,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
@@ -272,8 +273,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: The official Elastic APM agent for Ruby
 test_files: []