arvicco-avalon 0.0.5 → 0.0.6

data/README.md

@@ -2,23 +2,35 @@
 
 Helper scripts for Bitcoin and Avalon miners management...
 
+## Description
+
+Congrats, you've got a few Avalon miners. It's all nice and dandy, but now you need to keep an eye on them to make sure they are always online and their valuable hashes are not wasted. This set of scripts is written to do just that. You run a monitor scipt non-stop and it keeps an eye on your Avalons, your (private) pool and your Internet connection, and alerts you as soon as there are any problems. The scripts should work on OSX and Linux (Windows users, move on).
+
 ## Usage
 
 Scripts:
 
-$ bin/monitor [environment]
+    $ monitor [environment]
 
-- Monitors all the nodes (miners, pools, Internet connections) that are listed in config/monitor.yml file. Sounds alarm is anything is wrong with the monitored nodes. TODO: takes action to correct errors found (like restarting the miners etc).
+- Monitors all the nodes (miners, pools, Internet connections) that are listed in config/monitor.yml file. Sounds alarm is anything is wrong with the monitored nodes. TODO: takes action to correct errors found (like restarting the failing miners etc).
 
-$ mtgox_tx
+    $ mtgox_tx
 
 - Transcodes raw transaction from base64 (mtgox) to hex (blockchain) format
 
+## Installation
+
+You need Ruby 1.9 to install the scripts. Once the Ruby is installed, it's just:
+
+    $ gem install arvicco-avalon
+
+You need to be able to ssh with public keys (that is no password required) into any Pool or Bitcoind node for monitor to work. How to do it is beyound the scope of this Readme, just google it. You also need to create ~/.avalon/monitor.yml config file, see below.
+
 ## Configuration
 
-Sample monitor config file for production environment below. Modify it, add your own nodes to be monitored (for Avalon miners, you have to set their IP address and min hashrate in Gh/s):
+Sample monitor config file for production environment below. Modify it, add your own nodes to be monitored (for Avalon miners, you have to indicate their IP address and min hashrate in Gh/s):
 
-    ------- config/monitor.yml --------
+    ------- ~/.avalon/monitor.yml --------
     # Prod configuration (default)
     prod:
       :bitcoind:

data/lib/avalon/config.rb

@@ -1,16 +1,18 @@
 module Avalon
   # Global Config
   class Config
+    extend Utils # Helper methods
 
     def self.load env
-      config_file = [
-        File.expand_path('../../../config/monitor.yml', __FILE__),
-        File.expand_path('~/.avalon/monitor.yml', __FILE__),
-      ].find {|f| File.exist?(f)}
+      config_file = find_file( '../../../config/monitor.yml', '~/.avalon/monitor.yml')
 
       raise "No config file: #{config_file}" unless File.exist? config_file
 
       @config = YAML::load_file(config_file)[env]
+      @config[:environment] = env
+      @config[:block_file] =  find_file( '../../../config/blocks.yml',
+                                         '~/.avalon/blocks.yml') || '~/.avalon/blocks.yml'
+
     end
 
     def self.[] key

data/lib/avalon/eloipool.rb

@@ -6,7 +6,7 @@ module Avalon
       @ip = ip
       @update_frequency = frequency
       @update_num = 0
-      @block_file = File.expand_path('../../../config/blocks.yml', __FILE__)
+      @block_file = Avalon::Config[:block_file]
       @blocks = load_blocks || {}
       super()
     end

data/lib/avalon/miner.rb

@@ -40,6 +40,7 @@ module Avalon
       @num = ip.split('.').last.to_i
       @min_speed = min_speed * 1000 # Gh/s to Mh/s
       @fails = 0
+      @status_fails_to_alarm = Avalon::Config[:status_fails_to_alarm]
       super()
     end
 
@@ -71,7 +72,7 @@ module Avalon
     def report
       if data[:ping].nil?
         @fails += 1
-        if @fails >= Avalon::Config[:status_fails_to_alarm] || 1
+        if @fails >= @status_fails_to_alarm || 1
           alarm "Miner #{@num} did not respond to status query"
         end
       else

data/lib/avalon/utils.rb

@@ -5,13 +5,14 @@ module Avalon
       @system = `uname -a`.match(/^\w*/).to_s
     end
 
+    def find_file *locations
+      locations.map {|loc| File.expand_path(loc,__FILE__)}.find {|f| File.exist?(f)}
+    end
+
     # Helper method: play a sound file
     def play tune
-      file = [ tune,
-               File.expand_path("../../../sound/#{tune}", __FILE__),
-               File.expand_path("~/sound/#{tune}", __FILE__),
-               File.expand_path("/System/Library/Sounds/#{tune}"),
-               ].find {|f| File.exist?(f)}
+      file = find_file( tune, "../../../sound/#{tune}",
+        "~/.avalon/sound/#{tune}", "/System/Library/Sounds/#{tune}")
 
       case system
       when 'Darwin'

data/lib/avalon/version.rb

@@ -1,3 +1,3 @@
 module Avalon
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arvicco-avalon
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday