frankenstein 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a01513fb86029eadfe956a0037537f9603ae33263f831369e9680512dd4b857
-  data.tar.gz: 3a3fdef8e9717a6811ea9aabc80d04fbc2aefadd08fac7dc42589ccdcfa71032
+  metadata.gz: f39ba456b50f9441b4d32af514e3715fbf09cfb3b5d356edf6aa4efebaa5ae8d
+  data.tar.gz: 85fba7233f645d11051162b76e46da7e867f15e0644ed916415074f0b6e76b63
 SHA512:
-  metadata.gz: df1d09b97e4c039e57b6d9a4f54d8cdffda97e8befeb2a2f94ae2efd4f5e71ef31997cb848bf47542a76264b53766fe0ec9121d538f9a205ec0af50cfc39cd63
-  data.tar.gz: 5b0d329e0c17aeb4d4ffe3561a24f7af1890bc833129b3236990981c682c45495e2be2f555e6b8eb15fb96f06cc958c9e422e5ad7294a16c2f849c8b98f45fa8
+  metadata.gz: 498ee7d399b04cecccf7ca01653de4fdc8cd6d375467fd1cbc574bd859196cc351236c659a79be5358fdeba59c7c21e7378a587933d17a24b01410ba90312fdf
+  data.tar.gz: dd17eb87a8ae2a09e7d5679cea4476faf3294c9329094eeb8b48fe57d24bb0740de1722828477155195cdc7a00f34dc753fad340bee288c058c80a5f6498f1ed

data/.travis.yml

@@ -3,8 +3,9 @@ sudo: false
 cache: bundler
 
 rvm:
-  - 2.4.1
-  - 2.3.4
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
 
 gemfile:
   - Gemfile

data/lib/frankenstein/collected_metric.rb

@@ -67,7 +67,7 @@ module Frankenstein
     #
     # @param type [Symbol] what type of metric you're returning.  It's uncommon
     #   to want anything other than `:gauge` here (the default), because
-    #   when you're collecting external data it's uncommon to be able to
+    #   when you're collecting external data it's unlikely you'll be able to
     #   trust that your external data source will behave like a proper
     #   counter (or histogram or summary), but if you want the flexibility,
     #   it's there for you.  If you do decide to try your hand at collecting

data/lib/frankenstein/process_metrics.rb

@@ -0,0 +1,70 @@
+require 'frankenstein/collected_metric'
+require 'etc'
+
+module Frankenstein
+  # Allow registration of metrics for Ruby GC statistics.
+  #
+  module ProcessMetrics
+    # Register generic process metrics.
+    #
+    # Generates collected metric objects for all of the [recommended process
+    # metrics](https://prometheus.io/docs/instrumenting/writing_clientlibs/#process-metrics)
+    # that can be reasonably obtained using Ruby on the platform that the process
+    # is running on.
+    #
+    # @param registry [Prometheus::Client::Registry] specify the metrics
+    #    registry in which to register the GC-related metrics.
+    #
+    # @param logger [Logger] where to log any problems which some sort of
+    #
+    def self.register(registry = Prometheus::Client.registry, logger: Logger.new("/dev/null"))
+      registry.gauge(:process_start_time_seconds, "Start time of the process since unix epoch in seconds").set({}, Time.now.to_f)
+
+      page_size = Etc.sysconf(Etc::SC_PAGESIZE)
+      hz        = Etc.sysconf(Etc::SC_CLK_TCK)
+
+      stat_file = "/proc/#{Process.pid}/stat".freeze
+
+      if File.exist?(stat_file)
+        Frankenstein::CollectedMetric.new(:process_cpu_seconds_total, "Total user and system CPU time spent in seconds", registry: registry, logger: logger) do
+          stats = File.open(stat_file).read.split(" ")
+          { { mode: "user" } => stats[13].to_f / hz, { mode: "system" } => stats[14].to_f / hz }
+        end
+
+        Frankenstein::CollectedMetric.new(:process_virtual_memory_bytes, "Virtual memory size in bytes", registry: registry, logger: logger) do
+          stats = File.open(stat_file).read.split(" ")
+          { {} => stats[22].to_i }
+        end
+
+        Frankenstein::CollectedMetric.new(:process_resident_memory_bytes, "Resident memory size in bytes", registry: registry, logger: logger) do
+          stats = File.open(stat_file).read.split(" ")
+          { {} => stats[23].to_i * page_size }
+        end
+      end
+
+      fd_dir = "/proc/#{Process.pid}/fd".freeze
+
+      if File.exist?(fd_dir)
+        Frankenstein::CollectedMetric.new(:process_open_fds, "Number of open file descriptors", registry: registry, logger: logger) do
+          { {} => Dir["#{fd_dir}/*"].length }
+        end
+      end
+
+      if Process.respond_to?(:getrlimit)
+        Frankenstein::CollectedMetric.new(:process_max_fds, "Maximum number of open file descriptors", registry: registry, logger: logger) do
+          { {} => Process.getrlimit(:NOFILE).first }
+        end
+
+        Frankenstein::CollectedMetric.new(:process_virtual_memory_max_bytes, "Maximum amount of virtual memory available in bytes", registry: registry, logger: logger) do
+          { {} => Process.getrlimit(:AS).first }
+        end
+      end
+
+      if GC.respond_to?(:stat) && GC.stat[:heap_allocated_pages]
+        Frankenstein::CollectedMetric.new(:process_heap_bytes, "Process heap size in bytes", registry: registry, logger: logger) do
+          { {} => GC.stat[:heap_allocated_pages] * page_size }
+        end
+      end
+    end
+  end
+end

data/lib/frankenstein/ruby_gc_metrics.rb

@@ -0,0 +1,24 @@
+require 'frankenstein/collected_metric'
+
+module Frankenstein
+  # Allow registration of metrics for Ruby GC statistics.
+  #
+  module RubyGCMetrics
+    # Register Ruby GC metrics.
+    #
+    # For every statistic provided by the Ruby VM under the module method
+    # `GC.stat`, a metric is registered named `ruby_gc_<stat>`, which
+    # provides a dimensionless metric with the value of the statistic.
+    #
+    # @param registry [Prometheus::Client::Registry] specify the metrics
+    #    registry in which to register the GC-related metrics.
+    #
+    def self.register(registry = Prometheus::Client.registry)
+      GC.stat.each do |k, v|
+        Frankenstein::CollectedMetric.new(:"ruby_gc_#{k}", "Ruby GC parameter #{k}", registry: registry) do
+          { {} => GC.stat[k] }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frankenstein
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prometheus-client
@@ -228,7 +228,9 @@ files:
 - lib/frankenstein.rb
 - lib/frankenstein/collected_metric.rb
 - lib/frankenstein/error.rb
+- lib/frankenstein/process_metrics.rb
 - lib/frankenstein/request.rb
+- lib/frankenstein/ruby_gc_metrics.rb
 - lib/frankenstein/server.rb
 - lib/frankenstein/server/webrick_logger.rb
 homepage: https://github.com/discourse/frankenstein