netuitive_ruby_api 0.9.8 → 1.0.1

data/README.md

@@ -1,21 +1,29 @@
-# netuitive_ruby_api
-An easy interface to communicate with the netuitive ruby daemon netuitived(https://rubygems.org/gems/netuitived)
+Netuitive Ruby API
+===================
 
-Requirements:
-	netuitived must be running
+The Netuitive Ruby API provides an easy interface to communicate with the Netuitive Ruby daemon [NetuitiveD](https://rubygems.org/gems/netuitived). NetuitiveD is meant to work in conjunction with NetuitiveD and the [netuitive_rails_agent](https://rubygems.org/gems/netuitive_rails_agent) gem to help [Netuitive](https://www.netuitive.com) monitor your Ruby applications.
 
-How to install using gem:
+For more information on the Netuitive Ruby API, see our Ruby agent [help docs](https://help.netuitive.com/Content/Misc/Datasources/new_ruby_datasource.htm), or contact Netuitive support at [support@netuitive.com](mailto:support@netuitive.com).
 
-run the command:
+Requirements
+-------------
 
-     gem install netuitive_ruby_api
+[NetuitiveD](https://github.com/Netuitive/netuitived) must be installed and running.
 
-How to use:
+Installing the Netuitive Ruby API
+----------------------------------
+
+`gem install netuitive_ruby_api`
+
+Using the Netuitive Ruby API
+-----------------------------
 
 Single sample example:
-NetuitiveRubyAPI::netuitivedServer.addSample("metric.name", [metric value])
+
+    NetuitiveRubyAPI::netuitivedServer.addSample("metric.name", [metric value])
 
 Add the aggregation value to the existing value for the metric for this interval:
-NetuitiveRubyAPI::netuitivedServer.aggregateMetric("metric.name", [aggregation value])
 
-Aggregation may be confusing but at its heart it's a simple concept. It's basically a sum of the aggregation values over the course of a single interval; it's useful for datasets like the number of requests per minute.  
+    NetuitiveRubyAPI::netuitivedServer.aggregateMetric("metric.name", [aggregation value])
+
+An aggregation value is the sum of metric values over the course of a single interval. Aggregation can be quite useful for datasets like the number of requests per minute.

data/config/agent.yml

@@ -1,4 +1,7 @@
 #all are configurable using environment variables
+logLocation: #absolute path of log file. leave blank for default location in the gem directory. environment variable: NETUITIVE_RUBY_LOG_LOCATION
+logAge: daily #Number of old log files to keep, or frequency of rotation (daily, weekly or monthly). environment variable: NETUITIVE_RUBY_LOG_AGE
+logSize: #Maximum logfile size in bytes (only applies when shift_age is a number). environment variable: NETUITIVE_RUBY_LOG_SIZE
 debugLevel: info #options (in ascending order of debugness) are: error, info, debug. environment variable: NETUITIVE_RUBY_DEBUG_LEVEL
 netuitivedAddr: localhost #environment variable: NETUITIVE_RUBY_NETUITIVED_ADDR
 netuitivedPort: 8875 #environment variable: NETUITIVE_RUBY_NETUITIVED_PORT

data/lib/netuitive_ruby_api.rb

@@ -1,17 +1,78 @@
-require 'netuitive/ruby_config_manager'
+require 'yaml'
+require 'logger'
 require 'drb/drb'
+require 'netuitive_ruby_api/config_manager'
+require 'netuitive_ruby_api/netuitive_logger'
+
 class NetuitiveRubyAPI
-	class << self
-		def setup(server)
-			@@netuitivedServer=server
-		end 
-
-		def netuitivedServer
-			return @@netuitivedServer
-		end
-	end
+  class << self
+    def setup(server)
+      @@netuitivedServer = server
+    end
+
+    def netuitivedServer
+      @@netuitivedServer
+    end
+
+    def send_metrics
+      server_interaction { netuitivedServer.sendMetrics }
+    end
+
+    def add_sample(metric_id, val)
+      server_interaction { netuitivedServer.addSample(metric_id, val) }
+    end
+
+    def add_counter_sample(metric_id, val)
+      server_interaction { netuitivedServer.addCounterSample(metric_id, val) }
+    end
+
+    def aggregate_metric(metric_id, val)
+      server_interaction { netuitivedServer.aggregateMetric(metric_id, val) }
+    end
+
+    def aggregate_counter_metric(metric_id, val)
+      server_interaction { netuitivedServer.aggregateCounterMetric(metric_id, val) }
+    end
+
+    def clear_metrics
+      server_interaction { netuitivedServer.clearMetrics }
+    end
+
+    def interval
+      netuitivedServer.interval # synchronous for return value
+    end
+
+    def event(message, timestamp = Time.new, title = 'Ruby Event', level = 'Info', source = 'Ruby Agent', type = 'INFO', tags = nil)
+      server_interaction { netuitivedServer.event(message, timestamp, title, level, source, type, tags) }
+    end
+
+    def exception_event(exception, klass = nil, tags = nil)
+      server_interaction do
+        hash = { message: exception.message }
+        hash[:backtrace] = exception.backtrace.join("\n\t") if (defined? exception.backtrace) && !exception.backtrace.nil?
+        netuitivedServer.exceptionEvent(hash, klass, tags)
+      end
+    end
+
+    def stop_server
+      server_interaction { netuitivedServer.stopServer }
+    end
+
+    def server_interaction
+      Thread.new do
+        begin
+          yield
+        rescue => e
+          NetuitiveRubyApi::NetuitiveLogger.log.error "unable to connect to netuitived: message:#{e.message} backtrace:#{e.backtrace}"
+        end
+      end
+    end
+  end
 end
-ConfigManager::setup
-SERVER_URI="druby://#{ConfigManager.netuitivedAddr}:#{ConfigManager.netuitivedPort}"
+
+NetuitiveRubyApi::ConfigManager.load_config
+NetuitiveRubyApi::NetuitiveLogger.setup
+NetuitiveRubyApi::ConfigManager.read_config
+SERVER_URI = "druby://#{NetuitiveRubyApi::ConfigManager.netuitivedAddr}:#{NetuitiveRubyApi::ConfigManager.netuitivedPort}".freeze
 DRb.start_service
-NetuitiveRubyAPI.setup(DRbObject.new_with_uri(SERVER_URI))
+NetuitiveRubyAPI.setup(DRbObject.new_with_uri(SERVER_URI))

data/lib/netuitive_ruby_api/config_manager.rb

@@ -0,0 +1,76 @@
+module NetuitiveRubyApi
+  class ConfigManager
+    class << self
+      attr_reader :netuitivedAddr
+
+      attr_reader :netuitivedPort
+
+      attr_reader :data
+
+      def property(name, var, default = nil)
+        prop = ENV[var]
+        prop = data[name] if prop.nil? || (prop == '')
+        return prop unless prop.nil? || (prop == '')
+        default
+      end
+
+      def boolean_property(name, var)
+        prop = ENV[var].nil? ? nil : ENV[var].dup
+        if prop.nil? || (prop == '')
+          prop = data[name]
+        else
+          prop.strip!
+          prop = prop.casecmp('true').zero?
+        end
+        prop
+      end
+
+      def float_property(name, var)
+        prop = ENV[var].nil? ? nil : ENV[var]
+        if prop.nil? || (prop == '')
+          data[name].to_f
+        else
+          prop.to_f
+        end
+      end
+
+      def string_list_property(name, var)
+        list = []
+        prop = ENV[var].nil? ? nil : ENV[var].dup
+        if prop.nil? || (prop == '')
+          list = data[name] if !data[name].nil? && data[name].is_a?(Array)
+        else
+          list = prop.split(',')
+        end
+        list.each(&:strip!) unless list.empty?
+        list
+      end
+
+      def load_config
+        gem_root = File.expand_path('../../..', __FILE__)
+        @data = YAML.load_file "#{gem_root}/config/agent.yml"
+      end
+
+      def read_config
+        @netuitivedAddr = property('netuitivedAddr', 'NETUITIVE_RUBY_NETUITIVED_ADDR')
+        @netuitivedPort = property('netuitivedPort', 'NETUITIVE_RUBY_NETUITIVED_PORT')
+        debugLevelString = property('debugLevel', 'NETUITIVE_RUBY_DEBUG_LEVEL')
+        NetuitiveRubyApi::NetuitiveLogger.log.level = if debugLevelString == 'error'
+                                                        Logger::ERROR
+                                                      elsif debugLevelString == 'info'
+                                                        Logger::INFO
+                                                      elsif debugLevelString == 'debug'
+                                                        Logger::DEBUG
+                                                      else
+                                                        Logger::ERROR
+                                                      end
+        NetuitiveRubyApi::NetuitiveLogger.log.info "port: #{@netuitivedPort}"
+        NetuitiveRubyApi::NetuitiveLogger.log.info "addr: #{@netuitivedAddr}"
+        NetuitiveRubyApi::NetuitiveLogger.log.debug "read config file. Results:
+          netuitivedAddr: #{@netuitivedAddr}
+          netuitivedPort: #{@netuitivedPort}
+          debugLevel: #{debugLevelString}"
+      end
+    end
+  end
+end

data/lib/netuitive_ruby_api/netuitive_logger.rb

@@ -0,0 +1,49 @@
+require 'logger'
+module NetuitiveRubyApi
+  class CheaterLogger
+    attr_accessor :level
+    def debug(message)
+    end
+
+    def error(message)
+    end
+
+    def info(message)
+    end
+  end
+
+  class NetuitiveLogger
+    class << self
+      attr_reader :log
+      def setup
+        file = NetuitiveRubyApi::ConfigManager.property('logLocation', 'NETUITIVE_RUBY_LOG_LOCATION', "#{File.expand_path('../../..', __FILE__)}/log/netuitive.log")
+        age = NetuitiveRubyApi::ConfigManager.property('logAge', 'NETUITIVE_RUBY_LOG_AGE', 'daily')
+        age = format_age(age)
+        size = NetuitiveRubyApi::ConfigManager.property('logSize', 'NETUITIVE_RUBY_LOG_SIZE', 1_000_000)
+        size = format_size(size)
+        @log = Logger.new(file, age, size)
+      rescue => e
+        puts "netuitive unable to open log file. error: #{e.message}, backtrace: #{e.backtrace}"
+        @log = NetuitiveRubyApi::CheaterLogger.new
+      end
+
+      def format_age(age)
+        return 'daily' if age.nil?
+        begin
+          Integer(age)
+        rescue
+          age
+        end
+      end
+
+      def format_size(size)
+        return 1_000_000 if size.nil?
+        begin
+          Integer(size)
+        rescue
+          size
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netuitive_ruby_api
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies: []
 description: Allows for easy submittion of metrics to Netuitive
 email: jking@netuitive.com
@@ -17,8 +17,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/netuitive/ruby_config_manager.rb
-- lib/netuitive/netuitive_ruby_logger.rb
+- lib/netuitive_ruby_api/netuitive_logger.rb
+- lib/netuitive_ruby_api/config_manager.rb
 - lib/netuitive_ruby_api.rb
 - config/agent.yml
 - ./LICENSE

data/lib/netuitive/netuitive_ruby_logger.rb

@@ -1,24 +0,0 @@
-require 'logger'
-class CheaterLogger
-	attr_accessor :level
-	def debug(message)
-	end
-	def error(message)
-	end
-	def info(message)
-	end
-end
-
-class NetuitiveLogger
-	begin
-		@@log = Logger.new("#{File.expand_path("../../..", __FILE__)}/log/netuitive.log",'daily', 10)
-	rescue
-		puts "netuitive unable to open log file"
-		@@log = CheaterLogger.new
-	end
-	class << self
-		def log
-			return @@log
-		end
-	end
-end

data/lib/netuitive/ruby_config_manager.rb

@@ -1,50 +0,0 @@
-require 'netuitive/netuitive_ruby_logger'
-require 'yaml'
-class ConfigManager
-
-	class << self
-		def setup()
-			readConfig()
-		end
-
-		def netuitivedAddr
-			@@netuitivedAddr
-		end
-
-		def netuitivedPort
-			@@netuitivedPort
-		end
-
-		def readConfig()
-			gem_root= File.expand_path("../../..", __FILE__)
-			data=YAML.load_file "#{gem_root}/config/agent.yml"
-			@@netuitivedAddr=ENV["NETUITIVE_RUBY_NETUITIVED_ADDR"]
-			if(@@netuitivedAddr == nil or @@netuitivedAddr == "")
-				@@netuitivedAddr=data["netuitivedAddr"]
-			end
-			@@netuitivedPort=ENV["NETUITIVE_RUBY_NETUITIVED_PORT"]
-			if(@@netuitivedPort == nil or @@netuitivedPort == "")
-				@@netuitivedPort=data["netuitivedPort"]
-			end
-			debugLevelString=ENV["NETUITIVE_RUBY_DEBUG_LEVEL"]
-			if(debugLevelString == nil or debugLevelString == "")
-				debugLevelString=data["debugLevel"]
-			end
-			NetuitiveLogger.log.info "port: #{@@netuitivedPort}"
-			NetuitiveLogger.log.info "addr: #{@@netuitivedAddr}"
-			if debugLevelString == "error"
-				NetuitiveLogger.log.level = Logger::ERROR
-			elsif debugLevelString == "info"
-				NetuitiveLogger.log.level = Logger::INFO
-			elsif debugLevelString == "debug"
-				NetuitiveLogger.log.level = Logger::DEBUG
-			else
-				NetuitiveLogger.log.level = Logger::ERROR
-			end
-			NetuitiveLogger.log.debug "read config file. Results: 
-				netuitivedAddr: #{@@netuitivedAddr}
-				netuitivedPort: #{@@netuitivedPort}
-				debugLevel: #{debugLevelString}"
-		end
-	end
-end