elastic-apm 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 556f800e5882b54fe89a4249a6ca5ce98bdfe04b9148f813b75ff17087834c70
-  data.tar.gz: 073241c2a7c78fbebd32434791339a321548e12de242f72598bc11c9bda833b2
+  metadata.gz: d759346f9597d0a9b179ca5b0f4b888c6b95b0f3b36efa26c568c423d82a6701
+  data.tar.gz: 1a9a46998c62b9f5d337cf4371f8472c5e337f1fb75a4094f3bd6347e4e9d537
 SHA512:
-  metadata.gz: b53f5c630ce8313593d4ecb0485d48bd3d552e672217409ce2cef9366aa06f881e633108c421d670b77df050fb2069eab09cb5b297a89a977ba0a7fcbe22b5e1
-  data.tar.gz: 7216c6d7628565b4e7295267ebba268461d693edecc5806fd83a92e9d2917aaf77ee075c0bcca20e0f67fdd9a90b3068d4fdabe5ddebbaa2a50353fd0a102169
+  metadata.gz: a969fa9e0929166458d40d775d8577d0579a193f5d2b8fece6e26ddf3d15b8bdb8a5551efd7872d2a6e28a321dff77aadf433eccc4c707be0a70d560d947ccba
+  data.tar.gz: 2f849a3f13569328da9d6726a89ee80e5c9d233c53e4191525e6b95daa64f8b92cba98b981c8591d4440f86f7509056d5a578b9a481a4d278a43c6a9923e70ad

data/.rubocop.yml

@@ -71,3 +71,6 @@ Layout/EmptyLineAfterGuardClause:
 
 Naming/MemoizedInstanceVariableName:
   Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 2.3.0 (2019-01-29)
+
+### Added
+
+- Support for Metrics ([#276](https://github.com/elastic/apm-agent-ruby/pull/276))
+
 ## 2.2.0 (2019-01-22)
 
 ### Added

data/docs/configuration.asciidoc

@@ -397,6 +397,23 @@ By default Elastic APM logs to `stdout` or uses `Rails.log` when used with Rails
 
 Use this to provide another logger. Expected to have the same API as Ruby's built-in `Logger`.
 
+[float]
+[[config-metrics-interval]]
+==== `metrics_interval`
+
+[options="header"]
+|============
+| Environment                    | `Config` key       | Default
+| `ELASTIC_APM_METRICS_INTERVAL` | `metrics_interval` | `'30s'`
+|============
+
+Specify the interval for reporting metrics to APM Server.
+The interval should be in seconds,
+or should include a time suffix.
+
+To disable metrics reporting,
+set the interval to `0`.
+
 [float]
 [[config-pool-size]]
 ==== `pool_size`

data/docs/index.asciidoc

@@ -18,6 +18,8 @@ include::./getting-started-rack.asciidoc[]
 
 include::./configuration.asciidoc[]
 
+include::./metrics.asciidoc[]
+
 include::./advanced.asciidoc[]
 
 include::./supported-technologies.asciidoc[]

data/docs/metrics.asciidoc

@@ -0,0 +1,72 @@
+ifdef::env-github[]
+NOTE: For the best reading experience,
+please view this documentation at https://www.elastic.co/guide/en/apm/agent/ruby[elastic.co]
+endif::[]
+
+[[metrics]]
+== Metrics
+
+The Ruby agent tracks various system and application metrics.
+These metrics will be sent regularly to the APM Server and from there to Elasticsearch.
+You can adjust the interval by setting <<config-metrics-interval,`metrics_interval`>>.
+
+The metrics will be stored in the `apm-*` index and have the `processor.event` property set to `metric`.
+
+**Note:** Metrics from the Ruby agent are Linux only for now.
+
+[float]
+[[metric-system.cpu.total.norm.pct]]
+=== `system.cpu.total.norm.pct`
+
+* *Type:* Float
+* *Format:* Percent
+
+The percentage of CPU time in states other than Idle and IOWait,
+normalised by the number of cores.
+
+[float]
+[[metric-system.memory.total]]
+=== `system.memory.total`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The total memory of the system in bytes.
+
+[float]
+[[metric-system.memory.actual.free]]
+=== `system.memory.actual.free`
+
+* *Type:* Long
+* *Format:* Bytes
+
+Free memory of the system in bytes.
+
+[float]
+[[metric-system.process.cpu.total.norm.pct]]
+=== `system.process.cpu.total.norm.pct`
+
+* *Type:* Float
+* *Format:* Percent
+
+The percentage of CPU time spent by the process since the last event.
+This value is normalized by the number of CPU cores and it ranges from 0 to 100%.
+
+[float]
+[[metric-system.process.memory.size]]
+=== `system.process.memory.size`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The total virtual memory the process has.
+
+[float]
+[[metric-system.process.memory.rss.bytes]]
+=== `system.process.memory.rss.bytes`
+
+* *Type:* Long
+* *Format:* Bytes
+
+The Resident Set Size,
+the amount of memory the process occupies in main memory (RAM).

data/lib/elastic_apm/agent.rb

@@ -6,6 +6,7 @@ require 'elastic_apm/stacktrace_builder'
 require 'elastic_apm/error'
 require 'elastic_apm/transport/base'
 require 'elastic_apm/spies'
+require 'elastic_apm/metrics'
 
 module ElasticAPM
   # rubocop:disable Metrics/ClassLength
@@ -55,18 +56,21 @@ module ElasticAPM
 
       @transport = Transport::Base.new(config)
       @instrumenter = Instrumenter.new(
-        config, stacktrace_builder: stacktrace_builder
+        config,
+        stacktrace_builder: stacktrace_builder
       ) { |event| enqueue event }
+      @metrics = Metrics.new(config) { |event| enqueue event }
     end
 
     attr_reader :config, :transport, :instrumenter,
-      :stacktrace_builder, :context_builder, :error_builder
+      :stacktrace_builder, :context_builder, :error_builder, :metrics
 
     def start
       info '[%s] Starting agent, reporting to %s', VERSION, config.server_url
 
       transport.start
       instrumenter.start
+      metrics.start
 
       config.enabled_spies.each do |lib|
         require "elastic_apm/spies/#{lib}"
@@ -80,6 +84,7 @@ module ElasticAPM
 
       instrumenter.stop
       transport.stop
+      metrics.stop
 
       self
     end

data/lib/elastic_apm/config.rb

@@ -40,6 +40,7 @@ module ElasticAPM
       instrumented_rake_tasks: [],
       log_level: Logger::INFO,
       log_path: nil,
+      metrics_interval: 30,
       pool_size: 1,
       source_lines_error_app_frames: 5,
       source_lines_error_library_frames: 0,
@@ -78,6 +79,7 @@ module ElasticAPM
         [:list, 'instrumented_rake_tasks'],
       'ELASTIC_APM_LOG_LEVEL' => [:int, 'log_level'],
       'ELASTIC_APM_LOG_PATH' => 'log_path',
+      'ELASTIC_APM_METRICS_INTERVAL' => [:int, 'metrics_interval'],
       'ELASTIC_APM_POOL_SIZE' => [:int, 'pool_size'],
       'ELASTIC_APM_SERVICE_NAME' => 'service_name',
       'ELASTIC_APM_SERVICE_VERSION' => 'service_version',
@@ -96,8 +98,14 @@ module ElasticAPM
       'ELASTIC_APM_VERIFY_SERVER_CERT' => [:bool, 'verify_server_cert']
     }.freeze
 
-    DURATION_KEYS = %i[api_request_time span_frames_min_duration].freeze
-    DURATION_DEFAULT_UNITS = { span_frames_min_duration: 'ms' }.freeze
+    DURATION_KEYS = %i[
+      api_request_time
+      span_frames_min_duration
+      metrics_interval
+    ].freeze
+    DURATION_DEFAULT_UNITS = { # default is 's'
+      span_frames_min_duration: 'ms'
+    }.freeze
 
     SIZE_KEYS = %i[api_request_size].freeze
     SIZE_DEFAULT_UNITS = { api_request_size: 'kb' }.freeze
@@ -146,6 +154,7 @@ module ElasticAPM
     attr_accessor :log_level
     attr_accessor :log_path
     attr_accessor :logger
+    attr_accessor :metrics_interval
     attr_accessor :pool_size
     attr_accessor :service_name
     attr_accessor :service_version
@@ -277,6 +286,10 @@ module ElasticAPM
       super
     end
 
+    def collect_metrics?
+      metrics_interval != 0
+    end
+
     private
 
     def assign(options)

data/lib/elastic_apm/error.rb

@@ -17,11 +17,12 @@ module ElasticAPM
       @context = Context.new
 
       @transaction_id = nil
+      @transaction = nil
       @parent_id = nil
     end
 
-    attr_accessor :id, :culprit, :exception, :log, :transaction_id, :context,
-      :parent_id, :trace_id
+    attr_accessor :id, :culprit, :exception, :log, :transaction_id,
+      :transaction, :context, :parent_id, :trace_id
     attr_reader :timestamp
   end
 end

data/lib/elastic_apm/error_builder.rb

@@ -16,7 +16,7 @@ module ElasticAPM
         add_stacktrace error, :exception, exception.backtrace
       end
 
-      add_transaction_id error
+      add_current_transaction_fields error
 
       if (transaction = ElasticAPM.current_transaction)
         error.context = transaction.context.dup
@@ -37,7 +37,7 @@ module ElasticAPM
         add_stacktrace error, :log, backtrace
       end
 
-      add_transaction_id error
+      add_current_transaction_fields error
 
       error
     end
@@ -59,9 +59,10 @@ module ElasticAPM
       error.culprit = stacktrace.frames.first.function
     end
 
-    def add_transaction_id(error)
+    def add_current_transaction_fields(error)
       return unless (transaction = ElasticAPM.current_transaction)
       error.transaction_id = transaction.id
+      error.transaction = { sampled: transaction.sampled? }
     end
   end
 end

data/lib/elastic_apm/metrics.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'elastic_apm/metricset'
+
+module ElasticAPM
+  # @api private
+  module Metrics
+    MUTEX = Mutex.new
+
+    def self.new(config, &block)
+      Collector.new(config, &block)
+    end
+
+    def self.platform
+      @platform ||= Gem::Platform.local.os.to_sym
+    end
+
+    # @api private
+    class Collector
+      include Logging
+
+      TIMEOUT_INTERVAL = 5 # seconds
+
+      def initialize(config, tags: nil, &block)
+        @config = config
+        @tags = tags
+        @samplers = [CpuMem].map { |kls| kls.new(config) }
+        @callback = block
+      end
+
+      attr_reader :config, :samplers, :callback, :tags
+
+      # rubocop:disable Metrics/MethodLength
+      def start
+        return unless config.collect_metrics?
+
+        @timer_task = Concurrent::TimerTask.execute(
+          run_now: true,
+          execution_interval: config.metrics_interval,
+          timeout_interval: TIMEOUT_INTERVAL
+        ) do
+          begin
+            collect_and_send
+            true
+          rescue StandardError => e
+            error 'Error while collecting metrics: %e', e.inspect
+            debug { e.backtrace.join("\n") }
+            false
+          end
+        end
+
+        @running = true
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def stop
+        @timer_task.shutdown
+        @running = false
+      end
+
+      def running?
+        !!@running
+      end
+
+      def collect_and_send
+        metricset = Metricset.new(tags: tags, **collect)
+        return if metricset.empty?
+
+        callback.call(metricset)
+      end
+
+      def collect
+        MUTEX.synchronize do
+          samplers.each_with_object({}) do |sampler, samples|
+            next unless (sample = sampler.collect)
+            samples.merge!(sample)
+          end
+        end
+      end
+    end
+  end
+end
+
+require 'elastic_apm/metrics/cpu_mem'

data/lib/elastic_apm/metrics/cpu_mem.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Metrics
+    # @api private
+    class CpuMem
+      include Logging
+
+      # @api private
+      class Sample
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(
+          system_cpu_total:,
+          system_cpu_usage:,
+          system_memory_total:,
+          system_memory_free:,
+          process_cpu_usage:,
+          process_memory_size:,
+          process_memory_rss:,
+          page_size:
+        )
+          @system_cpu_total = system_cpu_total
+          @system_cpu_usage = system_cpu_usage
+          @system_memory_total = system_memory_total
+          @system_memory_free = system_memory_free
+          @process_cpu_usage = process_cpu_usage
+          @process_memory_size = process_memory_size
+          @process_memory_rss = process_memory_rss
+          @page_size = page_size
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        attr_accessor :system_cpu_total, :system_cpu_usage,
+          :system_memory_total, :system_memory_free, :process_cpu_usage,
+          :process_memory_size, :process_memory_rss, :page_size
+
+        def delta(previous)
+          dup.tap do |sample|
+            sample.system_cpu_total =
+              system_cpu_total - previous.system_cpu_total
+            sample.system_cpu_usage =
+              system_cpu_usage - previous.system_cpu_usage
+            sample.process_cpu_usage =
+              process_cpu_usage - previous.process_cpu_usage
+          end
+        end
+      end
+
+      def initialize(config)
+        @config = config
+        @sampler = sampler_for_platform(Metrics.platform)
+      end
+
+      attr_reader :config, :sampler
+
+      def sample
+        @sampler.sample
+      end
+
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def collect
+        return unless sampler
+
+        current = sample
+
+        unless @previous
+          @previous = current
+          return
+        end
+
+        delta = current.delta(@previous)
+
+        cpu_usage_pct = delta.system_cpu_usage.to_f / delta.system_cpu_total
+        cpu_process_pct = delta.process_cpu_usage.to_f / delta.system_cpu_total
+
+        @previous = current
+
+        {
+          'system.cpu.total.norm.pct': cpu_usage_pct,
+          'system.memory.actual.free': current.system_memory_free,
+          'system.memory.total': current.system_memory_total,
+          'system.process.cpu.total.norm.pct': cpu_process_pct,
+          'system.process.memory.size': current.process_memory_size,
+          'system.process.memory.rss.bytes':
+            current.process_memory_rss * current.page_size
+        }
+      end
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+      private
+
+      def sampler_for_platform(platform)
+        case platform
+        when :linux then Linux.new
+        else
+          warn "Unsupported platform '#{platform}' - Disabling metrics"
+          @disabled = true
+          nil
+        end
+      end
+
+      # @api private
+      class Linux
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def sample
+          proc_stat = ProcStat.new.read!
+          proc_self_stat = ProcSelfStat.new.read!
+          meminfo = Meminfo.new.read!
+
+          Sample.new(
+            system_cpu_total: proc_stat.total,
+            system_cpu_usage: proc_stat.usage,
+            system_memory_total: meminfo.total,
+            system_memory_free: meminfo.available,
+            process_cpu_usage: proc_self_stat.total,
+            process_memory_size: proc_self_stat.vsize,
+            process_memory_rss: proc_self_stat.rss,
+            page_size: meminfo.page_size
+          )
+        end
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+        # @api private
+        class ProcStat
+          attr_reader :total, :usage
+
+          # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+          def read!
+            stat =
+              IO.readlines('/proc/stat')
+                .lazy
+                .find { |sp| sp.start_with?('cpu ') }
+                .split
+                .map(&:to_i)[1..-1]
+
+            user, nice, system, idle, iowait, irq, softirq, steal,
+              _guest, _guest_nice = stat
+
+            @total =
+              user +
+              nice +
+              system +
+              idle +
+              iowait +
+              irq +
+              softirq +
+              steal
+
+            @usage = @total - (idle + iowait)
+
+            self
+          end
+          # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+        end
+
+        UTIME_POS = 13
+        STIME_POS = 14
+        VSIZE_POS = 22
+        RSS_POS = 23
+
+        # @api private
+        class ProcSelfStat
+          attr_reader :total, :vsize, :rss
+
+          def read!
+            stat =
+              IO.readlines('/proc/self/stat')
+                .lazy
+                .first
+                .split
+                .map(&:to_i)
+
+            @total = stat[UTIME_POS] + stat[STIME_POS]
+            @vsize = stat[VSIZE_POS]
+            @rss = stat[RSS_POS]
+
+            self
+          end
+        end
+
+        # @api private
+        class Meminfo
+          attr_reader :total, :available, :page_size
+
+          # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+          def read!
+            # rubocop:disable Style/RescueModifier
+            @page_size = `getconf PAGESIZE`.chomp.to_i rescue 4096
+            # rubocop:enable Style/RescueModifier
+
+            info =
+              IO.readlines('/proc/meminfo')
+                .lazy
+                .each_with_object({}) do |line, hsh|
+                  if line.start_with?('MemTotal:')
+                    hsh[:total] = line.split[1].to_i * 1024
+                  elsif line.start_with?('MemAvailable:')
+                    hsh[:available] = line.split[1].to_i * 1024
+                  end
+
+                  break hsh if hsh.length == 2
+                end
+
+            @total = info[:total]
+            @available = info[:available]
+
+            self
+          end
+          # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/metricset.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  # @api private
+  class Metricset
+    def initialize(timestamp: Util.micros, tags: nil, **samples)
+      @timestamp = timestamp
+      @tags = tags
+      @samples = samples
+    end
+
+    attr_accessor :timestamp
+    attr_reader :samples, :tags
+
+    def empty?
+      samples.empty?
+    end
+  end
+end

data/lib/elastic_apm/transport/serializers.rb

@@ -43,9 +43,10 @@ module ElasticAPM
           @span = Serializers::SpanSerializer.new(config)
           @error = Serializers::ErrorSerializer.new(config)
           @metadata = Serializers::MetadataSerializer.new(config)
+          @metricset = Serializers::MetricsetSerializer.new(config)
         end
 
-        attr_reader :transaction, :span, :error, :metadata
+        attr_reader :transaction, :span, :error, :metadata, :metricset
 
         # rubocop:disable Metrics/MethodLength
         def serialize(resource)
@@ -56,6 +57,8 @@ module ElasticAPM
             span.build(resource)
           when Error
             error.build(resource)
+          when Metricset
+            metricset.build(resource)
           when Metadata
             metadata.build(resource)
           else
@@ -73,7 +76,8 @@ module ElasticAPM
 end
 
 require 'elastic_apm/transport/serializers/context_serializer'
+require 'elastic_apm/transport/serializers/transaction_serializer'
+require 'elastic_apm/transport/serializers/span_serializer'
 require 'elastic_apm/transport/serializers/error_serializer'
+require 'elastic_apm/transport/serializers/metricset_serializer'
 require 'elastic_apm/transport/serializers/metadata_serializer'
-require 'elastic_apm/transport/serializers/span_serializer'
-require 'elastic_apm/transport/serializers/transaction_serializer'

data/lib/elastic_apm/transport/serializers/error_serializer.rb

@@ -14,6 +14,7 @@ module ElasticAPM
           base = {
             id: error.id,
             transaction_id: error.transaction_id,
+            transaction: error.transaction,
             trace_id: error.trace_id,
             parent_id: error.parent_id,
 

data/lib/elastic_apm/transport/serializers/metricset_serializer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ElasticAPM
+  module Transport
+    module Serializers
+      # @api private
+      class MetricsetSerializer < Serializer
+        def build(metricset)
+          {
+            metricset: {
+              timestamp: metricset.timestamp.to_i,
+              tags: keyword_object(metricset.tags),
+              samples: build_samples(metricset.samples)
+            }
+          }
+        end
+
+        private
+
+        def build_samples(samples)
+          samples.each_with_object({}) do |(key, value), hsh|
+            hsh[key] = { value: value }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elastic_apm/util.rb

@@ -14,7 +14,7 @@ module ElasticAPM
 
     def self.git_sha
       sha = `git rev-parse --verify HEAD 2>&1`.chomp
-      $? && $?.success? ? sha : nil # rubocop:disable Style/SpecialGlobalVars
+      $? && $?.success? ? sha : nil
     end
 
     def self.hex_to_bits(str)

data/lib/elastic_apm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ElasticAPM
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-apm
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -75,6 +75,7 @@ files:
 - docs/getting-started-rails.asciidoc
 - docs/index.asciidoc
 - docs/introduction.asciidoc
+- docs/metrics.asciidoc
 - docs/opentracing.asciidoc
 - docs/supported-technologies.asciidoc
 - elastic-apm.gemspec
@@ -103,6 +104,9 @@ files:
 - lib/elastic_apm/metadata/process_info.rb
 - lib/elastic_apm/metadata/service_info.rb
 - lib/elastic_apm/metadata/system_info.rb
+- lib/elastic_apm/metrics.rb
+- lib/elastic_apm/metrics/cpu_mem.rb
+- lib/elastic_apm/metricset.rb
 - lib/elastic_apm/middleware.rb
 - lib/elastic_apm/naively_hashable.rb
 - lib/elastic_apm/normalizers.rb
@@ -146,6 +150,7 @@ files:
 - lib/elastic_apm/transport/serializers/context_serializer.rb
 - lib/elastic_apm/transport/serializers/error_serializer.rb
 - lib/elastic_apm/transport/serializers/metadata_serializer.rb
+- lib/elastic_apm/transport/serializers/metricset_serializer.rb
 - lib/elastic_apm/transport/serializers/span_serializer.rb
 - lib/elastic_apm/transport/serializers/transaction_serializer.rb
 - lib/elastic_apm/transport/worker.rb