metrux 1.0.0

data/lib/metrux/commands/periodic_gauge/agent.rb

@@ -0,0 +1,68 @@
+module Metrux
+  module Commands
+    class PeriodicGauge < Gauge
+      class Agent
+        include Loggable
+        include Sleeper
+
+        DEFAULT_INVERVAL = 60
+
+        def initialize(command, registry, config)
+          @command = command
+          @registry = registry
+          @interval = config.periodic_gauge_interval || DEFAULT_INVERVAL
+          @logger = config.logger
+          @thread = nil
+        end
+
+        def start
+          return false if alive?
+
+          log('Starting...', :info)
+          @thread = Thread.new do
+            loop do
+              log("sleeping for #{interval}s...")
+              wait(interval)
+
+              metrics.each(&method(:execute_metric))
+            end
+          end
+
+          true
+        end
+
+        def stop
+          log('Stopping...', :info)
+          @thread.kill if @thread
+          @thread = nil
+        end
+
+        def alive?
+          @thread && @thread.alive?
+        end
+
+        private
+
+        attr_reader :command, :interval, :registry
+
+        def metrics
+          registry.metrics
+        end
+
+        def execute_metric(key, params)
+          log("Executing #{key}...", :info)
+
+          command.gauge(
+            params.fetch(:measurement), params.fetch(:options),
+            &params.fetch(:metric)
+          )
+        rescue => e
+          log(
+            "ERROR #{key}: #{e.class}: #{e.message} #{e.backtrace.take(2)}",
+            :error
+          )
+        end
+      end
+    end
+  end
+end

data/lib/metrux/commands/periodic_gauge/registry.rb

@@ -0,0 +1,39 @@
+module Metrux
+  module Commands
+    class PeriodicGauge < Gauge
+      class Registry
+        include Loggable
+
+        def initialize(config)
+          @mutex = Mutex.new
+          @metrics = {}
+          @logger = config.logger
+        end
+
+        def metrics
+          mutex.synchronize { @metrics.dup }
+        end
+
+        def add(measurement, options = {}, &metric_block)
+          tags = options.fetch(:tags, {})
+          key = "#{measurement}/#{tags.to_query}".freeze
+
+          log("Registering #{key}")
+
+          mutex.synchronize do
+            @metrics[key] = {
+              measurement: measurement, metric: metric_block,
+              options: options
+            }
+          end
+
+          true
+        end
+
+        private
+
+        attr_reader :mutex, :logger
+      end
+    end
+  end
+end

data/lib/metrux/commands/periodic_gauge/reporter.rb

@@ -0,0 +1,33 @@
+module Metrux
+  module Commands
+    class PeriodicGauge < Gauge
+      class Reporter
+        extend Forwardable
+
+        def initialize(command, registry, config)
+          @agent = Agent.new(command, registry, config)
+          @supervisor = Supervisor.new(agent, config)
+          @config = config
+        end
+
+        def start
+          return false unless config.active?
+
+          agent.start
+          supervisor.start
+
+          true
+        end
+
+        def stop
+          supervisor.stop
+          agent.stop
+        end
+
+        private
+
+        attr_reader :agent, :supervisor, :config
+      end
+    end
+  end
+end

data/lib/metrux/commands/periodic_gauge/supervisor.rb

@@ -0,0 +1,53 @@
+module Metrux
+  module Commands
+    class PeriodicGauge < Gauge
+      class Supervisor
+        include Loggable
+        include Sleeper
+
+        INTERVAL_CHECK = 10
+
+        def initialize(agent, config)
+          @agent = agent
+          @logger = config.logger
+          @thread = nil
+        end
+
+        def start
+          unless alive?
+            log('Starting...', :info)
+            @thread = Thread.new { loop { check } }
+
+            return true
+          end
+          false
+        end
+
+        def stop
+          log('Stopping...', :info)
+          @thread.kill if @thread
+          @thread = nil
+        end
+
+        def alive?
+          @thread && @thread.alive?
+        end
+
+        private
+
+        attr_reader :agent
+
+        def check
+          wait(INTERVAL_CHECK)
+
+          unless agent.alive?
+            log('Agent is dead. Restarting...', :info)
+            agent.start
+          end
+        rescue => e
+          log("ERROR: #{e.class}: #{e.message}", :error)
+        end
+      end
+    end
+  end
+end

data/lib/metrux/commands/timer.rb

@@ -0,0 +1,30 @@
+module Metrux
+  module Commands
+    class Timer < Base
+      TIMER_MEASUREMENT_PREFIX_KEY = 'timers/'.freeze
+
+      def execute(key, params = {})
+        key = "#{TIMER_MEASUREMENT_PREFIX_KEY}#{key}"
+
+        result, duration = if block_given?
+                             calculate_duration { yield }
+                           else
+                             [nil, params.fetch(:duration)]
+                           end
+
+        write(key, format_data(duration, params), format_write_options(params))
+
+        result
+      end
+
+      private
+
+      def calculate_duration
+        started_at = Time.now
+        result = yield
+        duration = ((Time.now - started_at) * 1_000).ceil
+        [result, duration]
+      end
+    end
+  end
+end

data/lib/metrux/commands/write.rb

@@ -0,0 +1,9 @@
+module Metrux
+  module Commands
+    class Write < Base
+      def execute(key, data, options = {})
+        write(key, format_data(data, options), format_write_options(options))
+      end
+    end
+  end
+end

data/lib/metrux/config_builders.rb

@@ -0,0 +1,11 @@
+module Metrux
+  module ConfigBuilders
+    ConfigurationError = Class.new(RuntimeError)
+  end
+end
+
+require_relative 'config_builders/yaml'
+require_relative 'config_builders/common'
+require_relative 'config_builders/periodic_gauge'
+require_relative 'config_builders/influx'
+require_relative 'config_builders/logger'

data/lib/metrux/config_builders/common.rb

@@ -0,0 +1,53 @@
+module Metrux
+  module ConfigBuilders
+    class Common
+      APP_NAME_KEY = 'METRUX_APP_NAME'.freeze
+      ACTIVE_KEY = 'METRUX_ACTIVE'.freeze
+
+      AppNameNotFoundError = Class.new(ConfigurationError)
+
+      def initialize(yaml)
+        @yaml = yaml
+      end
+
+      def build
+        { app_name: app_name, active: active, prefix: prefix }
+      end
+
+      private
+
+      attr_reader :yaml
+
+      def app_name
+        ENV[APP_NAME_KEY] || yaml[:app_name] || raise(AppNameNotFoundError)
+      end
+
+      def active
+        return ENV[ACTIVE_KEY] == 'true' if ENV[ACTIVE_KEY].present?
+
+        yaml[:active].presence || false
+      end
+
+      def prefix
+        without_accent(app_name.underscore)
+          .gsub(/\s/, '_') # {\s,_}
+          .gsub(/\W/, '') # non-chars
+      end
+
+      def without_accent(text)
+        # String#parameterize or ActiveSupport::Inflector.transliterate
+        # mess with i18n
+        #
+        # See https://github.com/rails/rails/issues/21939
+        text.tr(
+          'ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħ' \
+          'ÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕ' \
+          'ŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž',
+          'AAAAAAaaaaaaAaAaAaCcCcCcCcCcDdDdDdEEEEeeeeEeEeEeEeEeGgGgGgGgHhHh' \
+          'IIIIiiiiIiIiIiIiIiJjKkkLlLlLlLlLlNnNnNnNnnNnOOOOOOooooooOoOoOoRr' \
+          'RrRrSsSsSsSssTtTtTtUUUUuuuuUuUuUuUuUuUuWwYyyYyYZzZzZz'
+        )
+      end
+    end
+  end
+end

data/lib/metrux/config_builders/influx.rb

@@ -0,0 +1,71 @@
+module Metrux
+  module ConfigBuilders
+    class Influx
+      DEFAULT_TIME_PRECISION = 'ns'.freeze
+      DEFAULT_ASYNC = true
+
+      def initialize(yaml)
+        @yaml = yaml
+      end
+
+      def build
+        defaults.deep_merge(
+          config_from_yaml.deep_merge(config_from_env_var)
+        ).freeze
+      end
+
+      private
+
+      attr_reader :yaml
+
+      def config_from_env_var
+        fetch_from(ENV, 'METRUX_INFLUX_'.freeze)
+      end
+
+      def config_from_yaml
+        fetch_from(yaml, 'influx_'.freeze)
+      end
+
+      def fetch_from(object, prefix)
+        object.each_with_object({}) do |(config_key, value), acc|
+          if config_key.start_with?(prefix)
+            acc[config_key.gsub(/^#{prefix}/, '').to_s.downcase.to_sym] =
+              cast_value(value)
+          end
+        end
+      end
+
+      def cast_value(value)
+        string_value = value.to_s
+
+        unless (numeric_value = numeric_value(string_value)).nil?
+          return numeric_value
+        end
+
+        unless (boolean_value = boolean_value(string_value)).nil?
+          return boolean_value
+        end
+
+        value
+      end
+
+      def numeric_value(value)
+        return value.to_f if value.to_f.to_s == value
+        return value.to_i if value.to_i.to_s == value
+
+        nil
+      end
+
+      def boolean_value(value)
+        return true if value == true || value =~ /^(true)$/i
+        return false if value == false || value =~ /^(false)$/i
+
+        nil
+      end
+
+      def defaults
+        { time_precision: DEFAULT_TIME_PRECISION, async: DEFAULT_ASYNC }
+      end
+    end
+  end
+end

data/lib/metrux/config_builders/logger.rb

@@ -0,0 +1,48 @@
+module Metrux
+  module ConfigBuilders
+    class Logger
+      LOG_FILE_KEY = 'METRUX_LOG_FILE'.freeze
+      LOG_LEVEL_KEY = 'METRUX_LOG_LEVEL'.freeze
+
+      DEFAULT_LOG_PATH = STDOUT
+      DEFAULT_LOG_LEVEL = :info
+
+      def initialize(yaml)
+        @yaml = yaml
+      end
+
+      def build
+        ::Logger.new(log_file).tap do |logger|
+          logger.level = log_level
+          logger.formatter = ::Logger::Formatter.new
+        end
+      rescue => e
+        Kernel.warn(
+          '[WARNING] Cound\'t configure Metrux\'s logger. '\
+          "#{e.class}: #{e.message}"
+        )
+        nil
+      end
+
+      private
+
+      attr_reader :yaml
+
+      def log_file
+        from_config = (ENV[LOG_FILE_KEY] || yaml[:log_file]).presence
+
+        return DEFAULT_LOG_PATH if from_config.blank?
+
+        from_config == 'STDOUT'.freeze ? STDOUT : from_config
+      end
+
+      def log_level
+        ::Logger.const_get(
+          (
+            ENV[LOG_LEVEL_KEY] || yaml[:log_level] || DEFAULT_LOG_LEVEL
+          ).to_s.upcase
+        )
+      end
+    end
+  end
+end

data/lib/metrux/config_builders/periodic_gauge.rb

@@ -0,0 +1,21 @@
+module Metrux
+  module ConfigBuilders
+    class PeriodicGauge
+      INTERVAL_KEY = 'METRUX_PERIODIC_GAUGE_INTERVAL'.freeze
+
+      def initialize(yaml)
+        @yaml = yaml
+      end
+
+      def build
+        interval = (ENV[INTERVAL_KEY] || yaml[:periodic_gauge_interval]).to_i
+
+        (interval > 0 && interval).presence
+      end
+
+      private
+
+      attr_reader :yaml
+    end
+  end
+end