monus 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a04a518fe2178f143970691645c51fc69d67bc1f
+  data.tar.gz: b09f0a47c40336df387a103067b0480a894e73c2
+SHA512:
+  metadata.gz: c7d50f18c451e64f516fed6fd8fd1ca71b0d752697c637bd22f6d5a7a5cbf020ec7f0784c4a22970d69daff0d167282c3aba73cf745c8b3df055aa1d946e3f8b
+  data.tar.gz: 8c80f5383c4d89ef962851b69398c210be0a4c0a707a10781e41aaeabfe6e0c549cdc7cd83bb91ff95dfe4b15025d3725777b8850441f42ab9c62336b8c506f8

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2018 Aleksandr Kundin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Monus
+
+Monus is the proof-of-concept monitoring library. Detailed description will be available (hope) in future.

data/lib/monus.rb

@@ -0,0 +1,69 @@
+module Monus
+  ConfigurationError = Class.new StandardError
+
+  @@prepared = false
+  @@preparing = false
+  @@options = {}
+
+  def self.configure(options)
+    @@options = options
+    prepare
+  end
+
+  def self.options
+    @@options
+  end
+
+  def self.prepare
+    return true if @@prepared or @@preparing
+    @@preparing = true
+
+    prepare_logger if options[:logger]
+
+    @@engine = Monus::Engine[options[:engine] || :pure]
+    @@engine.prepare
+
+    @@backend = Monus::Backend[options[:backend] || :memory]
+    @@backend.prepare
+
+    options[:built_in_metrics]&.each do |metric|
+      Monus::BuiltInMetric[metric].activate
+    end
+
+    @@preparing = false
+    @@prepared = true
+  end
+
+  def self.engine
+    prepare unless @@prepared
+    @@engine
+  end
+
+  def self.backend
+    prepare unless @@prepared
+    @@backend
+  end
+
+  def self.logger
+    @@logger ||= options[:logger] || begin
+      require 'logger'
+      Logger.new STDOUT
+    end
+  end
+
+  def self.set(field, value)
+    backend.write field, value
+  end
+
+  def self.accept(field)
+    set field, true
+  end
+
+  def self.refuse(field)
+    set field, false
+  end
+end
+
+require_relative 'monus/engine'
+require_relative 'monus/backend'
+require_relative 'monus/built_in_metric'

data/lib/monus/backend.rb

@@ -0,0 +1,15 @@
+module Monus::Backend
+  @@backends = {}
+
+  def self.register(name, object)
+    @@backends[name] = object
+  end
+
+  def self.[](name)
+    @@backends[name] or raise NotImplementedError, "no such backend: #{name.inspect}, possible backends are: #{@@backends.keys.map(&:inspect) * ', '}"
+  end
+end
+
+backends_glob = File.join File.dirname(__FILE__), 'backends', '*.rb'
+backends_files = Dir[backends_glob].map &File.method(:absolute_path)
+backends_files.each &method(:require)

data/lib/monus/backends/influxdb.rb

@@ -0,0 +1,52 @@
+module Monus::Backend::InfluxDB
+  def prepare
+    @host = Monus.options.dig(:influxdb_options, :host) || 'localhost'
+
+    @measurement = Monus.options.dig(:influxdb_options, :measurement)
+    unless @measurement
+      raise Monus::ConfigurationError, 'when using InfluxDB backend you should provide `influxdb_options/measurement` configuration with measurement (table) name'
+    end
+
+    @mode = Monus.options.dig(:influxdb_options, :mode)
+    case @mode
+    when :udp
+      @udp_port = Monus.options.dig(:influxdb_options, :udp_port)
+      unless @udp_port
+        raise Monus::ConfigurationError, 'when using UDP mode you should provide `influxdb_options/udp_port` configuration with corresponding port number'
+      end
+    when :http
+      @http_port = Monus.options.dig(:influxdb_options, :http_port)
+      unless @http_port
+        raise Monus::ConfigurationError, 'when using HTTP mode you should provide `influxdb_options/http_port` configuration with corresponding port number'
+      end
+
+      @database = Monus.options.dig(:influxdb_options, :database)
+      unless @database
+        raise Monus::ConfigurationError, 'when using HTTP mode you should provide `influxdb_options/database` configuration with database name'
+      end
+
+      @http_connection = Monus.engine.make_http_connection @host, @http_port
+
+      @uri = "/write?db=#{@database}"
+    else
+      raise Monus::ConfigurationError, 'when using InfluxDB backend you should provide `influxdb_options/mode` configuration with `:udp` or `:http` value'
+    end
+
+    @global_tags = Monus.options.dig(:influxdb_options, :global_tags)&.map { |key, value| ",#{key}=#{value}" }&.join
+  end
+
+  def write(field, value)
+    value = "\"#{value.gsub '"', '\"'}\"" if value.kind_of? String
+    message = "#{@measurement}#{@global_tags} #{field}=#{value}"
+    case @mode
+    when :udp
+      Monus.engine.send_udp_datagram message, @host, @udp_port
+    when :http
+      Monus.engine.send_http_request @uri, method: :post, body: message, connection: @http_connection
+    end
+  end
+
+  extend self
+
+  Monus::Backend.register :influxdb, self
+end

data/lib/monus/built_in_metric.rb

@@ -0,0 +1,15 @@
+module Monus::BuiltInMetric
+  @@metrics = {}
+
+  def self.register(name, object)
+    @@metrics[name] = object
+  end
+
+  def self.[](name)
+    @@metrics[name] or raise NotImplementedError, "no such metric: #{name.inspect}, possible metrics are: #{@@metrics.keys.map(&:inspect) * ', '}"
+  end
+end
+
+metrics_glob = File.join File.dirname(__FILE__), 'built_in_metrics', '*.rb'
+metrics_files = Dir[metrics_glob].map &File.method(:absolute_path)
+metrics_files.each &method(:require)

data/lib/monus/built_in_metrics/works.rb

@@ -0,0 +1,13 @@
+module Monus::BuiltInMetric::Works
+  def activate
+    @interval = Monus.options.dig(:works_metric_options, :interval) || 1
+
+    Monus.engine.every @interval do
+      Monus.accept :works
+    end
+  end
+
+  extend self
+
+  Monus::BuiltInMetric.register :works, self
+end

data/lib/monus/engine.rb

@@ -0,0 +1,15 @@
+module Monus::Engine
+  @@engines = {}
+
+  def self.register(name, object)
+    @@engines[name] = object
+  end
+
+  def self.[](name)
+    @@engines[name] or raise NotImplementedError, "no such engine: #{name.inspect}, possible engines are: #{@@engines.keys.map(&:inspect) * ', '}"
+  end
+end
+
+engines_glob = File.join File.dirname(__FILE__), 'engines', '*.rb'
+engines_files = Dir[engines_glob].map &File.method(:absolute_path)
+engines_files.each &method(:require)

data/lib/monus/engines/pure.rb

@@ -0,0 +1,90 @@
+module Monus::Engine::Pure
+  def initialize_defaults
+    @on_error ||= []
+  end
+
+  def prepare
+    initialize_defaults
+    option = Monus.options.dig(:pure_engine_options, :on_async_error)
+    case option
+    when Array
+      option.each &method(:add_error_handler)
+    else
+      add_error_handler option
+    end
+    @prepared = true
+  end
+
+  def add_error_handler(handler)
+    initialize_defaults
+    @on_error.push case handler
+    when Proc
+      handler
+    when :crash
+      -> * { exit 1 }
+    when :ignore
+      -> * {}
+    when :break
+      -> error, * { raise error }
+    when :log, nil
+      -> error, type, * { Monus.logger.fatal "error in Monus #{type} - #{error.class}: #{error.message}\n#{error.backtrace * "\n"}" }
+    else
+      raise Monus::ConfigurationError, 'unknown error handler given in `pure_engine_options/on_async_error` configuration; it should be a block (exception, type and binding arguments will passed) or one of `:crash`, `:ignore`, `:break` or `:log` (default) values, or array of them'
+    end
+  end
+
+  def make_http_connection(host, port)
+    load_http
+    Net::HTTP.start host, port
+  end
+
+  def send_http_request(uri, method: :get, body: nil, connection: Net::HTTP)
+    load_http
+    uri = URI.parse uri if connection == Net::HTTP and not uri.kind_of?(URI)
+    case method
+    when :get then connection.get uri
+    when :post then connection.post uri, body
+    else raise NotImplementedError, "unknown HTTP method #{method.inspect}"
+    end
+  end
+
+  def load_http
+    @http_loaded ||= begin
+      require 'net/http'
+      require 'uri'
+      true
+    end
+  end
+
+  def send_udp_datagram(message, host, port)
+    @udp_socket ||= begin
+      require 'socket'
+      UDPSocket.new
+    end
+    @udp_socket.send message, 0, host, port
+  end
+
+  def every(interval, fire_immediately: true, on_error: nil, &block)
+    prepare unless @prepared
+
+    Thread.new do
+      sleep interval unless fire_immediately
+
+      loop do
+        begin
+          block.call
+        rescue => error
+          interval_binding = binding
+          Array(on_error || @on_error).each do |handler|
+            handler.call error, :interval, interval_binding
+          end
+        end
+        sleep interval
+      end
+    end
+  end
+
+  extend self
+
+  Monus::Engine.register :pure, self
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: monus
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Xanders
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-23 00:00:00.000000000 Z
+dependencies: []
+description: Monus is an in-process monitoring library for several backends and engines
+email: necropolis@inbox.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/monus.rb
+- lib/monus/backend.rb
+- lib/monus/backends/influxdb.rb
+- lib/monus/built_in_metric.rb
+- lib/monus/built_in_metrics/works.rb
+- lib/monus/engine.rb
+- lib/monus/engines/pure.rb
+homepage: https://github.com/xanders/monus.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: God of Monitoring
+test_files: []