txcatcher 0.1.79 → 0.1.80

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d59cc16bf5e45f94d7e985ae349c9df72c0a07c3
-  data.tar.gz: 4c38a0be61645875a0103e421d6ca6b5119368c1
+  metadata.gz: 7d2ec242dcffc29ac886983fba7ab7059465a9c4
+  data.tar.gz: f6846d3b51cfbd75e255349869aea3f0025b8162
 SHA512:
-  metadata.gz: ace16685e76eca3039acf6b4b91e1f625a431e05a5ea2c07cf5a2dfd11072843a8e027668d2accc25ea776e893d616200003408a5db5552eba49b426368fffea
-  data.tar.gz: 228a20993a98902b88ce773e2efa25d7442214ccc6f9bfb68ac804e9f3732eefd4e4e96b9629ddd4aceeeb3de220617ce681d688f1787e52b7b0aab4cc62a539
+  metadata.gz: '0832cce4418a861b4953ac158c346608f5d8e72ae5cd89a7a08ae89216321c1f0f2770140e3e561e95277da3c3629606b8d3e12f5569e586711ca802d3933d79'
+  data.tar.gz: 5a1105b971ec62a6598781eee994e90993cd780fab2cf495dcb05c305dd34766ae9944624390af047fce31340967c1b8d9a29868800ffcbb9795821d67244e1b

data/Gemfile

@@ -4,6 +4,7 @@ gem "goliath"
 gem "sequel"
 gem "ffi-rzmq"
 gem "satoshi-unit"
+gem "sentry-raven"
 
 group :development do
   gem "bundler"

data/Gemfile.lock

@@ -95,6 +95,8 @@ GEM
     rspec-support (3.7.1)
     satoshi-unit (0.2.2)
     semver2 (3.4.2)
+    sentry-raven (2.6.3)
+      faraday (>= 0.7.6, < 1.0)
     sequel (5.5.0)
     sqlite3 (1.3.13)
     thread_safe (0.3.6)
@@ -109,6 +111,7 @@ DEPENDENCIES
   jeweler
   rspec
   satoshi-unit
+  sentry-raven
   sequel
   sqlite3
 

data/VERSION

@@ -1 +1 @@
-0.1.79
+0.1.80

data/lib/txcatcher/catcher.rb

@@ -9,7 +9,7 @@ module TxCatcher
      @sockets  = {}
 
       {'rawtx' => "#{socket}#{name}.rawtx", 'hashblock' => "#{socket}#{name}.hashblock"}.each do |channel, address|
-        puts "Start listening on #{name} #{channel}... (#{address})"
+        Logger.report "Start listening on #{name} #{channel}... (#{address})"
         listen_to_zeromq_message(channel: channel, address: address)
       end
     end
@@ -32,18 +32,16 @@ module TxCatcher
         # before we start listening to any messages from ZeroMQ.
         queue_thread = Thread.new do
           loop do
-            puts "in #{channel} queue: #{@queue[channel].size}"
+            Logger.report "in #{channel} queue: #{@queue[channel].size}" if Config["logger"]["log_queue_info"]
             if @queue[channel].empty?
               sleep 1
             else
               begin
                 @queue[channel].pop.call
               rescue Sequel::ValidationFailed => e
-                $stdout.puts "[WARNING #{Time.now.to_s}] #{e.class} #{e.to_s}\n"
+                Logger.report e, :warn, timestamp: true
               rescue StandardError => e
-                File.open(TxCatcher::Config.config_dir + "/error.log", "a") do |f|
-                  f.puts "[ERROR #{Time.now.to_s}] #{e.class} #{e.to_s}\n  #{e.backtrace.join("\n  ")}\n\n"
-                end
+                Logger.report e, :error, timestamp: true
               end
             end
           end
@@ -77,14 +75,14 @@ module TxCatcher
       end # listen_to_zeromq_message
 
       def handle_rawtx(txhex)
-        $stdout.print "received tx hex: #{txhex[0..50]}...\n"
+        Logger.report "received tx hex: #{txhex[0..50]}..."
 
         @queue["rawtx"] << ( Proc.new {
           tx = TxCatcher::Transaction.new(hex: txhex)
           tx.save
-          $stdout.puts "tx #{tx.txid} saved (id: #{tx.id}), deposits (outputs):"
+          Logger.report "tx #{tx.txid} saved (id: #{tx.id}), deposits (outputs):"
           tx.deposits.each do |d|
-            $stdout.puts "  id: #{d.id}, addr: #{d.address.address}, amount: #{Satoshi.new(d.amount, from_unit: :satoshi).to_btc}"
+            Logger.report "  id: #{d.id}, addr: #{d.address.address}, amount: #{Satoshi.new(d.amount, from_unit: :satoshi).to_btc}"
           end
         })
       end
@@ -93,7 +91,7 @@ module TxCatcher
         block_hash   = TxCatcher.rpc_node.getblock(block_hex)
         transactions = block_hash["tx"]
         height       = TxCatcher.current_block_height = block_hash["height"].to_i
-        $stdout.puts "*** Block #{height} mined, transactions received:\n  #{transactions.join("  \n")}"
+        Logger.report "*** Block #{height} mined, transactions received:\n  #{transactions.join("  \n")}"
         @queue["hashblock"] << ( Proc.new {
           Transaction.where(txid: transactions).update(block_height: height)
         })

data/lib/txcatcher/cleaner.rb

@@ -19,14 +19,14 @@ module TxCatcher
           else
             TxCatcher::Transaction.count
           end
-          $stdout.print "Cleaning transactions in DB..."
-          $stdout.print "#{db_tx_count} now, needs to be below #{Config.max_db_transactions_stored}\n"
+          Logger.report "Cleaning transactions in DB..."
+          Logger.report "#{db_tx_count} now, needs to be below #{Config.max_db_transactions_stored}\n"
           if db_tx_count > Config.max_db_transactions_stored
             number_to_delete = (db_tx_count - Config.max_db_transactions_stored) + (Config.max_db_transactions_stored*0.1).round
             clean_transactions(number_to_delete)
-            $stdout.puts "DB cleaned: #{@@cleaning_counter.to_s}"
+            Logger.report "DB cleaned: #{@@cleaning_counter.to_s}"
           else
-            $stdout.puts "Nothing to be cleaned from DB, size is below threshold."
+            Logger.report "Nothing to be cleaned from DB, size is below threshold."
           end
           if @stop || run_once
             @@stopped = true
@@ -58,7 +58,7 @@ module TxCatcher
         t.times do
           limit = n <= 100 ? n : 100
           transactions.limit(limit).each do |t|
-            $stdout.puts "- Removing tx #{t.txid}"
+            Logger.report "- Removing tx #{t.txid}"
             clean_deposits(t)
             TxCatcher.db_connection[:transactions].filter(id: t.id).delete
             @@cleaning_counter[:transactions] += 1

data/lib/txcatcher/initializer.rb

@@ -18,17 +18,19 @@ module TxCatcher
         # Determine config dir or set default. Useful when we want to
         # have different settings for production or staging or development environments.
         def set!(path=nil)
-          @@config_file = path and return if path
-          @@config_file = ENV['HOME'] + '/.txcatcher/config.yml'
-          ARGV.each_with_index do |a,i|
-            if a =~ /\A--config-file=.+/
-              @@config_file = File.expand_path(a.sub('--config-file=', ''))
-              ARGV.delete_at(i)
-              break
-            elsif a =~ /\A-c\Z/
-              @@config_file = File.expand_path(ARGV[1])
-              ARGV.delete_at(i) and ARGV.delete_at(i+1)
-              break
+          @@config_file = path
+          unless path
+            @@config_file = ENV['HOME'] + '/.txcatcher/config.yml'
+            ARGV.each_with_index do |a,i|
+              if a =~ /\A--config-file=.+/
+                @@config_file = File.expand_path(a.sub('--config-file=', ''))
+                ARGV.delete_at(i)
+                break
+              elsif a =~ /\A-c\Z/
+                @@config_file = File.expand_path(ARGV[1])
+                ARGV.delete_at(i) and ARGV.delete_at(i+1)
+                break
+              end
             end
           end
           TxCatcher::Config.config_dir = File.dirname(@@config_file)
@@ -45,6 +47,7 @@ module TxCatcher
 
     def prepare
       ConfigFile.set!
+      initialize_sentry
       create_config_files
       read_config_file
       connect_to_db
@@ -149,6 +152,13 @@ module TxCatcher
       !Sequel::Migrator.is_current?(TxCatcher.db_connection, MIGRATIONS_ROOT)
     end
 
+    def initialize_sentry
+      Raven.configure do |config|
+        config.dsn          = Config["sentry"]["dsn"]
+        config.environments = ["production"]
+      end if Config["sentry"] && Config["sentry"]["dsn"]
+    end
+
   end
 
 end

data/lib/txcatcher/logger.rb

@@ -0,0 +1,63 @@
+module TxCatcher
+
+  class Logger
+
+    LOG_LEVELS = {
+      info: 1,
+      warn: 2,
+      error: 3,
+      fatal: 4,
+      unknown: 5
+    }
+
+    class << self
+
+      def report(message, log_level=:info, data: nil, timestamp: false)
+        [:logfile, :stdout, :sentry].each do |out|
+          if LOG_LEVELS[log_level] >= LOG_LEVELS[Config["logger"]["#{out}_level"].to_sym]
+            send("report_to_#{out}", message, log_level, data: data, timestamp: timestamp) 
+          end
+        end
+      end
+
+      private
+
+        def report_to_stdout(message, log_level, data: nil, timestamp: timestamp)
+          $stdout.print prepare_message(message, timestamp: timestamp) + "\n"
+          $stdout.print "  additional data: #{data.to_s}" if data
+          $stdout.print("\n\n") if LOG_LEVELS[log_level] >= LOG_LEVELS[:error]
+        end
+
+        def report_to_logfile(message, log_level, data: nil, timestamp: timestamp)
+          fn = LOG_LEVELS[log_level] >= LOG_LEVELS[:error] ? "error.log" : "txcatcher.log"
+          fn = TxCatcher::Config.config_dir + "/#{fn}"
+
+          File.open(fn, "a") do |f|
+            f.print "[#{log_level.to_s.upcase} #{Time.now.to_s}] #{prepare_message(message, timestamp: timestamp)}\n"
+            f.print "  additional data: #{data.to_s}" if data
+            f.print("\n\n") if LOG_LEVELS[log_level] >= LOG_LEVELS[:error]
+          end
+        end
+
+        def report_to_sentry(e, log_level, data: nil, timestamp: timestamp)
+          e.kind_of?(Exception) ? Raven.capture_exception(e, extra: data) : Raven.capture_message(e, extra: data)
+        end
+
+        def prepare_message(e, timestamp: false)
+          result = if e.kind_of?(Exception)
+            result =  e.to_s + "\n"
+            result += e.message + "\n\n" if e.message != e.to_s
+            result += (e.backtrace&.join("\n") || "[no backtrace]")
+            result
+          else
+            e
+          end
+          result = "[#{Time.now}] #{result}" if timestamp
+          result
+        end
+
+    end
+
+  end
+
+end

data/lib/txcatcher/models/transaction.rb

@@ -62,9 +62,9 @@ module TxCatcher
         block_hash = TxCatcher.rpc_node.getblockhash(TxCatcher.current_block_height - i)
         block      = TxCatcher.rpc_node.getblock(block_hash)
         i += 1
-        $stdout.puts "--- checking block #{TxCatcher.current_block_height - i} for tx #{self.txid}"
+        Logger.report "--- checking block #{TxCatcher.current_block_height - i} for tx #{self.txid}"
         if block["tx"] && block["tx"].include?(self.txid)
-          $stdout.puts "tx #{self.txid} block height updated to #{block["height"]}"
+          Logger.report "tx #{self.txid} block height updated to #{block["height"]}"
           self.update(block_height: block["height"])
           return block["height"].to_i
         end

data/lib/txcatcher.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'thread'
 require 'satoshi-unit'
 require 'sequel'
+require 'sentry-raven'
 Sequel.extension :migration
 
 require_relative 'txcatcher/utils/hash_string_to_sym_keys'
@@ -12,6 +13,7 @@ require_relative 'txcatcher/config'
 require_relative 'txcatcher/initializer'
 require_relative 'txcatcher/catcher'
 require_relative 'txcatcher/cleaner'
+require_relative 'txcatcher/logger'
 
 include TxCatcher::Initializer
 prepare

data/spec/config/config.yml.sample

@@ -17,7 +17,17 @@ rpcnode:
   host: 127.0.0.1
   port: 8332
 
+logger:
+  log_queue_info: false
+  stdout_level: info
+  logfile_level: info
+  sentry_level: info
+  sentry:
+    dsn: null
+    client_dsn: null
+
 # zeromq: bitcoind
 max_db_transactions_stored: 10
 db_clean_period_seconds: 300
 protected_transactions: true
+environment: development

data/spec/logger_spec.rb

@@ -0,0 +1,64 @@
+require 'rubygems'
+require_relative 'spec_helper'
+
+RSpec.describe TxCatcher::Logger do
+
+  describe "logging to logfiles" do
+
+    it "writes info messages to txcatcher.log" do
+      TxCatcher::Logger.report "example info message", :info
+      expect(File.read(LOGFILE)).to include("example info message")
+    end
+
+    it "writes errors into a separate error.log file" do
+      TxCatcher::Logger.report "example error message", :error
+      expect(File.read(ERRFILE)).to include("example error message")
+    end
+
+  end
+
+  describe "sending to Sentry" do
+
+    it "logs messages to Sentry" do
+      expect(Raven).to receive(:capture_message).once
+      TxCatcher::Logger.report "example info message", :info
+      TxCatcher::Logger.report "example error message", :error
+    end
+
+    it "logs errors to Sentry" do
+      expect(Raven).to receive(:capture_exception).once
+      TxCatcher::Logger.report StandardError.new, :error
+    end
+
+  end
+
+  it "logs to stdout" do
+    expect($stdout).to receive(:print).exactly(3).times
+    TxCatcher::Logger.report "example info message", :info
+    TxCatcher::Logger.report "example error message", :error
+  end
+
+  it "doesn't log an message if its loglevel is below current threshold" do
+    TxCatcher::Config["logger"]["stdout_level"] = "fatal"
+    expect($stdout).to receive(:print).exactly(2).times
+    TxCatcher::Logger.report "example info message",  :info
+    TxCatcher::Logger.report "example warn message",  :warn
+    TxCatcher::Logger.report "example error message", :error
+    TxCatcher::Logger.report "example fatal message", :fatal
+    TxCatcher::Config["logger"]["stdout_level"] = "info"
+  end
+
+  it "converts Exception into a text for logging" do
+    expect($stdout).to receive(:print).with("StandardError\n[no backtrace]\n")
+    expect($stdout).to receive(:print).with("\n\n")
+    TxCatcher::Logger.report StandardError.new, :error
+  end
+
+  it "prints additional data passed along" do
+    expect($stdout).to receive(:print).with("example error message\n")
+    expect($stdout).to receive(:print).with('  additional data: {:hello=>"world"}')
+    expect($stdout).to receive(:print).with("\n\n")
+    TxCatcher::Logger.report "example error message", :error, data: { hello: "world" }
+  end
+
+end

data/spec/spec_helper.rb

@@ -3,11 +3,13 @@ require 'yaml'
 require 'json'
 require 'satoshi-unit'
 require 'sequel'
+require 'sentry-raven'
 Sequel.extension :migration
 
 db_file = File.dirname(__FILE__) + "/config/txcatcher_test.db"
 File.delete(db_file) if File.exists?(db_file)
 
+require_relative '../lib/txcatcher/logger'
 require_relative '../lib/txcatcher/utils/hash_string_to_sym_keys'
 require_relative '../lib/txcatcher/config'
 require_relative '../lib/txcatcher/initializer'
@@ -17,6 +19,7 @@ include TxCatcher::Initializer
 ConfigFile.set!(File.dirname(__FILE__) + "/config/config.yml")
 
 read_config_file
+initialize_sentry
 connect_to_db
 run_migrations if migrations_pending?
 connect_to_rpc_node
@@ -31,8 +34,10 @@ end
 
 RSpec.configure do |config|
 
-  config.default_formatter = 'doc'
+  LOGFILE = File.expand_path(File.dirname(__FILE__) + "/config/txcatcher.log")
+  ERRFILE = File.expand_path(File.dirname(__FILE__) + "/config/error.log")
 
+  config.default_formatter = 'doc'
   config.before(:all) do
   end
 
@@ -45,4 +50,10 @@ RSpec.configure do |config|
     TxCatcher::Address.select_all.delete
   end
 
+  config.after(:each) do
+    [LOGFILE, ERRFILE].each do |f|
+      FileUtils.rm(f) if File.exist?(f)
+    end
+  end
+
 end

data/templates/config.yml

@@ -17,8 +17,18 @@ rpcnode:
   host: 127.0.0.1
   port: 8332
 
+logger:
+  log_queue_info: false
+  stdout_level: info
+  logfile_level: warn
+  sentry_level: error
+  sentry:
+    dsn: null
+    client_dsn: null
+
 zeromq: bitcoind
 max_db_transactions_stored: 100000
 db_clean_period_seconds: 300
 server_port: 9498
 daemonize: false
+environment: production

data/txcatcher.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: txcatcher 0.1.79 ruby lib
+# stub: txcatcher 0.1.80 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "txcatcher"
-  s.version = "0.1.79"
+  s.version = "0.1.80"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txcatcher
 version: !ruby/object:Gem::Version
-  version: 0.1.79
+  version: 0.1.80
 platform: ruby
 authors:
 - Roman Snitko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sentry-raven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +144,7 @@ files:
 - lib/txcatcher/cleaner.rb
 - lib/txcatcher/config.rb
 - lib/txcatcher/initializer.rb
+- lib/txcatcher/logger.rb
 - lib/txcatcher/models/address.rb
 - lib/txcatcher/models/deposit.rb
 - lib/txcatcher/models/transaction.rb
@@ -140,6 +155,7 @@ files:
 - spec/config/config.yml.sample
 - spec/fixtures/transaction.txt
 - spec/fixtures/transaction_decoded_no_outputs.txt
+- spec/logger_spec.rb
 - spec/models/transaction_spec.rb
 - spec/spec_helper.rb
 - templates/config.yml