metrux 1.0.0

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "metrux"
+
+Metrux.setup
+
+require "pry"
+Pry.start

data/bin/playground

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+ENV['METRUX_ACTIVE'] = 'true'
+ENV['METRUX_APP_NAME'] = 'My application'
+ENV['METRUX_LOG_LEVEL'] = 'debug'
+
+require "bundler/setup"
+require "metrux"
+
+puts 'Starting playground...'
+puts "Ctrl+C to stop\n\n"
+
+Metrux.register(Metrux::Plugins::Thread)
+Metrux.register(Metrux::Plugins::Gc)
+Metrux.register(Metrux::Plugins::Process)
+Metrux.register(Metrux::Plugins::Yarv)
+
+Metrux.periodic_gauge('threads_count') { Thread.list.count }
+Metrux.periodic_gauge(
+  'threads_count', tags: { type: :domain }
+) { Thread.list.count }
+
+timer = Proc.new { sleep(5); Metrux.timer('sleep') { sleep(rand + rand(2)); } }
+error = Proc.new do
+  sleep(5)
+  Metrux.notice_error(
+    [StandardError, RuntimeError, ArgumentError, Exception].sample.new
+  )
+end
+meter = Proc.new { sleep(rand + rand(5)); Metrux.meter('sleep') }
+gauge = Proc.new { sleep(5); Metrux.gauge('rand') { rand(200) } }
+
+[
+  Thread.new { loop { timer.call } },
+  Thread.new { loop { error.call } },
+  Thread.new { loop { meter.call } },
+  Thread.new { loop { gauge.call } }
+].each(&:join)

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/setup

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+echo "Creating log dir..."
+mkdir -p log
+
+if [ ! -f "config/metrux.yml" ]
+then
+  echo "Copying config/metrux{.sample.yml,.yml}..."
+  cp config/metrux{.sample.yml,.yml}
+fi
+
+bundle install
+gem install geminabox --no-ri --no-rdoc

data/config/metrux.sample.yml

@@ -0,0 +1,46 @@
+default: &defaults
+  #
+  # Your application's name (All metrics will be marked with this tag)
+  #
+  # app_name: "My application"
+
+  #
+  # Whether it is active for this environment, can be true or false
+  # default: false
+  #
+  active: true
+
+  #
+  # Interval that agent will execute all registered periodic metrics
+  # (in seconds)
+  #
+  periodic_gauge_interval: 5 # default: 60
+
+  #
+  # Metrux logger configuration
+  #
+  log_file: 'log/metrux.log' # default: STDOUT
+  log_level: 'info' # default: info
+
+  #
+  # Influx configuration
+  # See: https://github.com/influxdata/influxdb-ruby#creating-a-client
+  #
+  influx_host: 'hostname'
+  influx_port: 80
+  influx_database: 'database'
+  influx_username: 'user'
+  influx_password: 'secret'
+  influx_async: true
+
+development:
+  <<: *defaults
+  active: false
+
+test:
+  <<: *defaults
+  log_file: '/dev/null'
+  active: false
+
+production:
+  <<: *defaults

data/lib/metrux.rb

@@ -0,0 +1,60 @@
+require 'influxdb'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/filters'
+require 'securerandom'
+require 'erb'
+require 'yaml'
+require 'thread'
+require 'metrux/version'
+require 'metrux/constants'
+require 'metrux/loggable'
+require 'metrux/sleeper'
+require 'metrux/client'
+require 'metrux/configuration'
+require 'metrux/config_builders'
+require 'metrux/connections'
+require 'metrux/commands'
+require 'metrux/plugins'
+require 'metrux/plugin_register'
+
+module Metrux
+  class << self
+    extend Forwardable
+
+    attr_reader :configured
+
+    alias configured? configured
+
+    def_delegators(:client, *Client::AVAILABLE_COMMANDS)
+    def_delegator :config, :logger
+    def_delegator :plugin_register, :register
+    def_delegator :plugin_register, :plugins
+
+    def setup(config = nil)
+      @config = config || Configuration.new
+      @client = Client.new(@config)
+      @plugin_register = PluginRegister.new(@config)
+      @configured = true
+    end
+
+    def client
+      lazy_setup { @client }
+    end
+
+    def config
+      lazy_setup { @config }
+    end
+
+    def plugin_register
+      lazy_setup { @plugin_register }
+    end
+
+    private
+
+    def lazy_setup
+      setup unless configured?
+      yield
+    end
+  end
+end

data/lib/metrux/client.rb

@@ -0,0 +1,40 @@
+module Metrux
+  class Client
+    extend Forwardable
+    include Loggable
+
+    AVAILABLE_COMMANDS = %i(
+      timer meter gauge periodic_gauge notice_error write
+    ).freeze
+
+    AVAILABLE_COMMANDS.each do |command|
+      attr_reader(:"#{command}_command")
+      def_delegator(:"#{command}_command", :execute, command)
+    end
+
+    def initialize(config)
+      @config = config
+
+      conn_type = config.active? ? 'influx_db' : 'null'
+      @connection =
+        "metrux/connections/#{conn_type}".camelize.constantize.new(config)
+
+      instantiate_commands
+    end
+
+    private
+
+    attr_reader :config, :connection
+
+    def instantiate_commands
+      AVAILABLE_COMMANDS.each do |command|
+        instance_variable_set(
+          "@#{command}_command",
+          "metrux/commands/#{command}".camelize.constantize.new(
+            config, connection
+          )
+        )
+      end
+    end
+  end
+end

data/lib/metrux/commands.rb

@@ -0,0 +1,12 @@
+module Metrux
+  module Commands
+  end
+end
+
+require_relative 'commands/base'
+require_relative 'commands/write'
+require_relative 'commands/gauge'
+require_relative 'commands/periodic_gauge'
+require_relative 'commands/timer'
+require_relative 'commands/meter'
+require_relative 'commands/notice_error'

data/lib/metrux/commands/base.rb

@@ -0,0 +1,62 @@
+module Metrux
+  module Commands
+    class Base
+      extend Forwardable
+      include Loggable
+
+      DEFAULT_TAGS = {
+        hostname: Metrux::HOST, program_name: Metrux::PROGRAM_NAME
+      }.freeze
+
+      def initialize(config, connection)
+        @config = config
+        @connection = connection
+        @logger = config.logger
+        @prefix = config.prefix
+      end
+
+      protected
+
+      attr_reader :connection, :logger, :config, :prefix
+
+      def_delegators :config, :app_name, :env
+
+      def write(measurement, data, options = {})
+        precision = options[:precision].presence
+        retention = options[:retention].presence
+
+        log("Writing #{measurement}")
+
+        connection.write_point(
+          "#{prefix}/#{measurement}", default_data.deep_merge(data), precision,
+          retention
+        )
+
+        true
+      end
+
+      def format_data(value, params)
+        values = value.is_a?(Hash) ? value : { value: value }
+        {
+          values: values,
+          tags: params.fetch(:tags, {}),
+          timestamp: params.fetch(:timestamp, default_timestamp)
+        }
+      end
+
+      def format_write_options(params)
+        params.select { |k, _| [:precision, :retention].include?(k) }
+      end
+
+      private
+
+      def default_data
+        { tags: DEFAULT_TAGS.merge(app_name: app_name, env: env) }
+      end
+
+      def default_timestamp
+        (Time.now.utc.to_f * 1_000_000_000).to_i
+      end
+    end
+  end
+end

data/lib/metrux/commands/gauge.rb

@@ -0,0 +1,21 @@
+module Metrux
+  module Commands
+    class Gauge < Base
+      GAUGE_MEASUREMENT_PREFIX_KEY = 'gauges/'.freeze
+
+      def execute(key, params = {})
+        block_given? ? gauge(key, params) { yield } : gauge(key, params)
+      end
+
+      def gauge(key, params = {})
+        key = "#{GAUGE_MEASUREMENT_PREFIX_KEY}#{key}"
+
+        result = block_given? ? yield : params.fetch(:result)
+
+        write(key, format_data(result, params), format_write_options(params))
+
+        result
+      end
+    end
+  end
+end

data/lib/metrux/commands/meter.rb

@@ -0,0 +1,15 @@
+module Metrux
+  module Commands
+    class Meter < Base
+      METER_MEASUREMENT_PREFIX_KEY = 'meters/'.freeze
+
+      def execute(key, params = {})
+        key = "#{METER_MEASUREMENT_PREFIX_KEY}#{key}"
+
+        value = params.fetch(:value, 1).to_i
+
+        write(key, format_data(value, params), format_write_options(params))
+      end
+    end
+  end
+end

data/lib/metrux/commands/notice_error.rb

@@ -0,0 +1,38 @@
+module Metrux
+  module Commands
+    class NoticeError < Base
+      ERROR_METER_KEY = 'meters/errors'.freeze
+
+      def execute(error, payload = {})
+        value = build_value(error)
+        options = build_options(error, payload)
+
+        write(ERROR_METER_KEY, format_data(value, options))
+      end
+
+      private
+
+      def build_value(error)
+        { message: error.message.truncate(100, separator: ' '), value: 1 }
+      end
+
+      def build_options(error, payload)
+        {}.tap do |options|
+          options[:tags] = fetch_tags(error, payload)
+
+          if payload[:timestamp].present?
+            options[:timestamp] = payload[:timestamp]
+          end
+        end
+      end
+
+      def fetch_tags(error, payload)
+        payload
+          .reject { |(k, _)| k.to_s == 'timestamp' }
+          .each_with_object({}) do |(k, v), with_string_values|
+          with_string_values[k] = v.is_a?(String) ? v : v.inspect
+        end.merge(error: error.class.to_s)
+      end
+    end
+  end
+end

data/lib/metrux/commands/periodic_gauge.rb

@@ -0,0 +1,25 @@
+module Metrux
+  module Commands
+    class PeriodicGauge < Gauge
+      require_relative 'periodic_gauge/registry'
+      require_relative 'periodic_gauge/agent'
+      require_relative 'periodic_gauge/supervisor'
+      require_relative 'periodic_gauge/reporter'
+
+      attr_reader :registry, :reporter
+
+      def initialize(config, connection)
+        super
+        @registry = Registry.new(config)
+        @reporter = Reporter.new(self, registry, config)
+      end
+
+      def execute(key, params = {})
+        registry.add(key, params) { yield }
+        reporter.start
+
+        true
+      end
+    end
+  end
+end