langrove 0.0.5.3 → 0.0.5.4

data/README.md

@@ -3,9 +3,18 @@ LanGrove
 
 [LanGrove](http://www.google.com/search?hl=en&safe=off&biw=1065&bih=884&tbm=isch&sa=1&q=mangrove&btnG=) levarages [EventMachine](http://eventmachine.rubyforge.org/EventMachine.html) and [DaemonKit](https://github.com/kennethkalmer/daemon-kit/) to provide a framework for quick to implement network aware systems by providing an easily configurable transport and session layer and exposing generic interfaces into the application layer.
 
-### Getting started quickly with [Scaffold and Configuration](https://github.com/cluetechnologies/langrove-enterprise/tree/master/bin)
+### Getting started quickly with [Scaffold and Configuration](https://github.com/cluetechnologies/langrove/tree/master/bin)
+
+### Understanding the [Framework Components](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove)
+
+
+Note to Developers
+------------------
+
+* Uses [Guard](https://github.com/guard/guard/) to watch for changes in `lib` or `spec` directories
+* Runs specs accordingly.
+* `bundle exec guard` 
 
-### Understanding the [Framework Components](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove)
 
 Change Log
 ----------
@@ -13,22 +22,15 @@ Change Log
 ### 2012-08-08
 
 * v0.0.5.3
+* Started on `Metrix` (introspection subsystem)
 
+### 2012-08-09
 
-Todo
-----
-
-* Rename this to `langrove`
-* Rename the original to `langrove-enterprise`
-* Swing all document links
-* Publish this repo
-* Start on the Enterprise Extensions
-
+* Create metrix daemon component sampler infrastructure
+* v0.0.5.4
 
-Note to Developers
-------------------
 
-* Uses [Guard](https://github.com/guard/guard/) to watch for changes in `lib` or `spec` directories
-* Runs specs accordingly.
-* `bundle exec guard` 
+TODO
+----
 
+* Pass all config queries through single interface

data/langrove.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'awesome_print'
     
   spec.files = `git ls-files`.strip.split("\n")
+  spec.files.delete_if {|file| file[0] == '.' }
     
 end
     

data/lib/langrove/README.md

@@ -1,11 +1,11 @@
 Foundation
 ==========
 
-### [Langrove::Root::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/root)
+### [Langrove::Root::Base](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/root)
 
 Provides the `Config` and `Logger`.
 
-### [LanGrove::Daemon::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/daemon)
+### [LanGrove::Daemon::Base](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/daemon)
 
 Defines the `Container` that houses the Primary Daemon Components
 
@@ -14,22 +14,22 @@ Primary Components
 ==================
 
 
-### [LanGrove::Adaptor::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/adaptor)
+### [LanGrove::Adaptor::Base](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/adaptor)
 
 Defines the `Object` to which remote processes attach.
 
 
-### [LanGrove::Handler::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler)
+### [LanGrove::Handler::Base](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler)
 
 Defines the `Object` that is spawned to handle each attached remote process.
 
 
-### [LanGrove::Protocol::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/protocol)
+### [LanGrove::Protocol::Base](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/protocol)
 
 Defines the `Object` that encapsulates the method of communication.
 
 
-### [LanGrove::Server::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/server)
+### [LanGrove::Server::Base](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/server)
 
 Defines the `Object` that houses the collection of all presently connected remote processes.
 
@@ -64,12 +64,12 @@ Secondary Components
 ====================
 
 
-### [LanGrove::Behaviour::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/behaviour)
+### [LanGrove::Behaviour::Base](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/behaviour)
 
 Defines a set of Behaviours that can be applied to Primary Daemon Components
 
 
-### [LanGrove::Plugin::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin)
+### [LanGrove::Plugin::Base](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/plugin)
 
 Defines the `Interface Base` to implement Behaviour actions.
 
@@ -78,5 +78,5 @@ Defines the `Interface Base` to implement Behaviour actions.
 Tools and Things
 ================
 
-### [LanGrove::Ext](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/ext)
+### [LanGrove::Ext](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/ext)
 

data/lib/langrove/adaptor/README.md

@@ -5,7 +5,7 @@
 LanGrove::Adaptor::Base
 ========================
 
-Defines the extendable `Interface` for spawning [Handler](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler)s into the [Server](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/server) process.
+Defines the extendable `Interface` for spawning [Handler](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler)s into the [Server](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/server) process.
 
 
 EventMachineAdaptor

data/lib/langrove/behaviour/README.md

@@ -15,20 +15,20 @@
 LanGrove::Behaviour::Base
 =========================
 
-Defines the interface between the Daemon's [Primary Components](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove#primary-components) and the [Plugins](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin) that perform the Behaviour specified actions upon them.
+Defines the interface between the Daemon's [Primary Components](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove#primary-components) and the [Plugins](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/plugin) that perform the Behaviour specified actions upon them.
 
 Behaviour Triggers
 ------------------
 
 Behaviours are assigned to action at configurable trigger points in each Daemon module's life cycle.
 
-### [Server](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/server) Triggers
+### [Server](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/server) Triggers
 
 * :server_start
 * :server_stop
 * :server_reload
 
-### [Handler](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler) Triggers
+### [Handler](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler) Triggers
 
 * :handler_start
 * :handler_stop
@@ -42,11 +42,11 @@ Behaviours are assigned to action at configurable trigger points in each Daemon
 * :handler_after_receive
 * :handler_error
 
-### [Adaptor](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/adaptor) Triggers
+### [Adaptor](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/adaptor) Triggers
 
 * none
 
-### [Protocol](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/protocol) Triggers
+### [Protocol](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/protocol) Triggers
 
 * none
 
@@ -54,17 +54,17 @@ Behaviours are assigned to action at configurable trigger points in each Daemon
 Function
 --------
 
-* Behaviour triggers fire via the [Daemon Root](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/root) module.
+* Behaviour triggers fire via the [Daemon Root](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/root) module.
 * The triggers are called by the Module undergoing the associated event.
 * The call carries reference to the Module
-* The listening behaviour passes the Module reference onward to the [Plugin](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin) configured to perform the action.
+* The listening behaviour passes the Module reference onward to the [Plugin](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/plugin) configured to perform the action.
 
 
 Configuration
 =============
 
 * Behaviours are assigned to triggers in the :server: subconfig branch.
-* Behaviours are assigned a [Plugin](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin)
+* Behaviours are assigned a [Plugin](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/plugin)
 
 
 Behaviours
@@ -72,9 +72,9 @@ Behaviours
 
 ### Persistable
 
-Requires a [Persistor](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin#persistor) Plugin
+Requires a [Persistor](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/plugin#persistor) Plugin
 
-Creates the ability to store and fetch the contents of the [Handler's Capsule](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler#the-capsule)
+Creates the ability to store and fetch the contents of the [Handler's Capsule](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler#the-capsule)
 
 <pre>
 
@@ -103,11 +103,11 @@ Creates the ability to store and fetch the contents of the [Handler's Capsule](h
 
 ### Preloadable
 
-Requires a [Persistor](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin#persistor) Plugin
+Requires a [Persistor](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/plugin#persistor) Plugin
 
-Currently only works with a [Multiplexing Socket Handler](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler#socket-multiplexer)
+Currently only works with a [Multiplexing Socket Handler](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler#socket-multiplexer)
 
-Creates the ability to fetch all previously persisted [Handler Capsules](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler#the-capsule) ahead of goind to listen on the socket.
+Creates the ability to fetch all previously persisted [Handler Capsules](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler#the-capsule) ahead of goind to listen on the socket.
 
 <pre>
 
@@ -157,9 +157,9 @@ Creates the ability to fetch all previously persisted [Handler Capsules](https:/
 ### Enqueueable
 
 
-Requires an [Enqueuer](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin#enqueuer) Plugin
+Requires an [Enqueuer](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/plugin#enqueuer) Plugin
 
-Enqueues a Job onto a specified Queue with the [Handler's Capsule](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler#the-capsule) as payload.
+Enqueues a Job onto a specified Queue with the [Handler's Capsule](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler#the-capsule) as payload.
 
 
 

data/lib/langrove/daemon/daemon_base.rb

@@ -16,6 +16,9 @@ module LanGrove
     
       @@type = :daemon
 
+      attr_reader :server
+      attr_reader :adaptor
+
       def connect
 
         #
@@ -162,6 +165,11 @@ module LanGrove
       def start
         
         schedule_behaviours unless @server.nil?
+
+        #
+        # Start the introspector
+        #
+        @root.metrix.start( self )
         
         #
         # TODO: The client
@@ -179,7 +187,6 @@ module LanGrove
         @config      = config_hash
         @daemon_name = daemon_name
         
-
         #
         # TODO: The client
         #

data/lib/langrove/ext/fake_root.rb

@@ -8,6 +8,7 @@ module LanGrove
     
     attr_accessor :logger
     attr_accessor :config
+    attr_accessor :metrix
     
     def initialize( config = {
 
@@ -22,6 +23,7 @@ module LanGrove
       
       @logger = logger
       @config = LanGrove::Config::Base.new( self, config, logger )
+      @metrix  = LanGrove::Metrix::Base.new( self )
 
     end
 

data/lib/langrove/ext/log_monitor.rb

@@ -1,8 +1,234 @@
 module LanGrove
+
+  module LogMonitor
+
+    module Sampler
+
+      class << self
+
+        def init( root )
+
+          return if @initialized
+
+          @root = root
+
+          @root.logger.debug "#{self}.init( #{root} )"
+
+          @root.metrix.register_sampler( 
+
+            :type => :handler, 
+            :sampler => self,
+            :accumulator => proc { |component_type, component, state_doc|
+
+              #
+              # The component will only be sampled 
+              # if it is a LogMonitor
+              #
+
+              self.sample_accumulate( 
+
+                component_type, component, state_doc 
+
+              ) if component.respond_to?( :log_monitor_event )
+
+            }
+
+          )
+
+          @initialized = true
+
+          reset
+
+          return self
+
+        end
+
+        def sample_accumulate( component_type, component, state_doc )
+
+          #@root.logger.debug "#{self}.sample_accumulate( #{component_type}, #{component}, #{state_doc} )"
+
+          @name = component.class.to_s.split(' ')[0]
+          
+          @counters[:count] += 1
+
+          if component_type == :handler
+
+            if component.capsule['success']
+
+              @counters[:current_success] += 1
+
+            else 
+
+              @counters[:current_fail] += 1
+
+            end
+
+            now = Time.now.to_i
+
+            if component.capsule['success_at']
+
+              @counters[:success_ever] += 1
+
+              at = component.capsule['success_at'].strftime( '%s' )
+
+              @counters[:success_age] << now - at.to_i
+
+            else 
+
+              @counters[:success_never] += 1
+
+            end
+
+            if component.capsule['last_ran_at']
+
+              at = component.capsule['last_ran_at'].strftime( '%s' )
+
+              @counters[:last_run_age] << now - at.to_i
+
+            end
+
+            if component.capsule['known_errors']
+
+              component.capsule['known_errors'].each do |k,v|
+
+                if @counters[:known_errors][k].nil?
+
+                  @counters[:known_errors][k] = 1
+
+                else 
+
+                  @counters[:known_errors][k] += 1
+
+                end
+
+                @counters[:known_errors_instance] += 1
+                @counters[:known_errors_total] += v
+
+              end
+
+            end
+
+            if component.capsule['unknown_errors']
+
+              component.capsule['unknown_errors'].each do |k,v|
+
+                if @counters[:unknown_errors][k].nil?
+
+                  @counters[:unknown_errors][k] = 1
+
+                else 
+
+                  @counters[:unknown_errors][k] += 1
+
+                end
+
+                @counters[:unknown_errors_instance] += 1
+                @counters[:unknown_errors_total] += v
+
+              end
+
+            end
+
+          end
+
+        end
+
+        def sample_collate( component_type, state_doc )
+
+          #@root.logger.debug "#{self}.sample_collate( #{component_type}, #{state_doc} )"
+
+          success_age = 0.0
+          @counters[:success_age].each { |v| success_age += v }
+
+          last_run_age = 0.0
+          @counters[:last_run_age].each { |v| last_run_age += v }
+
+          state_doc[ @name ] = {
+
+            :count => @counters[:count],
+
+            :current_success => @counters[:current_success],
+            :current_fail => @counters[:current_fail],
+
+            :success_ever => @counters[:success_ever],
+            :success_never => @counters[:success_never],
+
+            :avg_success_age => success_age  / @counters[:success_age].length,
+            :age_last_run_age => last_run_age  / @counters[:last_run_age].length,
+
+            :known_errors_instance => @counters[:known_errors_instance],
+            :known_errors_total => @counters[:known_errors_total],
+
+            :unknown_errors_instance => @counters[:unknown_errors_instance],
+            :unknown_errors_total => @counters[:unknown_errors_total],
+
+            :known_errors => @counters[:known_errors],
+            :unknown_errors => @counters[:unknown_errors],
+
+          }
+
+          reset 
+
+        end
+
+        def reset
+
+          #
+          # This may be quite nasty to the garbage collector...
+          # 
+
+          @counters = {
+
+            :count => 0,
+
+            #
+            # current state
+            #
+            :current_success => 0,
+            :current_fail  => 0,
+
+            #
+            # ever succeeded
+            #
+            :success_ever => 0,
+            :success_never => 0,
+
+            #
+            # age in seconds of each success
+            #
+            :success_age => [],
+            :last_run_age => [],
+
+            #
+            # known errors 
+            #
+            :known_errors => {},
+            :known_errors_instance => 0,
+            :known_errors_total => 0,    # includes repeat count
+
+            #
+            # unknown errors
+            #
+            :unknown_errors => {},
+            :unknown_errors_instance => 0,
+            :unknown_errors_total => 0
+
+
+          }
+
+        end
+
+      end
+
+    end
+
+  end
   
   module LogMonitor
 
-    def log_monitor_config( config, hash = nil )
+    def log_monitor_config( root, hash )
+
+      @@sampler = Sampler.init( root )
       
       # 
       # <hash> as the state storage (capsule)

data/lib/langrove/handler/README.md

@@ -11,9 +11,9 @@ Defines the `Object` that interacts with remote processes.
 Function
 --------
 
-* A handler is spawned to handle each connection being made through the [Adaptor](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/adaptor).
+* A handler is spawned to handle each connection being made through the [Adaptor](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/adaptor).
 * The handler remains connected to it's assigned remote process.
-* Handlers are registered with the [Server](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/server) collection.
+* Handlers are registered with the [Server](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/server) collection.
 * Handlers run idle in [EventMachine](http://eventmachine.rubyforge.org/EventMachine.html)'s event loop.
 
 The Capsule
@@ -27,12 +27,12 @@ Event Callbacks
 ---------------
 
 * The event loop fires callbacks into the Handler. 
-* Each callback also has associated [Behaviour](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/behaviour) triggers.
+* Each callback also has associated [Behaviour](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/behaviour) triggers.
 
 
 ### start()
 
-This callback will fire into each connecting Handler after loading the [Protocol](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/protocol) and Config.
+This callback will fire into each connecting Handler after loading the [Protocol](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/protocol) and Config.
 
 
 ### stop()
@@ -47,7 +47,7 @@ Informs each Handler that the Daemon received a sigHUP. The Config may have chan
 
 ### receive( decoded )
 
-Data arrived at the socket and was decoded by the configured [Prococol](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/protocol)
+Data arrived at the socket and was decoded by the configured [Prococol](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/protocol)
 
 
 ### TODO - connect()

data/lib/langrove/plugin/README.md

@@ -24,8 +24,8 @@ Plugin Types
 Persistor
 ---------
 
-* Supports the [Persistable Behaviour](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/behaviour#persistable)
-* Supports the [Preloadable Behaviour](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/behaviour#preloadable) 
+* Supports the [Persistable Behaviour](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/behaviour#persistable)
+* Supports the [Preloadable Behaviour](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/behaviour#preloadable) 
 
 ### `store( hander )`
 
@@ -35,7 +35,7 @@ Persistor
 
 ### Implementations
 
-* [YamlFile](https://github.com/cluetechnologies/langrove-enterprise/blob/master/lib/langrove/plugin/yaml_file.md)
+* [YamlFile](https://github.com/cluetechnologies/langrove/blob/master/lib/langrove/plugin/yaml_file.md)
 * [langrove-plugin-mongodb.gem](https://github.com/cluetechnologies/langrove-plugin-mongodb)
 
 
@@ -46,7 +46,7 @@ Functionally identical to Persistor except it accumulates calls to store to enab
 All updates are performed at the configured `:interval:`
 
 * Only compatable with Eventmachine enabled daemons.
-* Supports the [Persistable Behaviour](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/behaviour#persistable)
+* Supports the [Persistable Behaviour](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/behaviour#persistable)
 
 ### Implementations
 
@@ -56,7 +56,7 @@ All updates are performed at the configured `:interval:`
 Enqueuer
 --------
 
-* Supports the [Enqueueable Behaviour](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/behaviour#enqueueable)
+* Supports the [Enqueueable Behaviour](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/behaviour#enqueueable)
 
 
 ### `enqueue_key( handler )`

data/lib/langrove/plugin/persistor.rb

@@ -171,7 +171,7 @@ module LanGrove
         # Use the pending capsule to assemble the
         # persistance key.
         #
-        data_hash = handler.pending_capsule
+        data_hash = handler.pending_capsule if handler.respond_to?( :pending_capsule )
         
         #
         # Fall back to using the actual capsule

data/lib/langrove/plugin/yaml_file.rb

@@ -181,7 +181,7 @@ module LanGrove
       def store( handler )
 
         filename = nil
-        
+
         begin
           
           data_hash = handler.capsule

data/lib/langrove/protocol/README.md

@@ -17,13 +17,13 @@
 LanGrove::Protocol::Base
 ========================
 
-Defines the `Interface` that is employed to decode and encode data passing between the [Handler](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler) and the remote process to which it is attached.
+Defines the `Interface` that is employed to decode and encode data passing between the [Handler](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler) and the remote process to which it is attached.
 
 
 Function
 --------
 
-Each spawned [Handler](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler) is assigned an instance of the protocol and its configuration.
+Each spawned [Handler](https://github.com/cluetechnologies/langrove/tree/master/lib/langrove/handler) is assigned an instance of the protocol and its configuration.
 
 
 Configuration

data/lib/langrove/root/README.md

@@ -1,5 +1,38 @@
 <pre>
 
+#
+# root |noun| ~ The force that through the green fuse drives the flower
+#               Drives my green age; that blasts the roots of trees
+#               Is my destroyer.
+# 
+#               And I am dumb to tell the crooked rose
+#               My youth is bent by the same wintry fever.
+#               The force that drives the water through the rocks
+#               Drives my red blood; that dries the mouthing streams
+#               Turns mine to wax.
+# 
+#               And I am dumb to mouth unto my veins
+#               How at the mountain spring the same mouth sucks.
+#               The hand that whirls the water in the pool
+#               Stirs the quicksand; that ropes the blowing wind
+#               Hauls my shroud sail.
+# 
+#               And I am dumb to tell the hanging man
+#               How of my clay is made the hangman’s lime.
+#               The lips of time leech to the fountain head;
+#               Love drips and gathers, but the fallen blood
+#               Shall calm her sores.
+# 
+#               And I am dumb to tell a weather’s wind
+#               How time has ticked a heaven round the stars.
+# 
+#               And I am dumb to tell the lover’s tomb
+#               How at my sheet goes the same crooked worm.
+#               
+# 
+#                                           - Dylan Thomas (1914–1953)
+# 
+
 </pre>
 
 LanGrove::Root::Base
@@ -9,9 +42,15 @@ LanGrove::Root::Base
 * Provides the `config` and `logger` to all daemon modules.
 * Provides an event trigger interface into `Behaviour` and associated `Plugin` modules.
 
+Metrix
+------
+
+pending...
+
+
+
 Todo
 ----
 
-* Provides an introspection interface into `Metrix` module.
 * Provides a notification interface into `Alerter` module.
 

data/lib/langrove/root/base.rb

@@ -8,4 +8,5 @@ module LanGrove
 
 end
 require 'langrove/root/root_base'
+require 'langrove/root/metrix'
 require 'langrove/root/config'

data/lib/langrove/root/config.rb

@@ -66,6 +66,41 @@ module LanGrove
       
       end
 
+      def get_daemon_config( name, component = nil )
+
+        #
+        I.show "TODO: All config collection should pass through here"
+        #
+        
+        @logger.debug "get_daemon_config( #{name}, #{component} )"
+
+        raise LanGrove::DaemonConfigException.new(
+
+          "No :daemons: named #{name}"
+
+        ) if @config[:daemons][name].nil?
+
+        return @config[:daemons][name] if component == nil?
+
+        if @config[:daemons][name][component].nil?
+
+          @logger.error "No #{component} defined for :daemons: named #{name}"
+          return {}
+
+        end
+
+        return @config[:daemons][name][component]
+
+      end
+
+      def get_daemon( name, component = nil, instance = true )
+
+        #
+        # Get instance[ ?.new ]
+        #
+
+      end
+
       def get_plugin_config( name )
 
         @config[:plugins][name]

data/lib/langrove/root/metrix.rb

@@ -0,0 +1,204 @@
+require 'socket'
+
+module LanGrove
+
+  module Metrix
+
+    class Base < LanGrove::Base
+
+      #
+      # Maintains a capsule 'image' of runtime state
+      #
+      attr_reader :capsule
+
+      #
+      # Persists the capsule
+      # 
+      attr_accessor :key
+      attr_reader :persistor
+
+      def initialize( root )
+
+        super( root )
+
+        @config = root.config.get_daemon_config( DAEMON_NAME, :metrix )
+
+        I.show @config
+
+        @capsule = {
+
+          :id => "#{DAEMON_NAME}@#{Socket.gethostname}"
+
+        }
+
+        @persistor = nil
+
+        #
+        # register_sampler() informs this with sampler objects
+        # to process the daemon components 
+        # 
+        @samplers = {}
+
+        @interval = @config[:interval].nil? ? 60 * 5 : @config[:interval]
+ 
+        if @config[:persistor].nil?
+
+          #
+          # Defaults to persist runtime state 'image' 
+          # to a yaml file at:
+          #  
+          #   daemon_root//log/daemon_name@hostname
+          # 
+
+          @persistor =  LanGrove::ClassLoader.create( { 
+    
+            :module => 'Plugin',
+            :class  => 'YamlFile'
+      
+          } ).new( root, {
+
+            :basedir => DAEMON_ROOT,
+            :database => '',
+            :table => 'log',
+            :key => {
+              :filename => :id
+            }
+            
+          }, nil )
+
+        else
+
+          #
+          # But can use any configured persistor plugin
+          # 
+
+          @persistor = root.config.get_plugin( @config[:persistor] )
+        
+        end
+
+        raise config_exception(
+
+          "#{self.class} requires :persistor: to specify a configured persistor plugin."
+
+        ) unless @persistor.is_a?( LanGrove::Plugin::Persistor )
+
+      end
+
+      def register_sampler( spec )
+
+        type = :handler
+        filter = '*'
+        accumulator = nil
+        sampler = nil
+
+        spec.each do |key, value|
+
+          case key
+
+            when :type 
+
+              type = value
+
+            when :sampler
+
+              sampler = value
+
+            when :filter
+
+              filter = value
+
+            when :accumulator
+
+              #
+              # Allows for an alternative accumulator callback
+              #
+              accumulator = value
+              
+          end
+
+        end
+
+        @samplers[type] = {} if @samplers[type].nil?
+        @samplers[type][filter] = [] if @samplers[type][filter].nil?
+        @samplers[type][filter] << [accumulator, sampler]
+
+      end
+
+      def start( daemon )
+
+        @logger.debug "#{self.class}.start( #{daemon} )"
+
+        #
+        # Start the sample event loop
+        #
+
+        @daemon = daemon
+
+        if defined?( EM ) and EM::reactor_running?
+
+          EM::add_periodic_timer(@interval) do
+
+            sample
+
+          end
+
+        end
+
+      end
+
+      def sample
+        
+        sample_handlers
+
+        sample_adaptors
+
+        I.show @capsule
+
+        @persistor.store( self )
+
+      end
+
+      def sample_handlers
+
+        @samplers[:handler]['*'].each do |sampler|
+
+          #
+          # sampler[0] contains the alternative accumulator callback proc
+          # sampler[1] contains the sampler object
+          #
+
+          @daemon.server.each_handler do |handler|
+
+            if sampler[0].nil?
+
+              sampler[1].sample_accumulate( :handler, handler, @capsule )
+
+            else
+
+              sampler[0].yield( :handler, handler, @capsule )
+
+            end
+
+          end
+
+          sampler[1].sample_collate( :handler, @capsule )
+
+        end unless @samplers[:handler].nil?
+
+      end
+
+      def sample_adaptors
+
+        @samplers[:adaptor]['*'].each do |sampler|
+
+          sampler[1].sample_accumulate( :adaptor, @daemon.adaptor, @capsule )
+
+        end unless @samplers[:adaptor].nil?
+
+      end
+
+    end
+
+  end
+
+end

data/lib/langrove/root/root_base.rb

@@ -37,19 +37,6 @@ module LanGrove
     
   end
   
-  module Metrix
-    
-    class Base
-      
-      #
-      # Collect internal runtime metrix from
-      # all local daemons
-      #
-     
-    end
-    
-  end
-  
   module Alerter
   
     class Base
@@ -135,7 +122,8 @@ module LanGrove
 
           config_instance
 
-          
+        @config.instance_variable_set( :@logger, logger )
+
         #
         # Behaviours are configured to run at 
         # key points in the Daemon life cycle.
@@ -248,7 +236,7 @@ module LanGrove
         # LAter...
         #
         @alerter = LanGrove::Alerter::Base.new
-        @metrix  = LanGrove::Metrix::Base.new
+        @metrix  = LanGrove::Metrix::Base.new( self )
         
       end
       

data/lib/langrove/version.rb

@@ -1,5 +1,5 @@
 module LanGrove
   
-  Version = VERSION = '0.0.5.3'
+  Version = VERSION = '0.0.5.4'
   
 end

data/spec/langrove/root/metrix_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'em-rspec'
+
+describe LanGrove::Metrix::Base do
+
+  before :each do
+
+    CONFIG.flush
+
+  end
+
+  subject {
+
+    LanGrove::Metrix::Base.new( ROOT )
+
+  }
+
+  pending 'default to persisting runtime metrix as a yaml file' do
+
+    LOG.on
+
+    subject.persistor.should be_a( LanGrove::Plugin::YamlFile )
+
+  end
+
+  pending 'defaults to a 5 minute sample frequency' do
+
+    EM.should_receive( :add_periodic_timer ).with( 5 * 60 )
+
+    subject.start
+
+  end
+
+  it 'allows registering functions as samplers' do
+
+    sampler1 = mock( 'A sampler for handlers' )
+    sampler2 = mock( 'A sampler for adaptors' )
+
+    CONFIG.create( 'daemon', :handler, 'Base' )
+    CONFIG.create( 'daemon', :adaptor, 'Base' )
+    CONFIG.create( 'daemon', :metrix, 'Base' )
+
+    @daemon, @server, @adaptor, @handler, @protocol = 
+      LanGrove::SpecHelper::create_daemon_with_connected_handler( 'daemon', anything )
+
+    subject.instance_variable_set( :@daemon, @daemon )
+
+    sampler1.should_receive( :sample ).with( :handler, @handler, anything )
+    sampler2.should_receive( :sample ).with( :adaptor, @adaptor, anything )
+
+    subject.register_sampler( :type => :handler, :sampler => sampler1 )
+    subject.register_sampler( :type => :adaptor, :sampler => sampler2 )
+
+    subject.sample
+
+  end
+
+  pending 'can specify to sample only handlers of a specific type'
+  
+end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'langrove'
 
-NAME = 'daemon'
+DAEMON_ROOT = File.expand_path('../../',  __FILE__)
+
+DAEMON_NAME = NAME = 'daemon'
 
 LOG = LanGrove::FakeLogger
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: langrove
 version: !ruby/object:Gem::Version
-  version: 0.0.5.3
+  version: 0.0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-08 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -117,8 +117,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .rspec
-- .rvmrc
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -190,6 +188,7 @@ files:
 - lib/langrove/root/README.md
 - lib/langrove/root/base.rb
 - lib/langrove/root/config.rb
+- lib/langrove/root/metrix.rb
 - lib/langrove/root/root_base.rb
 - lib/langrove/server/README.md
 - lib/langrove/server/base.rb
@@ -236,6 +235,7 @@ files:
 - spec/langrove/protocol/protocol_base_spec.rb
 - spec/langrove/protocol/syslog_spec.rb
 - spec/langrove/root/config_spec.rb
+- spec/langrove/root/metrix_spec.rb
 - spec/langrove/root/root_base_spec.rb
 - spec/langrove/server/server_base_spec.rb
 - spec/spec_helper.rb

data/.rspec

@@ -1 +0,0 @@
---color

data/.rvmrc

@@ -1,53 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 1.9.2" > .rvmrc
-environment_id="ruby-1.9.2-p318@langrove"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.12.3 (master)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
-    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
-  if [[ $- == *i* ]] # check for interactive shells
-  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
-  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
-  fi
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create use  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && {
-#   ! builtin command -v bundle >/dev/null ||
-#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
-# }
-# then
-#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-# then
-#   bundle install | grep -vE '^Using|Your bundle is complete'
-# fi