instana 0.1.0 → 0.8.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f3d64bbe7f2c17bc7f3a8edef1fc213630e3222
-  data.tar.gz: 7e4893a2f0293c35d5266a1834bd87e4abb43fa4
+  metadata.gz: 5c7002d4134c228c245a364723eaca19b0f1f46c
+  data.tar.gz: 72ed46de39b20562edd678d53c41440807255bf9
 SHA512:
-  metadata.gz: 89f46b204de6db443381ef29c475d44ce0872f021ba7f33b539d4f1179aae398f3fa1c26dc44b9e815d4eb15addb650f86081a4fda91e12b9f9387aeb7fba3c7
-  data.tar.gz: 99cb68bf6a623b7ae0fda9347959d48609988d30dd4388d4245a489496123f78cb005c5d40ec2cf2fb515420d021724fe8ee24bebf5243d270c723212b34af90
+  metadata.gz: 6334386fa5f9088f80156783cee4c4c6416fa87bdc376b9cda97f275d19759a1f581501a81560f8647952e3cab6c58e9e8a82542222c9ff776f3b7dc0b5ee5c4
+  data.tar.gz: 81077cde159bfe0fac9a95ced6287d3e797a8dce11c360a711ccbe6039e81d756337b4092a169a9086eafa2920a4f2c615144639427fbbf864d88a33673c18b2

data/Gemfile

@@ -3,9 +3,8 @@ source 'https://rubygems.org'
 group :development, :test do
   gem 'rake'
   gem 'minitest'
-  gem 'minitest-reporters', '< 1.0.18'
+  gem 'minitest-reporters'
   gem 'minitest-debugger', :require => false
-  gem 'rack-test'
 end
 
 group :development do
@@ -20,5 +19,9 @@ group :development do
   end
 end
 
+gem 'get_process_mem'
+gem 'sys-proctable'
+gem 'timers'
+
 # instana.gemspec
 gemspec

data/README.md

@@ -1,12 +1,10 @@
 # Instana
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/instana`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The Instana gem provides Ruby metrics for [Instana](https://www.instana.com/).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+The gem is available on [Rubygems](https://rubygems.org/gems/instana).  To install, add this line to _the end_ of your application's Gemfile:
 
 ```ruby
 gem 'instana'
@@ -22,7 +20,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The instana gem is a zero configuration tool that will automatically collect key metrics from your Ruby processes.  Just install and go.
+
+## Configuration
+
+Although the gem has no configuration required for metrics, individual components can be disabled with a local config.
+
+To disable a single component in the gem, you can disable a single component with the following code:
+
+```Ruby
+::Instana.config[:metrics][:gc][:enabled] = false
+```
+Current components are `:gc`, `:memory` and `:thread`.
 
 ## Development
 
@@ -32,5 +41,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/instana.
+Bug reports and pull requests are welcome on GitHub at https://github.com/instana/ruby-sensor.
 

data/Rakefile

@@ -2,12 +2,17 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
+  t.verbose = false
+  t.warning = false
+  t.ruby_opts = []
+
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/**/*_test.rb']
 end
 
 task :environment do
+  ENV['INSTANA_GEM_DEV'] = 'true'
   Bundler.require(:default, :development)
 end
 

data/instana.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Peter Giacomo Lombardo"]
   spec.email         = ["pglombardo@gmail.com"]
 
-  spec.summary       = %q{Placeholder Ruby sensor gem for Instana}
-  spec.description   = %q{Will Provide Ruby sensor instrumentation for Instana.}
+  spec.summary       = %q{Ruby sensor for Instana}
+  spec.description   = %q{Provides Ruby sensor instrumentation for Instana.}
   spec.homepage      = "https://www.instana.com/"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
@@ -26,7 +26,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0'
+
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency('sys-proctable', '>= 1.1.3')
+  spec.add_runtime_dependency('get_process_mem', '>= 0.2.1')
+  spec.add_runtime_dependency('timers', '>= 4.1.0')
 end

data/lib/instana.rb

@@ -1,13 +1,46 @@
-require "instana/version"
-require "instana/agent"
+
 require 'logger'
+require "instana/version"
+require "instana/util"
 
 module Instana
   class << self
     attr_accessor :agent
+    attr_accessor :collectors
+    attr_accessor :config
     attr_accessor :logger
+    attr_accessor :pid
+
+    ##
+    # start
+    #
+    # Initialize the Instana language agent
+    #
+    def start
+      Instana.agent = Instana::Agent.new
+      Instana.collectors = []
+      Instana.logger = Logger.new(STDOUT)
+      Instana.logger.info "Stan is on the scene.  Starting Instana instrumentation."
+
+      # Store the current pid so we can detect a potential fork
+      # later on
+      Instana.pid = Process.pid
+    end
+
+    def pid_change?
+      @pid != Process.pid
+    end
   end
 end
 
-Instana.agent = Instana::Agent.new
-Instana.logger = Logger.new(STDOUT)
+require "instana/config"
+require "instana/agent"
+
+::Instana.start
+
+if ::Instana.agent.host_agent_ready?
+  ::Instana.agent.announce_sensor
+  require "instana/collectors"
+else
+  ::Instana.logger.info "Instana host agent not available.  Going to sit in a corner quietly."
+end

data/lib/instana/agent.rb

@@ -1,33 +1,185 @@
 require 'net/http'
 require 'uri'
 require 'json'
+require 'sys/proctable'
+include Sys
 
 module Instana
   class Agent
-    def initiialize
+    attr_accessor :last_entity_response
+
+    def initialize
+      # Host agent defaults.  Can be configured via Instana.config
       @request_timeout = 5000
       @host = '127.0.0.1'
       @port = 42699
       @server_header = 'Instana Agent'
-      @agentuuid = nil
+
+      # Snapshot data is collected once per process but resent
+      # every 10 minutes along side process metrics.
+      @snapshot = take_snapshot
+
+      # Set last snapshot to 10 minutes ago
+      # so we send a snapshot on first report
+      @last_snapshot = Time.now - 601
     end
 
+    ##
+    # take_snapshot
+    #
+    # Method to collect up process info for snapshots.  This
+    # is generally used once per process.
+    #
+    def take_snapshot
+      data = {}
+
+      data[:sensorVersion] = ::Instana::VERSION
+      data[:pid] = Process.pid
+      data[:ruby_version] = RUBY_VERSION
+
+      process = ProcTable.ps(Process.pid)
+      arguments = process.cmdline.split(' ')
+      data[:name] = arguments.shift
+      data[:exec_args] = arguments
+
+      # Since a snapshot is only taken on process boot,
+      # this is ok here.
+      data[:start_time] = Time.now.to_s
+
+      # Framework Detection
+      if defined?(::RailsLts::VERSION)
+        data[:framework] = "Rails on Rails LTS-#{::RailsLts::VERSION}"
+
+      elsif defined?(::Rails.version)
+        data[:framework] = "Ruby on Rails #{::Rails.version}"
+
+      elsif defined?(::Grape::VERSION)
+        data[:framework] = "Grape #{::Grape::VERSION}"
+
+      elsif defined?(::Padrino::VERSION)
+        data[:framework] = "Padrino #{::Padrino::VERSION}"
+
+      elsif defined?(::Sinatra::VERSION)
+        data[:framework] = "Sinatra #{::Sinatra::VERSION}"
+      end
+
+      data
+    rescue => e
+      ::Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+      ::Instana.logger.debug e.backtrace.join("\r\n")
+      return data
+    end
+
+    ##
+    # announce_sensor
+    #
+    # Collect process ID, name and arguments to notify
+    # the host agent.
+    #
     def announce_sensor
-      uri = URI.parse("http://#{@host}:#{@port}/com.instana.plugin.ruby.discovery")
-      payload = {}
-      payload[:pid] = Process.pid
-      payload[:name] = $0
+      process = ProcTable.ps(Process.pid)
+      announce_payload = {}
+      announce_payload[:pid] = Process.pid
 
+      arguments = process.cmdline.split(' ')
+      arguments.shift
+      announce_payload[:args] = arguments
+
+      path = 'com.instana.plugin.ruby.discovery'
+      uri = URI.parse("http://#{@host}:#{@port}/#{path}")
       req = Net::HTTP::Put.new(uri)
+
+      req['Accept'] = 'application/json'
+      req['Content-Type'] = 'application/json'
+      req.body = announce_payload.to_json
+
+      ::Instana.logger.debug "Announcing sensor to #{path} for pid #{Process.pid}: #{announce_payload.to_json}"
+
+      response = nil
+      Net::HTTP.start(uri.hostname, uri.port) do |http|
+        response = http.request(req)
+      end
+      Instana.logger.debug response.code
+    rescue => e
+      Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+      Instana.logger.debug e.backtrace.join("\r\n")
+    end
+
+    ##
+    # report_entity_data
+    #
+    # Method to report metrics data to the host agent.  Every 10 minutes, this
+    # method will also send a process snapshot data.
+    #
+    def report_entity_data(payload)
+      path = "com.instana.plugin.ruby.#{Process.pid}"
+      uri = URI.parse("http://#{@host}:#{@port}/#{path}")
+      req = Net::HTTP::Post.new(uri)
+
+      # Every 5 minutes, send snapshot data as well
+      if (Time.now - @last_snapshot) > 600
+        payload.merge!(@snapshot)
+        @last_snapshot = Time.now
+      end
+
       req['Accept'] = 'application/json'
       req['Content-Type'] = 'application/json'
       req.body = payload.to_json
 
+      #Instana.logger.debug "Posting metrics to #{path}: #{payload.to_json}"
+
       response = nil
       Net::HTTP.start(uri.hostname, uri.port) do |http|
         response = http.request(req)
       end
-      puts response
+
+      # If snapshot data is in the payload and last response
+      # was ok then delete the snapshot data.  Otherwise let it
+      # ride for another run.
+      if response.code.to_i == 200
+        @snapshot.each do |k, v|
+          payload.delete(k)
+        end
+      end
+      Instana.logger.debug response.code unless response.code.to_i == 200
+      @last_entity_response = response.code.to_i
+    rescue => e
+      Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+      Instana.logger.debug e.backtrace.join("\r\n")
+    end
+
+    ##
+    # host_agent_ready?
+    #
+    # Check that the host agent is available and can be contacted.
+    #
+    def host_agent_ready?
+      uri = URI.parse("http://#{@host}:#{@port}/")
+      req = Net::HTTP::Get.new(uri)
+
+      req['Accept'] = 'application/json'
+      req['Content-Type'] = 'application/json'
+
+      ::Instana.logger.debug "Checking agent availability...."
+
+      response = nil
+      Net::HTTP.start(uri.hostname, uri.port) do |http|
+        response = http.request(req)
+      end
+
+      if response.code.to_i != 200
+        Instana.logger.debug "Host agent returned #{response.code}"
+        false
+      else
+        true
+      end
+    rescue Errno::ECONNREFUSED => e
+      Instana.logger.debug "Agent not responding: #{e.inspect}"
+      return false
+    rescue => e
+      Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+      Instana.logger.debug e.backtrace.join("\r\n")
+      return false
     end
   end
 end

data/lib/instana/collectors.rb

@@ -0,0 +1,47 @@
+require 'timers'
+require 'instana/collectors/gc'
+require 'instana/collectors/memory'
+require 'instana/collectors/thread'
+
+module Instana
+  module Collector
+    class << self
+      attr_accessor :interval
+    end
+  end
+end
+
+if ENV.key?('INSTANA_GEM_DEV')
+  ::Instana::Collector.interval = 3
+else
+  ::Instana::Collector.interval = 1
+end
+
+::Thread.new do
+  timers = ::Timers::Group.new
+  payload = {}
+
+  timers.every(::Instana::Collector.interval) {
+
+    # Check if we forked (unicorn, puma) and
+    # if so, re-announce the process sensor
+    if ::Instana.pid_change?
+      ::Instana.logger.debug "Detected a fork (old: #{::Instana.pid} new: #{::Process.pid}).  Re-announcing sensor."
+      ::Instana.pid = Process.pid
+      Instana.agent.announce_sensor
+    end
+
+    ::Instana.collectors.each do |c|
+      metrics = c.collect
+      if metrics
+        payload[c.payload_key] = metrics
+      else
+        payload.delete(c.payload_key)
+      end
+    end
+
+    # Report all the collected goodies
+    ::Instana.agent.report_entity_data(payload)
+  }
+  loop { timers.wait }
+end

data/lib/instana/collectors/gc.rb

@@ -0,0 +1,63 @@
+module Instana
+  module Collector
+    class GC
+      attr_accessor :payload_key
+
+      def initialize
+        @payload_key = :gc
+        @last_report = {}
+        @this_gc = {}
+        @last_major_count = 0
+        @last_minor_count = 0
+        ::GC::Profiler.enable
+      end
+
+      ##
+      # collect
+      #
+      # To collect garbage collector related metrics.
+      #
+      def collect
+        @this_gc.clear
+        stats = ::GC.stat
+
+        # Time spent in GC.  Report in milliseconds
+        @this_gc[:totalTime] = ::GC::Profiler.total_time * 1000
+        ::GC::Profiler.clear
+
+        # GC metrics only available on newer Ruby versions
+        if RUBY_VERSION >= '2.1'
+          # GC runs.  Calculate how many have occurred since the last call
+          @this_gc[:minorGcs]  = stats[:minor_gc_count] - @last_minor_count
+          @this_gc[:majorGcs]  = stats[:major_gc_count] - @last_major_count
+
+          # Store these counts so that we have something to compare to next
+          # time around.
+          @last_major_count = stats[:major_gc_count]
+          @last_minor_count = stats[:minor_gc_count]
+        end
+
+        # GC Heap
+        @this_gc[:heap_live] = stats[:heap_live_slot] || stats[:heap_live_slots] || stats[:heap_live_num]
+        @this_gc[:heap_free] = stats[:heap_free_slot] || stats[:heap_free_slots] || stats[:heap_free_num]
+
+        @this_gc = ::Instana::Util.enforce_deltas(@this_gc, @last_report)
+
+        unless @this_gc.empty?
+          @last_report.merge!(@this_gc)
+          @this_gc
+        else
+          nil
+        end
+      rescue => e
+        ::Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+        ::Instana.logger.debug e.backtrace.join("\r\n")
+      end
+    end
+  end
+end
+
+# Register the metrics collector if enabled
+if ::Instana.config[:metrics][:gc][:enabled]
+  ::Instana.collectors << ::Instana::Collector::GC.new
+end

data/lib/instana/collectors/memory.rb

@@ -0,0 +1,41 @@
+require 'get_process_mem'
+
+module Instana
+  module Collector
+    class Memory
+      attr_accessor :payload_key
+
+      def initialize
+        @payload_key = :memory
+        @last_report = {}
+        @this_mem = {}
+      end
+
+      ##
+      # collect
+      #
+      # To collect process memory usage.
+      #
+      def collect
+        @this_mem.clear
+        @this_mem[:rss_size] = ::GetProcessMem.new(Process.pid).kb
+
+        @this_mem = ::Instana::Util.enforce_deltas(@this_mem, @last_report)
+        unless @this_mem.empty?
+          @last_report.merge!(@this_mem)
+          @this_mem
+        else
+          nil
+        end
+      rescue => e
+        ::Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+        ::Instana.logger.debug e.backtrace.join("\r\n")
+      end
+    end
+  end
+end
+
+# Register the metrics collector if enabled
+if ::Instana.config[:metrics][:memory][:enabled]
+  ::Instana.collectors << ::Instana::Collector::Memory.new
+end

data/lib/instana/collectors/thread.rb

@@ -0,0 +1,39 @@
+module Instana
+  module Collector
+    class Thread
+      attr_accessor :payload_key
+
+      def initialize
+        @payload_key = :thread
+        @last_report = {}
+        @this_count = {}
+      end
+
+      ##
+      # collect
+      #
+      # To collect thread count
+      #
+      def collect
+        @this_count[:count] = ::Thread.list.count
+
+        @this_count = ::Instana::Util.enforce_deltas(@this_count, @last_report)
+
+        unless @this_count.empty?
+          @last_report.merge!(@this_count)
+          @this_count
+        else
+          nil
+        end
+      rescue => e
+        ::Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
+        ::Instana.logger.debug e.backtrace.join("\r\n")
+      end
+    end
+  end
+end
+
+# Register the metrics collector if enabled
+if ::Instana.config[:metrics][:thread][:enabled]
+  ::Instana.collectors << ::Instana::Collector::Thread.new
+end

data/lib/instana/config.rb

@@ -0,0 +1,24 @@
+module Instana
+  class Config
+
+    def initialize
+      @config = {}
+      @config[:agent_host] = '127.0.0.1'
+      @config[:agent_port] = 42699
+      @config[:metrics] = {}
+      @config[:metrics][:gc]     = { :enabled => true }
+      @config[:metrics][:memory] = { :enabled => true }
+      @config[:metrics][:thread] = { :enabled => true }
+    end
+
+    def [](key)
+      @config[key.to_sym]
+    end
+
+    def []=(key, value)
+      @config[key.to_sym] = value
+    end
+  end
+end
+
+::Instana.config = ::Instana::Config.new

data/lib/instana/util.rb

@@ -0,0 +1,52 @@
+module Instana
+  module Util
+    ##
+    # enforce_deltas
+    #
+    # Take two hashes, and make sure candidate does not have
+    # any of the same values as `last`.  We only report
+    # when values change.
+    #
+    # Note this is not recursive, so only pass in the single
+    # hashes that you want delta reporting with.
+    #
+    def self.enforce_deltas(candidate, last)
+      return unless last.is_a?(Hash)
+
+      candidate.each do |k,v|
+        if candidate[k] == last[k]
+          candidate.delete(k)
+        end
+      end
+      candidate
+    end
+  end
+
+  ##
+  # Debugging helper method
+  #
+  def self.pry!
+    # Only valid for development or test environments
+    #env = ENV['RACK_ENV'] || ENV['RAILS_ENV']
+    #return unless %w(development, test).include? env
+
+    if RUBY_VERSION > '1.8.7'
+      require 'pry-byebug'
+
+      if defined?(PryByebug)
+        Pry.commands.alias_command 'c', 'continue'
+        Pry.commands.alias_command 's', 'step'
+        Pry.commands.alias_command 'n', 'next'
+        Pry.commands.alias_command 'f', 'finish'
+
+        Pry::Commands.command(/^$/, 'repeat last command') do
+          _pry_.run_command Pry.history.to_a.last
+        end
+      end
+
+      binding.pry
+    else
+      require 'ruby-debug'; debugger
+    end
+  end
+end

data/lib/instana/version.rb

@@ -1,3 +1,3 @@
 module Instana
-  VERSION = "0.1.0"
+  VERSION = "0.8.beta1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.8.beta1
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-16 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Will Provide Ruby sensor instrumentation for Instana.
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: get_process_mem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+description: Provides Ruby sensor instrumentation for Instana.
 email:
 - pglombardo@gmail.com
 executables: []
@@ -69,6 +111,12 @@ files:
 - instana.gemspec
 - lib/instana.rb
 - lib/instana/agent.rb
+- lib/instana/collectors.rb
+- lib/instana/collectors/gc.rb
+- lib/instana/collectors/memory.rb
+- lib/instana/collectors/thread.rb
+- lib/instana/config.rb
+- lib/instana/util.rb
 - lib/instana/version.rb
 homepage: https://www.instana.com/
 licenses: []
@@ -81,16 +129,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Placeholder Ruby sensor gem for Instana
+summary: Ruby sensor for Instana
 test_files: []