dboard 3.2.2 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf9252b64db369ffc253e270f6fffaf640b552dd6baf6afb46d19925a5d0141
-  data.tar.gz: 9f531c357070278e600b2a31a7eb2a0020069d4aef969bab1bdb7ddbd3c50b2d
+  metadata.gz: a9931a1f53b9ace7790cebe3ea4ae8a63048f94a46060c39b331016c85c49d2a
+  data.tar.gz: eaf80b9f6c5d057a904308fe60c2f1408627d53b0f211a13b2c22ff594d23756
 SHA512:
-  metadata.gz: e94447daf4a183474fa0648b56a85135618b7378dbc0bfa0251ac41eae69193e096f1a19f28c4cd092e49deeb063f6a19b4e677f1188a01a676e6ee29804d3e1
-  data.tar.gz: d0faa64446c6544422d5bc235387c6981742190756118cd9a391439973cb2e9d4b5f7bdccca10355a64e122b0b5b6842ff3a124a4db080813cddb086388082f7
+  metadata.gz: a429b056de777feda66bf30e80c3341acb03ae4443bb8bbd8de8ed3d29870580a1749fa8c9adeff684fba463b2d3fdfae54b6ce55e8111bb10496b8d7693b42a
+  data.tar.gz: 15e09890a79432bdbff0a2297fd8c192393e0156f7829544da8cc9e0d5d6641e0064c8c504338298bb4bce22a2a5e1f11a289078d8d86662416b9800af2afdba

data/lib/collector.rb

@@ -1,3 +1,4 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "logging"))
 require File.expand_path(File.join(File.dirname(__FILE__), "publisher"))
 require "singleton"
 
@@ -103,8 +104,8 @@ module Dboard
         @after_update_callback.call
       end
     rescue Exception => ex
-      puts "Failed to update #{source}: #{ex.message}"
-      puts ex.backtrace
+      Dboard.logger.error("Failed to update #{source}: #{ex.message}")
+      Dboard.logger.error(ex.backtrace.join("\n"))
       @error_callback.call(ex)
     end
 
@@ -158,8 +159,8 @@ module Dboard
         break if cleared
       end
     rescue Exception => ex
-      puts "Something failed in the update worker for #{key}: #{ex.message}"
-      puts ex.backtrace
+      Dboard.logger.error("Something failed in the update worker for #{key}: #{ex.message}")
+      Dboard.logger.error(ex.backtrace.join("\n"))
     ensure
       @mutex.synchronize { @active[key] = false } unless cleared
     end
@@ -189,7 +190,7 @@ module Dboard
 
         started = monotonic_now
         update_source(source, instance, batch)
-        puts [ "#{source} refreshed", describe_batch(batch), "in #{(monotonic_now - started).round(1)}s" ].compact.join(" ")
+        Dboard.logger.info([ "#{source} refreshed", describe_batch(batch), "in #{(monotonic_now - started).round(1)}s" ].compact.join(" "))
         true
       }
     end

data/lib/logging.rb

@@ -0,0 +1,11 @@
+require "logger"
+
+module Dboard
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new($stdout)
+    end
+  end
+end

data/lib/publisher.rb

@@ -1,3 +1,4 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "logging"))
 require "json"
 
 module Dboard
@@ -5,7 +6,7 @@ module Dboard
     def self.publish(source, data)
       Api::Client.post("/sources/#{source}", body: { data: data.to_json }, timeout: 10000)
     rescue SocketError => ex
-      puts "SocketError: #{ex.message}"
+      Dboard.logger.error("SocketError: #{ex.message}")
     end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Dboard
-  VERSION = "3.2.2"
+  VERSION = "3.2.3"
 end

data/spec/collector_spec.rb

@@ -105,7 +105,6 @@ RSpec.describe Dboard::Collector do
       allow(new_relic).to receive(:fetch).and_raise(error)
       allow(callback).to receive(:call)
       allow(Dboard::Publisher).to receive(:publish)
-      allow_any_instance_of(Dboard::Collector).to receive(:puts)
       Dboard::Collector.register_error_callback callback
 
       Dboard::Collector.instance.update_source(:new_relic, new_relic)
@@ -133,13 +132,13 @@ RSpec.describe Dboard::Collector do
       expect(Dboard::Publisher).to have_received(:publish).with(:new_relic, { db: "100%" })
     end
 
-    it "prints out debugging info" do
+    it "logs debugging info" do
       allow(new_relic).to receive(:fetch).and_raise(Exception.new("some error"))
-      allow(Dboard::Collector.instance).to receive(:puts)
+      allow(Dboard.logger).to receive(:error)
 
       Dboard::Collector.instance.update_source(:new_relic, new_relic)
 
-      expect(Dboard::Collector.instance).to have_received(:puts).twice
+      expect(Dboard.logger).to have_received(:error).twice
     end
   end
 
@@ -148,7 +147,6 @@ RSpec.describe Dboard::Collector do
 
     before do
       reset_collector!
-      allow(collector).to receive(:puts)
       allow(Dboard::Publisher).to receive(:publish)
     end
 

data/spec/publisher_spec.rb

@@ -26,8 +26,11 @@ describe "Publisher", ".publish" do
 
   # 2021-12-07: No idea why we've treated this one specially, but keeping it for now.
   it "logs socket errors if we run out of retries" do
-    expect(Dboard::Api::Client).to receive(:post).and_raise(SocketError.new("failed to connect"))
-    expect(Dboard::Publisher).to receive(:puts).with("SocketError: failed to connect")
+    allow(Dboard::Api::Client).to receive(:post).and_raise(SocketError.new("failed to connect"))
+    allow(Dboard.logger).to receive(:error)
+
     Dboard::Publisher.publish(:new_relic, {})
+
+    expect(Dboard.logger).to have_received(:error).with("SocketError: failed to connect")
   end
 end

data/spec/spec_helper.rb

@@ -11,3 +11,5 @@ require File.expand_path(File.join(File.dirname(__FILE__), "../lib/dboard"))
 Dboard::Api::Client.endpoints = [
   { base_uri: ENV["API_URL"], basic_auth: [ ENV["API_USER"], ENV["API_PASSWORD"] ] },
 ]
+
+Dboard.logger = Logger.new(IO::NULL)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dboard
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.2.3
 platform: ruby
 authors:
 - Joakim Kolsjö
@@ -113,6 +113,7 @@ files:
 - lib/collector.rb
 - lib/config.rb
 - lib/dboard.rb
+- lib/logging.rb
 - lib/publisher.rb
 - lib/version.rb
 - spec/collector_spec.rb