influxdb-process 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1392cd9aa1f34ccf439ff3be4ff7e353b0a8a177
-  data.tar.gz: 455bb5e9016eb0676137b946b7c1460a4a2a3a9a
+SHA256:
+  metadata.gz: 76cf75aea6c095da14dea5172b6dc6215ecbae72f474e78c9c7ceefea6df7f94
+  data.tar.gz: 3328ebb06483a440173a27ae325006a25bfa83ff39e8b3d4fa41c9a39079dc72
 SHA512:
-  metadata.gz: d00fe0f8b62f6f674f47d6ab2d4eea9dce08233a826480df24e796be9e1ffb889f2023ad8270db185d99febd26fd8ba745aa76d472ec199a4172be6fee0330a1
-  data.tar.gz: 0d355f43aaf1344a266ed51c8f2da64eecb205d389588d8a0b9a1d96f40c1079f80f572301681ca152f0fca30b82211eaddf390198ca8f26d52afcef0349b243
+  metadata.gz: ef07b2213d9bf9c69e469c287d2bf0869b8254e697cf994265c67ce81e2e97d961b76d6c94a5a5476f6ad156421fcb8e4b78eed77a982c443ae73fbdde0d59e8
+  data.tar.gz: 04d7c58cd6e7b70ff61f1b209a16395d3ff84614ffa825e90d77444d4c24b201910e2f6009fdb24a8f7855bc3bbdd70433e93e6e28bea6fd69fcff90bc87c86e

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5

data/Makefile

@@ -1,2 +1,5 @@
+test:
+	bundle exec rake
+
 points:
-	bundle exec ruby test/process.rb
+	bundle exec ruby misc/process.rb

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/influxdb-process.svg)](https://badge.fury.io/rb/influxdb-process)
+[![Build Status](https://travis-ci.org/vassilevsky/influxdb-process.svg?branch=master)](https://travis-ci.org/vassilevsky/influxdb-process)
+
 # InfluxDB::Process
 
 Gathers metrics from the Ruby process it is executed in and sends them to an InfluxDB database.
@@ -28,22 +31,37 @@ Let's say you have the client in the `influxdb` variable, as it says.
 Add this to any place in your Ruby program:
 
 ```ruby
-InfluxDB::Process::Instrumentation.new(influxdb)
+InfluxDB::Process::Instrumentation.new(influxdb).start
 ```
 
 When you deploy this, the process where this code is executed will create a new thread.
 It will periodically collect process metrics and send them to InfluxDB via the provided client.
 
-By default, metrics will be written to the `process_metrics` series every *10* seconds.
-You can set your own series name and interval via additional keyword arguments:
+Alternatively, you can instrument whenever you want (after each request / job / batch):
+
+```ruby
+# in an initializer, once
+p = InfluxDB::Process::Instrumentation.new(influxdb)
+
+# later, in an appropriate place, as many times as needed
+p.instrument
+```
+
+You can pass additional options to customize the behavior of this gem. Here they are (with default values):
 
 ```ruby
-InfluxDB::Process::Instrumentation.new(influxdb, series: 'ruby_stats', interval: 42)
+InfluxDB::Process::Instrumentation.new(
+  influxdb,
+  memory_series: 'process_memory',
+  object_series: 'process_objects',
+  interval: 10, # seconds
+  process: $PROGRAM_NAME
+)
 ```
 
 Metrics will be tagged with process name.
 By default, `$0`/`$PROGRAM_NAME` will be used.
-You can set your own process name via an additional keyword argument:
+You can set your own process name via an additional keyword argument in the constructor. For example:
 
 ```ruby
 InfluxDB::Process::Instrumentation.new(influxdb, process: 'report_generator')
@@ -55,11 +73,23 @@ You can also set the `INFLUXDB_PROCESS_NAME` environment variable:
 
 It will take precedence over the keyword argument.
 
+## Limitations
+
+System memory metrics (total, resident, shared memory used by the process as seen from the OS) are read
+for the `/proc` filesystem. They are not reported on systems where it is not available.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+How to test this gem:
+* Install and run InfluxDB
+* Create a `test` database in it
+* Run `make`
+
+It will generate metrics and push them to the `test` database.
+
 To install this gem onto your local machine, run `bundle exec rake install`.
 To release a new version:
 * Update the version number in `version.rb`

data/Rakefile

@@ -1,2 +1,5 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
 task :default => :spec

data/influxdb-process.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/influxdb/process.rb

@@ -1,18 +1,105 @@
+require "objspace"
+
 require "influxdb"
 require "influxdb/process/version"
 
 module InfluxDB
   module Process
     class Instrumentation
-      def initialize(influxdb, series: 'process_metrics', interval: 10, process: nil)
+      def initialize(influxdb, memory_series: nil, object_series: nil, interval: nil, process: nil)
+        @influxdb = influxdb
+        @memory_series = memory_series || 'process_memory'
+        @object_series = object_series || 'process_objects'
+        @interval = interval || 10
         @process = ENV['INFLUXDB_PROCESS_NAME'] || process || $PROGRAM_NAME
 
+        @tags = {process: @process}
+
+        @pid = ::Process.pid
+        @system_memory_file = "/proc/#{@pid}/statm"
+        @can_read_system_memory = File.exist?(@system_memory_file)
+        @page_size = `getconf PAGESIZE`.to_i rescue 4096
+
+        @memory = {}
+        @objects = {}
+      end
+
+      def instrument
+        update_memory
+        update_objects
+
+        @influxdb.write_point(@memory_series, tags: @tags, values: @memory)
+        @influxdb.write_point(@object_series, tags: @tags, values: @objects)
+      end
+
+      def start
         Thread.new do
           loop do
-            influxdb.write_point(series, tags: {process: @process}, values: GC.stat)
-            sleep(interval)
+            instrument
+            sleep(@interval)
+          end
+        end
+      end
+
+      private
+
+      TYPES = {
+        :T_OBJECT   => :simple_objects,
+        :T_CLASS    => :classes,
+        :T_MODULE   => :modules,
+        :T_FLOAT    => :floats,
+        :T_STRING   => :strings,
+        :T_REGEXP   => :regexes,
+        :T_ARRAY    => :arrays,
+        :T_HASH     => :hashes,
+        :T_STRUCT   => :structs,
+        :T_BIGNUM   => :bignums,
+        :T_FILE     => :file_descriptors,
+        :T_DATA     => :data_objects,
+        :T_MATCH    => :matches,
+        :T_COMPLEX  => :complex_numbers,
+        :T_RATIONAL => :rational_numbers,
+        :T_SYMBOL   => :symbols,
+        :T_IMEMO    => :memos,
+        :T_ICLASS   => :included_modules,
+        :T_ZOMBIE   => :zombies,
+        :T_NODE     => :ast_nodes,
+        :TOTAL      => :objects_total,
+        :FREE       => :free_object_slots,
+      }.freeze
+
+      def update_memory
+        ObjectSpace.count_objects_size.each do |type, size|
+          @memory[TYPES.fetch(type)] = size
+        end
+
+        if defined?(ActiveRecord::Base)
+          @memory[:ar_models] = ObjectSpace.memsize_of_all(ActiveRecord::Base)
+        end
+
+        if @can_read_system_memory
+          size, resident, share, text, _lib, data, _dt = File.read(@system_memory_file).split(' ').map do |pages|
+            pages.to_i * @page_size
           end
+
+          @memory[:total]    = size
+          @memory[:resident] = resident
+          @memory[:shared]   = share
+          @memory[:program]  = text
+          @memory[:data]     = data
+        end
+      end
+
+      def update_objects
+        ObjectSpace.count_objects.each do |type, count|
+          @objects[TYPES.fetch(type)] = count
         end
+
+        gc = GC.stat
+
+        @objects[:heap_available_slots] = gc[:heap_available_slots]
+        @objects[:heap_live_slots]      = gc[:heap_live_slots]
+        @objects[:heap_free_slots]      = gc[:heap_free_slots]
       end
     end
   end

data/lib/influxdb/process/version.rb

@@ -1,5 +1,5 @@
 module InfluxDB
   module Process
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/misc/process.rb

@@ -0,0 +1,17 @@
+require 'influxdb/process'
+
+influxdb = InfluxDB::Client.new('test')
+InfluxDB::Process::Instrumentation.new(influxdb, process: ENV['CUSTOM_PROCESS'])
+
+OBJECTS = []
+
+def create_many_objects
+  1000.times do
+    OBJECTS << ' ' * 1000
+  end
+end
+
+10.times do
+  create_many_objects
+  sleep 10
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-process
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ilya Vassilevsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-08 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - vassilevsky@gmail.com
@@ -60,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - Makefile
@@ -68,6 +84,7 @@ files:
 - influxdb-process.gemspec
 - lib/influxdb/process.rb
 - lib/influxdb/process/version.rb
+- misc/process.rb
 homepage: https://github.com/vassilevsky/influxdb-process
 licenses:
 - MIT
@@ -88,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Ruby process instrumentation to an InfluxDB database