ducksboard_reporter 0.1.9 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97c05a91c7f6ad158d30731b2a67495ca44cc88b
-  data.tar.gz: c2f89dc1cbeaca7c2c836118839e1dedc19c3d88
+  metadata.gz: 11d10360f1a5542c45e2a91f852fb0f34dd3e0ff
+  data.tar.gz: 8f9c0b770d84c021a69950d4c878cc02b53908df
 SHA512:
-  metadata.gz: 1f678da73b2bdf7111138ca50cc7bf0dd7aec014a2931e95c864e1141f2881e95da4dfde00e02a393b55f4c0edaa4327428c9988a97a0f9a43e4334be9b7a222
-  data.tar.gz: e75957dc461d82f0774f6fcf6f5332b21503155e507847148ddfdd874566ea423997e247350bc7a2ecffb3c23d5e50024f1e86c9d3f78961a967ce066c18e1b1
+  metadata.gz: 6dbc5a31490055edb80c6f9e15a0cc1f4c3fce47cf5db3fd57c9092b052f9bbd991a60a45268933c683a52ec10b9f64803595df8a226be1e5c3056c56591fcf6
+  data.tar.gz: 7b04ea73a6c0cbf1dbfe55d129c79d9162c1693f0e44e4891dc9aa8aa9bda30b5f6f66440f1e7a6ee17cc15f3d40cde96233cdc6045afd48a2c16ff78d4eb707

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/README.md

@@ -1,6 +1,6 @@
 # DucksboardReporter
 
-TODO: Write a gem description
+Ducksnoard is a cool dashboard as a service like geckoboard but looks nicer. This project can be seen as a infrastructure for and a collection of reporters that report values to ducksboard. In a way reporters are similar to nagios agents, but for generation pokemon. Surely it could turn into a more abstract reporter framework that can report to geckoboard, nagios, whatever aswell. Right now we use ducksboard, so it is for ducksboard.
 
 ## Installation
 
@@ -18,7 +18,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To run your reporters just launch it via
+	
+	ducksboard_reporter -f /your/config_file.yml
+
+See example_config.yml for in about the format etc.
+
+To run in a production environment you could wrap in into a daemon and let it be managed by the init system du jour.
+
+You can build new reporters by inheriting from DucksboardReporter::Reporters::Reporter and implement your own #collect method which must set @value. See existing reporters for examples.
+
+## Changelog
+
+* bumped version number to 0.2.0 since it now has mysql reporters
 
 ## Contributing
 

data/ducksboard_reporter.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "fuubar"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "parallel_tests"
 
   spec.add_runtime_dependency "ducksboard", "~> 0.1.6"
   spec.add_runtime_dependency "hashie", ">= 3.3.1"

data/example_config.yml

@@ -10,14 +10,9 @@ reporters:
     options:
       log_file: haproxy.log
 
-  - name: honeybadger
-    type: Honeybadger
-    options:
-      api_key: 58L5pGcr82Vm11G1HHG6
-      project_id: 2948
-
 widgets:
   - type: Box
     id: 506475
-    reporter: honeybadger
-    value: :unresolved_fault_count
+    reporter: random
+    value:
+      current: :value

data/lib/ducksboard_reporter.rb

@@ -1,11 +1,9 @@
 require "rubygems"
-
 require "logger"
 require "celluloid"
 require "timers"
 require "ducksboard"
 require "hashie/extensions/symbolize_keys"
-Hash.include Hashie::Extensions::SymbolizeKeys
 
 require "ducksboard_reporter/version"
 require "ducksboard_reporter/reporter"
@@ -19,6 +17,10 @@ require "ducksboard_reporter/reporters/haproxy_log_requests"
 require "ducksboard_reporter/reporters/cpu_usage"
 require "ducksboard_reporter/reporters/bandwidth"
 require "ducksboard_reporter/reporters/honeybadger"
+require "ducksboard_reporter/reporters/mysql_base"
+require "ducksboard_reporter/reporters/mysql_queries_per_second"
+require "ducksboard_reporter/reporters/mysql_slow_queries"
+require "ducksboard_reporter/reporters/mysql_innodb_rows_reads_per_second"
 
 Thread.abort_on_exception = true
 
@@ -36,11 +38,24 @@ module DucksboardReporter
     attr_reader :config, :reporters, :widgets
 
     def initialize(config)
-      @config = config.symbolize_keys!
+      @config = symbolize_keys(config)
       register_reporters
       register_widgets
     end
 
+    def symbolize_keys(hash)
+      hash.inject({}) do |result, (key, value)|
+        new_key = key.is_a?(String) ? key.to_sym : key
+        new_value = case value
+                    when Hash then symbolize_keys(value)
+                    when Array then value.map {|v| symbolize_keys(v) }
+                    else value
+                    end
+        result[new_key] = new_value
+        result
+      end
+    end
+
     def start
       Signal.trap("INT") { exit }
 
@@ -63,7 +78,6 @@ module DucksboardReporter
 
     def register_widgets
       @widgets = []
-
       @config[:widgets].each do |config|
         reporter = @reporters.fetch(config[:reporter])
 

data/lib/ducksboard_reporter/reporters/cpu_usage.rb

@@ -1,7 +1,6 @@
 module DucksboardReporter
   module Reporters
     class CpuUsage < Reporter
-
       def collect
         stats = nil
         while true do

data/lib/ducksboard_reporter/reporters/mysql_base.rb

@@ -0,0 +1,37 @@
+module DucksboardReporter
+  module Reporters
+    class MySqlBase < Reporter
+
+      def period
+        1
+      end
+
+      def collect
+        update # this is important!
+        every(period) do
+          update
+        end
+      end
+
+      def update
+        begin
+          @current_stats = gather_stats
+        rescue Errno::ENOENT
+          error("MysqlQueriesPerSecond: failed to use mysqladmin status")
+          return
+        end
+
+        self.value = moderated_stats
+      end
+
+      def moderated_stats
+        # default is to just take the absolute value
+        @current_stats
+      end
+
+      def gather_stats
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/ducksboard_reporter/reporters/mysql_innodb_rows_reads_per_second.rb

@@ -0,0 +1,10 @@
+module DucksboardReporter
+  module Reporters
+    class MySqlInnodbRowsReadsPerSecond < MySqlBase
+      def gather_stats
+        out = `mysql -e 'SHOW ENGINE INNODB STATUS\\G'`.scan(/([-+]?[0-9]*\.?[0-9]+) (reads\/s)/)
+        out.nil? ? 0 : out[2][0]
+      end
+    end
+  end
+end

data/lib/ducksboard_reporter/reporters/mysql_queries_per_second.rb

@@ -0,0 +1,10 @@
+module DucksboardReporter
+  module Reporters
+    class MySqlQueriesPerSecond < MySqlBase
+      def gather_stats
+        out = `mysqladmin status`.match(/(Queries per second avg: )([-+]?[0-9]*\.?[0-9]+)/)
+        out.nil? ? 0 : out[2]
+      end
+    end
+  end
+end

data/lib/ducksboard_reporter/reporters/mysql_slow_queries.rb

@@ -0,0 +1,23 @@
+module DucksboardReporter
+  module Reporters
+    class MySqlSlowQueries < MySqlBase
+
+      def period
+        60
+      end
+
+      def gather_stats
+        out = `mysqladmin status`.match(/(Slow queries: )([-+]?[0-9]*\.?[0-9]+)/)
+        out.nil? ? 0 : out[2]
+      end
+
+      def moderated_stats
+        # in this case we want to know the delta
+        delta = @current_stats.to_i - @old_stats.to_i
+        @old_stats = @current_stats
+        debug(log_format("old: #{@old_stats}, current: #{@current_stats}, delta: #{delta}, thread id: #{Thread.current.object_id}"))
+        delta
+      end
+    end
+  end
+end

data/lib/ducksboard_reporter/reporters/random.rb

@@ -8,4 +8,3 @@ module DucksboardReporter
     end
   end
 end
-

data/lib/ducksboard_reporter/version.rb

@@ -1,3 +1,3 @@
 module DucksboardReporter
-  VERSION = "0.1.9"
+  VERSION = "0.2.4"
 end

data/lib/ducksboard_reporter/widget.rb

@@ -1,5 +1,6 @@
 module DucksboardReporter
   class Widget
+
     include Celluloid
     include Celluloid::Logger
 
@@ -26,8 +27,8 @@ module DucksboardReporter
       debug log_format("Updating value #{value}")
 
       @updater.update(value)
-    rescue Net::ReadTimeout, Net::OpenTimeout
-      # accept timeout errors
+    rescue *timeout_errors, Errno::ECONNRESET => e
+      error e
     end
 
     def interval
@@ -66,6 +67,15 @@ module DucksboardReporter
         object
       end
     end
+
+    def timeout_errors
+      v = RUBY_VERSION.split(".")[0].to_i
+      if v >= 2
+        [Net::ReadTimeout, Net::OpenTimeout]
+      else
+        [Timeout::Error]
+      end
+    end
   end
 end
 

data/lib/rund.rb

@@ -19,8 +19,6 @@ module Rund
     redirect_output
 
     close_local_stderr
-
-    Process.pid
   end
 
   def log_file=(path)

data/spec/ducksboard_reporter_spec.rb

@@ -11,7 +11,7 @@ describe DucksboardReporter::App do
   let(:widget) { app.widgets.first }
 
   it "registers reporters from config" do
-    expect(app.reporters.values.map(&:class)).to include(DucksboardReporter::Reporters::Random)
+    expect(app.reporters.values.map(&:class)).to include(DucksboardReporter::Reporters::FooBar)
   end
 
   it "registers widgets from config" do
@@ -32,7 +32,7 @@ describe DucksboardReporter::App do
   describe "single widget" do
 
     it "sets id from config" do
-      expect(widget.id).to eq(1234)
+      expect(widget.id).to eq(123123)
     end
 
     it "references reporter" do

data/spec/mysql_reporter_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+describe DucksboardReporter::Reporters::MySqlQueriesPerSecond do
+  it "loads and starts" do
+    expect {
+      reporter = DucksboardReporter::Reporters::MySqlQueriesPerSecond.new("lala")
+      reporter.start
+    }.not_to raise_error
+  end
+end
+
+describe DucksboardReporter::Reporters::MySqlInnodbRowsReadsPerSecond do
+  it "loads and starts" do
+    expect {
+      reporter = DucksboardReporter::Reporters::MySqlInnodbRowsReadsPerSecond.new("lala")
+      reporter.start
+    }.not_to raise_error
+  end
+end
+
+describe DucksboardReporter::Reporters::MySqlSlowQueries do
+  it "loads and starts" do
+    expect {
+      reporter = DucksboardReporter::Reporters::MySqlSlowQueries.new("lala")
+      reporter.start
+    }.not_to raise_error
+  end
+
+  it "calculates the delta per period correctly" do
+    # example mysql status output
+    # Uptime: 16076688  Threads: 174  Questions: 3193188096  Slow queries: 1235560  Opens: 2218  Flush tables: 2  Open tables: 474  Queries per second avg: 198.622
+    # the way the current value is gathered:
+    # `mysqladmin status`.match(/(Slow queries: )([-+]?[0-9]*\.?[0-9]+)/)
+    EXAMPLE_OUT1 = "Uptime: 16076688  Threads: 174  Questions: 3193188096  Slow queries: 10  Opens: 2218  Flush tables: 2  Open tables: 474  Queries per second avg: 198.622"
+    EXAMPLE_OUT2 = "Uptime: 16076688  Threads: 174  Questions: 3193188096  Slow queries: 30  Opens: 2218  Flush tables: 2  Open tables: 474  Queries per second avg: 198.622"
+    EXAMPLE_OUT3 = "Uptime: 16076688  Threads: 174  Questions: 3193188096  Slow queries: 130  Opens: 2218  Flush tables: 2  Open tables: 474  Queries per second avg: 198.622"
+    EXAMPLE_OUT4 = "Uptime: 16076688  Threads: 174  Questions: 3193188096  Slow queries: 130  Opens: 2218  Flush tables: 2  Open tables: 474  Queries per second avg: 198.622"
+
+    reporter = DucksboardReporter::Reporters::MySqlSlowQueries.new("test_reporter")
+
+    expect_any_instance_of(reporter.class).to receive(:`).and_return(EXAMPLE_OUT1, EXAMPLE_OUT2, EXAMPLE_OUT3, EXAMPLE_OUT4)
+    reporter.update
+    expect(reporter.value).to eq(10)
+    reporter.update
+    expect(reporter.value).to eq(20)
+    reporter.update
+    expect(reporter.value).to eq(100)
+    reporter.update
+    expect(reporter.value).to eq(0)
+
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require "ducksboard_reporter"
-require "byebug"
 
 DucksboardReporter.logger.level = Logger::FATAL
 
 RSpec.configure do |config|
+  config.color = true
 end

data/spec/widget_spec.rb

@@ -14,6 +14,7 @@ describe DucksboardReporter::Widget do
 
   let(:reporter) { WidgetReporter.new("name") }
   let(:widget) { DucksboardReporter::Widget.new("Box", 1234, reporter) }
+  let(:ruby_version) { RUBY_VERSION.split(".")[0].to_i }
 
   describe "#update" do
     it "updates value from reporter" do
@@ -22,12 +23,29 @@ describe DucksboardReporter::Widget do
     end
 
     it "will not crash on Net::ReadTimeout" do
-      expect(widget.updater).to receive(:update).and_raise(Net::ReadTimeout)
+      if ruby_version >= 2
+        expect(widget.updater).to receive(:update).and_raise(Net::ReadTimeout)
+      end
+
+      if ruby_version < 2
+        expect(widget.updater).to receive(:update).and_raise(TimeoutError)
+      end
       widget.update
     end
 
     it "will not crash on Net::OpenTimeout" do
-      expect(widget.updater).to receive(:update).and_raise(Net::OpenTimeout)
+      if ruby_version >= 2
+        expect(widget.updater).to receive(:update).and_raise(Net::OpenTimeout)
+      end
+
+      if ruby_version < 2
+        expect(widget.updater).to receive(:update).and_raise(TimeoutError)
+      end
+      widget.update
+    end
+
+    it "will not crash on Errno::ECONNRESET" do
+      expect(widget.updater).to receive(:update).and_raise(Errno::ECONNRESET)
       widget.update
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducksboard_reporter
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.4
 platform: ruby
 authors:
 - unnu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -173,6 +173,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -188,11 +189,17 @@ files:
 - lib/ducksboard_reporter/reporters/cpu_usage.rb
 - lib/ducksboard_reporter/reporters/haproxy_log_requests.rb
 - lib/ducksboard_reporter/reporters/honeybadger.rb
+- lib/ducksboard_reporter/reporters/mysql_base.rb
+- lib/ducksboard_reporter/reporters/mysql_innodb_rows_reads_per_second.rb
+- lib/ducksboard_reporter/reporters/mysql_queries_per_second.rb
+- lib/ducksboard_reporter/reporters/mysql_slow_queries.rb
 - lib/ducksboard_reporter/reporters/random.rb
 - lib/ducksboard_reporter/version.rb
 - lib/ducksboard_reporter/widget.rb
 - lib/rund.rb
+- spec/config.yml
 - spec/ducksboard_reporter_spec.rb
+- spec/mysql_reporter_spec.rb
 - spec/reporter_spec.rb
 - spec/spec_helper.rb
 - spec/widget_spec.rb
@@ -216,12 +223,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Report values to ducksboard
 test_files:
+- spec/config.yml
 - spec/ducksboard_reporter_spec.rb
+- spec/mysql_reporter_spec.rb
 - spec/reporter_spec.rb
 - spec/spec_helper.rb
 - spec/widget_spec.rb