ustate-client 0.0.4 → 0.0.5

data/README.markdown

@@ -187,6 +187,16 @@ Then:
     c.query.states # => [UState::State(state: 'ok', service: 'My service')]
     c.query('state != "ok"').states # => []
 
+Client state management
+-----------------------
+
+UState provides some classes to make managing state updates easier.
+
+UState::MetricThread starts a thread to poll a metric periodically, which can
+be used to flush an accumulated value to ustate at regular intervals.
+
+UState::AutoState bundles a state and a client together. Any changes to the AutoState automatically send the new state to the client.
+
 The Dashboard
 =============
 

data/lib/ustate/aggregator.rb

@@ -11,14 +11,15 @@ module UState
 
       @folds = {}
       @interval = opts[:interval] || INTERVAL
+      @server = opts[:server]
 
       start
     end
 
     # Combines states matching query with State.average
-    def average(query, init = State.new)
+    def average(query, *a)
       fold query do |states|
-        State.average states, init
+        State.average states, *a
       end
     end
 
@@ -45,24 +46,29 @@ module UState
     def start
       @runner = Thread.new do
         loop do
-          interval = (@interval.to_f / @folds.size) rescue @interval
-          @folds.each do |f, query|
-            matching = @index.query(Query.new(string: query))
-            unless matching.empty?
-              if combined = f[matching]
-                @index << combined
+          begin
+            interval = (@interval.to_f / @folds.size) rescue @interval
+            @folds.each do |f, query|
+              matching = @index.query(Query.new(string: query))
+              unless matching.empty?
+                if combined = f[matching]
+                  @index << combined
+                end
               end
+              sleep interval
             end
-            sleep interval
+          rescue Exception => e
+            @server.log.error e
+            sleep 1
           end
         end
       end
     end
 
     # Combines states matching query with State.sum
-    def sum(query, init = State.new)
+    def sum(query, *a)
       fold query do |states|
-        State.sum states, init
+        State.sum states, *a
       end
     end
   end

data/lib/ustate/auto_state.rb

@@ -0,0 +1,125 @@
+module UState
+  class AutoState
+    # Binds together a State and a Client. Any change made here
+    # sends the state to the client. Useful when updates to a state are made
+    # decoherently, e.g. across many methods. Combine with MetricThread (or
+    # just Thread.new { loop { autostate.flush; sleep n } }) to ensure regular
+    # updates.
+    #
+    # example:
+    #
+    # class Job
+    #   def initialize
+    #     @state = AutoState.new
+    #     @state.service = 'job'
+    #     @state.state = 'starting up'
+    #
+    #     run
+    #   end
+    #
+    #   def run
+    #     loop do
+    #       begin
+    #         a
+    #         b
+    #       rescue Exception => e
+    #         @state.once(
+    #           state: 'error',
+    #           description: e.to_s
+    #         )
+    #       end
+    #     end
+    #   end
+    #
+    #   def a
+    #     @state.state = 'heavy lifting a'
+    #     ...
+    #   end
+    #
+    #   def b
+    #     @state.state = 'heavy lifting b'
+    #     ...
+    #   end
+    
+    def initialize(client = Client.new, state = State.new)
+      @client = client
+      @state = case state
+               when State
+                 state
+               else
+                 State.new state
+               end
+    end
+
+    def description=(description)
+      @state.description = description
+      flush
+    end
+
+    def description
+      @state.description
+    end
+
+    # Send state to client
+    def flush
+      @client << @state
+    end
+
+    def host=(host)
+      @state.host = host
+      flush
+    end
+
+    def host
+      @state.host
+    end
+
+    def metric_f=(metric_f)
+      @state.metric_f = metric_f
+      flush
+    end
+
+    def metric_f
+      @state.metric_f
+    end
+
+    # Performs multiple updates, followed by flush.
+    # Example: merge state: critical, metric_f: 10235.3
+    def merge(opts)
+      opts.each do |k, v|
+        @state.send "#{k}=", v
+      end
+      flush
+    end
+
+    # Issues an immediate update of the state with the :once option
+    # set, but does not update the local state. Useful for transient errors.
+    # Opts are merged with the state.
+    def once(opts)
+      o = @state.dup
+      opts.each do |k, v|
+        o.send "#{k}=", v
+      end
+      o.once = true
+      @client << o
+    end
+
+    def state=(state)
+      @state.state = state
+      flush
+    end
+
+    def state
+      @state.state
+    end
+
+    def service=(service)
+      @state.service = service
+      flush
+    end 
+
+    def service
+      @state.service
+    end
+  end
+end

data/lib/ustate/client.rb

@@ -23,9 +23,15 @@ class UState::Client
   # Send a state
   def <<(state_opts)
     # Create state
-    state = UState::State.new(state_opts)
-    state.time ||= Time.now.utc.to_i
-    state.host ||= Socket.gethostname
+    case state_opts
+    when UState::State
+      state = state_opts
+    else
+      unless state_opts.include? :host
+        state_opts[:host] = Socket.gethostname
+      end
+      state = UState::State.new(state_opts)
+    end
 
     message = UState::Message.new :states => [state]
 

data/lib/ustate/dash/helper/renderer.rb

@@ -125,14 +125,16 @@ module UState
 
         # Compute maximum for each service
         maxima = if o[:global_maximum]
-          max = states.map(&:metric).max
+          max = states.map(&:metric).compact.max
           services.inject({}) do |m, s|
             m[s] = max
             m
           end.merge o[:maxima]
         else
           states.inject(Hash.new(0)) do |m, s|
-            m[s.service] = [s.metric, m[s.service]].max
+            if s.metric
+              m[s.service] = [s.metric, m[s.service]].max
+            end
             m
           end.merge o[:maxima]
         end
@@ -141,8 +143,16 @@ module UState
         # list of hosts explicitly given.
         hosts = o[:hosts] || states.map do |state|
           state.host
-        end.compact
-        hosts = hosts.uniq.sort
+        end
+        hosts = hosts.uniq.sort { |a, b|
+          if !a
+            -1
+          elsif !b
+            1
+          else
+            a <=> b
+          end
+        }
 
         # Construct index
         by = states.inject({}) do |index, s|

data/lib/ustate/emailer.rb

@@ -23,6 +23,7 @@ module UState
       @from = opts[:from]
       @name = opts[:name]
       @host = opts[:host]
+      @server = opts[:server]
 
       @tell = {}
 
@@ -63,10 +64,14 @@ EOF
     # Dispatch emails to each address which is interested in this state
     def receive(*states)
       Thread.new do
-        @tell.each do |address, q|
-          if states.any? { |state| p  state; q === state }
-            email address, states.last
+        begin
+          @tell.each do |address, q|
+            if states.any? { |state| p  state; q === state }
+              email address, states.last
+            end
           end
+        rescue Exception => e
+          @server.log.error e
         end
       end
     end

data/lib/ustate/graphite.rb

@@ -15,6 +15,7 @@ module UState
       @query = opts[:query]
       @host = opts[:host] || HOST
       @port = opts[:port] || PORT
+      @server = opts[:server]
       @interval = opts[:interval] || INTERVAL
       @locket = Mutex.new
 
@@ -68,10 +69,15 @@ module UState
     def start
       @runner = Thread.new do
         loop do
-          @index.query(Query.new(string: @query)).each do |state|
-            forward state
+          begin
+            @index.query(Query.new(string: @query)).each do |state|
+              forward state
+            end
+            sleep @interval
+          rescue Exception => e
+            @server.log.warn e
+            sleep 1
           end
-          sleep @interval
         end
       end
     end

data/lib/ustate/server.rb

@@ -15,6 +15,7 @@ module UState
     require 'ustate/query_string'
     require 'ustate/query/ast'
     require 'ustate/metric_thread'
+    require 'logger'
     require 'mtrc'
 
     attr_accessor :backends
@@ -22,32 +23,37 @@ module UState
     attr_writer :aggregator
     attr_writer :emailer
     attr_writer :graphite
+
+    attr_accessor :log
    
     def initialize(opts = {})
       # Backends
       @backends = []
-      b = Backends::TCP.new opts
+      b = Backends::TCP.new opts.merge(server: self)
       b.server = self
       @backends << b
 
-      @index = Index.new
+      @index = Index.new :server => self
+
+      @log = Logger.new('ustate.log', 4, 134217728)
+      @log.level = Logger::INFO  
 
       setup_signals
     end
 
     def aggregator(opts = {})
       require 'ustate/aggregator'
-      @aggregator ||= UState::Aggregator.new(@index, opts)
+      @aggregator ||= UState::Aggregator.new(@index, opts.merge(server: self))
     end
 
     def emailer(opts = {})
       require 'ustate/emailer'
-      @emailer ||= UState::Emailer.new(@index, opts)
+      @emailer ||= UState::Emailer.new(@index, opts.merge(server: self))
     end
 
     def graphite(opts = {})
       require 'ustate/graphite'
-      @graphite ||= UState::Graphite.new(@index, opts)
+      @graphite ||= UState::Graphite.new(@index, opts.merge(server: self))
     end
 
     def start

data/lib/ustate/server/backends/base.rb

@@ -13,6 +13,7 @@ class UState::Server::Backends::Base
 
   def initialize(opts = {})
     @connections = []
+    @server = opts[:server]
     @timeout = opts[:timeout] || TIMEOUT
     @maximum_connections = opts[:maximum_connections] || MAXIMUM_CONNECTIONS
   end

data/lib/ustate/server/backends/tcp.rb

@@ -17,7 +17,7 @@ class UState::Server
 
     # Connect the server
     def connect
-      puts "Listening on #{@host}:#{@port}"
+      @server.log.info "Listening on #{@host}:#{@port}"
       @signature = EventMachine.start_server(@host, @port, Connection, &method(:initialize_connection))
     end
 

data/lib/ustate/server/index.rb

@@ -25,6 +25,7 @@ module UState
     def initialize(opts = {})
       @db = Sequel.sqlite
 
+      @server = opts[:server]
       @threads = opts[:threads] || THREADS
       @pool = []
 

data/lib/ustate/state.rb

@@ -34,11 +34,10 @@ module UState
       init.service ||= mode states.map(&:service)
 
       # Time
-      init.time ||= begin
-        (states.inject(0) do |a, state|
-          a + state.time.to_f
-        end / states.size).to_i
-      rescue
+      init.time = begin 
+        times = states.map(&:time).compact
+        (times.inject(:+) / times.size).to_i
+      rescue 
       end
       init.time ||= Time.now.to_i
 
@@ -69,10 +68,9 @@ module UState
       init.service ||= mode states.map(&:service)
 
       # Time
-      init.time ||= begin
-        (states.inject(0) do |a, state|
-          a + state.time.to_f
-        end / states.size).to_i
+      init.time = begin 
+        times = states.map(&:time).compact
+        (times.inject(:+) / times.size).to_i
       rescue 
       end
       init.time ||= Time.now.to_i
@@ -104,11 +102,10 @@ module UState
       end
 
       # Time
-      init.time ||= begin
-        (states.inject(0) { |a, state|
-          a + state.time.to_f
-        } / states.size).to_i
-      rescue
+      init.time = begin 
+        times = states.map(&:time).compact
+        (times.inject(:+) / times.size).to_i
+      rescue 
       end
       init.time ||= Time.now.to_i
 
@@ -145,6 +142,12 @@ module UState
       end
     end
 
+    def initialize(*a)
+      super *a
+
+      @time ||= Time.now.to_i
+    end
+
     def metric
       @metric || metric_f
     end

data/lib/ustate/version.rb

@@ -1,3 +1,3 @@
 module UState
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ustate-client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-13 00:00:00.000000000Z
+date: 2011-09-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beefcake
-  requirement: &69429590 !ruby/object:Gem::Requirement
+  requirement: &73107330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *69429590
+  version_requirements: *73107330
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &69428990 !ruby/object:Gem::Requirement
+  requirement: &73106920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.16.2
   type: :runtime
   prerelease: false
-  version_requirements: *69428990
+  version_requirements: *73106920
 - !ruby/object:Gem::Dependency
   name: mtrc
-  requirement: &69428610 !ruby/object:Gem::Requirement
+  requirement: &73106530 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *69428610
+  version_requirements: *73106530
 description: 
 email: aphyr@aphyr.com
 executables: []
@@ -54,6 +54,7 @@ files:
 - lib/ustate/graphite.rb
 - lib/ustate/query_string.treetop
 - lib/ustate/message.rb
+- lib/ustate/auto_state.rb
 - lib/ustate/metric_thread.rb
 - lib/ustate/aggregator.rb
 - lib/ustate/version.rb