yabeda 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c30404230f234aefbf4f0f8341f276583b30f5cc9a75495e5c57e8acab23187
-  data.tar.gz: 980db126d071f8fe8c879798bbe35d5755819dd0384770dae7fe19d940f09840
+  metadata.gz: a3a3991d4dbb2b060ba55ad682d20eb14012c8fb674cebc335e36ae5c0ab8067
+  data.tar.gz: 56190b3fae34f414ba1afa58ec0ffc05ca36ee7c5f5209148b64a7a7a9936197
 SHA512:
-  metadata.gz: 20bf75e05040cc0ea26035422a4a64a5856ba683c0b98c81b756cc39311e41488972a57fca6174554d2d5175d85b7c5e59f5bd2375627cfb3756155cb31423ee
-  data.tar.gz: df6d12199c647f43858d0b6f73cd09ce1f7ab62b00190f251a7e37cbb17257b682fc844bbd65a03816c6c007e5757aef444637fcf410b65809dcccc96ae1a17a
+  metadata.gz: def5c6a2dfaf0bff0b17aadb9af664fc5b36427c1b52eff208afc7a43f275691a32d3c2cea2c19c2abd5643339a788f78b7f30f9294a8c882897abd57d060bee
+  data.tar.gz: 3548e381cf4b1b2fefe93d0211887e040022d02f4fbfc3a23f6404407bdb82e5b5a951a446d461a333978e5892054921593c4ea4a43de956ecefecf121408c0f

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+
+## 0.1.3 - 2018-12-18
+
+### Added
+
+ - Block-based DSL for defining groups and metrics. @DmitryTsepelev
+
+## 0.1.2 - 2018-10-25
+
+### Fixed
+
+ - Removed accidental dependency from Rails. @dsalahutdinov
+
+## 0.1.1 - 2018-10-17
+
+### Changed
+
+ - Renamed evil-metrics gem to yabeda. @Envek
+
+## 0.1.0 - 2018-10-03
+
+ - Initial release of evil-metrics gem. @Envek

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/yabeda.svg)](https://rubygems.org/gems/yabeda) [![Build Status](https://travis-ci.org/yabeda-rb/yabeda.svg?branch=master)](https://travis-ci.org/yabeda-rb/yabeda)
 
-**This software is Work in Progress: features will appear and disappear, API will be changed, your feedback is always welcome!** 
+**This software is Work in Progress: features will appear and disappear, API will be changed, your feedback is always welcome!**
 
 Extendable solution for easy setup of monitoring in your Ruby apps.
 
@@ -32,35 +32,38 @@ And then execute:
 
     ```ruby
     Yabeda.configure do
-      group :your_app
-    
-      counter   :bells_rang_count, "Total number of bells being rang"
-      gauge     :whistles_active,  "Number of whistles ready to whistle"
-      histogram :whistle_runtime,  "How long whistles are being active", unit: :seconds
+      group :your_app do
+        counter   :bells_rang_count, comment: "Total number of bells being rang"
+        gauge     :whistles_active,  comment: "Number of whistles ready to whistle"
+        histogram :whistle_runtime do
+          comment "How long whistles are being active"
+          unit :seconds
+        end
+      end
     end
     ```
-    
+
  2. Access metric in your app and use it!
- 
+
     ```ruby
     def ring_the_bell(id)
       bell = Bell.find(id)
       bell.ring!
-      Yabeda.your_app_bells_rang_count.increment({bell_size: bell.size}, by: 1)
+      Yabeda.your_app.bells_rang_count.increment({bell_size: bell.size}, by: 1)
     end
 
     def whistle!
-      Yabeda.your_app_whistle_runtime.measure do
+      Yabeda.your_app.whistle_runtime.measure do
         # Run your code
       end
     end
     ```
-    
+
  3. Setup collecting of metrics that do not tied to specific events in you application. E.g.: reporting your app's current state
     ```ruby
     Yabeda.configure do
       # This block will be executed periodically few times in a minute
-      # (by timer or external request depending on adapter you're using) 
+      # (by timer or external request depending on adapter you're using)
       # Keep it fast and simple!
       collect do
         your_app_whistles_active.set({}, Whistle.where(state: :active).count
@@ -74,7 +77,7 @@ And then execute:
 ## Roadmap (aka TODO or Help wanted)
 
  - Ability to change metric settings for individual adapters
- 
+
    ```rb
    histogram :foo, comment: "say what?" do
      adapter :prometheus do
@@ -82,9 +85,9 @@ And then execute:
      end
    end
    ```
-   
+
  - Ability to route some metrics only for given adapter:
- 
+
    ```rb
    adapter :prometheus do
      include_group :sidekiq

data/lib/yabeda.rb

@@ -15,6 +15,11 @@ module Yabeda
       @metrics ||= Concurrent::Hash.new
     end
 
+    # @return [Hash<String, Yabeda::Group>] All registered metrics
+    def groups
+      @groups ||= Concurrent::Hash.new
+    end
+
     # @return [Hash<String, Yabeda::BaseAdapter>] All loaded adapters
     def adapters
       @adapters ||= Concurrent::Hash.new

data/lib/yabeda/dsl.rb

@@ -1,65 +1,12 @@
 # frozen_string_literal: true
 
-require "yabeda/metric"
-require "yabeda/counter"
-require "yabeda/gauge"
-require "yabeda/histogram"
+require "yabeda/dsl/class_methods"
 
 module Yabeda
   # DSL for ease of work with Yabeda
   module DSL
     def self.included(base)
-      base.extend ClassMethods
+      base.extend DSL::ClassMethods
     end
-
-    # rubocop: disable Style/Documentation
-    module ClassMethods
-      # Block for grouping and simplifying configuration of related metrics
-      def configure(&block)
-        class_exec(&block)
-        @group = nil
-      end
-
-      # Define the actions that should be performed
-      def collect(&block)
-        ::Yabeda.collectors.push(block)
-      end
-
-      # Specify metric category or group for all consecutive metrics in this
-      # +configure+ block.
-      # On most adapters it is only adds prefix to the metric name but on some
-      # (like NewRelic) it is treated individually and have special meaning.
-      def group(group_name)
-        @group = group_name
-      end
-
-      # Register a growing-only counter
-      def counter(*args, **kwargs)
-        register(Counter.new(*args, **kwargs, group: @group))
-      end
-
-      # Register a gauge
-      def gauge(*args, **kwargs)
-        register(Gauge.new(*args, **kwargs, group: @group))
-      end
-
-      # Register an histogram
-      def histogram(*args, **kwargs)
-        register(Histogram.new(*args, **kwargs, group: @group))
-      end
-
-      private
-
-      def register(metric)
-        name = [metric.group, metric.name].compact.join("_")
-        ::Yabeda.define_singleton_method(name) { metric }
-        ::Yabeda.metrics[name] = metric
-        ::Yabeda.adapters.each do |_, adapter|
-          adapter.register!(metric)
-        end
-        metric
-      end
-    end
-    # rubocop: enable Style/Documentation
   end
 end

data/lib/yabeda/dsl/class_methods.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "yabeda/metric"
+require "yabeda/counter"
+require "yabeda/gauge"
+require "yabeda/histogram"
+require "yabeda/group"
+require "yabeda/dsl/metric_builder"
+
+module Yabeda
+  # DSL for ease of work with Yabeda
+  module DSL
+    # rubocop: disable Style/Documentation
+    module ClassMethods
+      # Block for grouping and simplifying configuration of related metrics
+      def configure(&block)
+        class_exec(&block)
+        @group = nil
+      end
+
+      # Define the actions that should be performed
+      def collect(&block)
+        ::Yabeda.collectors.push(block)
+      end
+
+      # Specify metric category or group for all consecutive metrics in this
+      # +configure+ block.
+      # On most adapters it is only adds prefix to the metric name but on some
+      # (like NewRelic) it is treated individually and has a special meaning.
+      def group(group_name)
+        @group = group_name
+        return unless block_given?
+
+        yield
+        @group = nil
+      end
+
+      # Register a growing-only counter
+      def counter(*args, **kwargs, &block)
+        metric = MetricBuilder.new(Counter).build(args, kwargs, @group, &block)
+        register_metric(metric)
+      end
+
+      # Register a gauge
+      def gauge(*args, **kwargs, &block)
+        metric = MetricBuilder.new(Gauge).build(args, kwargs, @group, &block)
+        register_metric(metric)
+      end
+
+      # Register a histogram
+      def histogram(*args, **kwargs, &block)
+        metric = MetricBuilder.new(Histogram).build(args, kwargs, @group, &block)
+        register_metric(metric)
+      end
+
+      private
+
+      def register_metric(metric)
+        name = [metric.group, metric.name].compact.join("_")
+        ::Yabeda.define_singleton_method(name) { metric }
+        ::Yabeda.metrics[name] = metric
+        ::Yabeda.adapters.each_value { |adapter| adapter.register!(metric) }
+        register_group_for(metric) if metric.group
+        metric
+      end
+
+      def register_group_for(metric)
+        group = ::Yabeda.groups[metric.group]
+
+        if group.nil?
+          group = Group.new(metric.group)
+          ::Yabeda.groups[metric.group] = group
+          ::Yabeda.define_singleton_method(metric.group) { group }
+        end
+
+        group.register_metric(metric)
+      end
+    end
+    # rubocop: enable Style/Documentation
+  end
+end

data/lib/yabeda/dsl/metric_builder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "yabeda/dsl/option_builder"
+
+module Yabeda
+  class ConfigurationError < StandardError; end
+
+  module DSL
+    # Handles DSL for working with individual metrics
+    class MetricBuilder
+      extend Dry::Initializer
+
+      param :metric_klass
+
+      def build(args, kwargs, group, &block)
+        options = OptionBuilder.new(metric_klass, kwargs).options_from(&block)
+        initialize_metric(args, options, group)
+      end
+
+      private
+
+      def initialize_metric(params, options, group)
+        metric_klass.new(*params, **options, group: group)
+      rescue KeyError => error
+        raise ConfigurationError, "#{error.message} for #{metric_klass.name}"
+      end
+    end
+  end
+end

data/lib/yabeda/dsl/option_builder.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Yabeda
+  module DSL
+    # Collects options for metric initializer
+    class OptionBuilder
+      extend Dry::Initializer
+
+      param :metric_klass
+      param :options
+
+      def options_from(&block)
+        instance_eval(&block) if block
+
+        return options if unknown_options.empty?
+
+        raise ConfigurationError,
+              "option '#{unknown_options.first}' is not available for #{metric_klass.name}"
+      end
+
+      def method_missing(method_name, method_args, &_block)
+        if kwarg?(method_name)
+          options[method_name] = method_args
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, _args)
+        kwarg?(method_name) || super
+      end
+
+      private
+
+      def kwarg?(method_name)
+        option_names.include?(method_name.to_sym)
+      end
+
+      def option_names
+        definitions = metric_klass.dry_initializer.definitions.values
+        definitions.select(&:option).map { |definition| definition.source.to_sym }
+      end
+
+      def unknown_options
+        options.keys - option_names
+      end
+    end
+  end
+end

data/lib/yabeda/group.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "dry-initializer"
+
+module Yabeda
+  # Represents a set of metrics grouped under the same name
+  class Group
+    extend Dry::Initializer
+
+    param :name
+
+    def register_metric(metric)
+      define_singleton_method(metric.name) { metric }
+    end
+  end
+end

data/lib/yabeda/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yabeda
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-25 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -123,6 +123,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -133,7 +134,11 @@ files:
 - lib/yabeda/base_adapter.rb
 - lib/yabeda/counter.rb
 - lib/yabeda/dsl.rb
+- lib/yabeda/dsl/class_methods.rb
+- lib/yabeda/dsl/metric_builder.rb
+- lib/yabeda/dsl/option_builder.rb
 - lib/yabeda/gauge.rb
+- lib/yabeda/group.rb
 - lib/yabeda/histogram.rb
 - lib/yabeda/metric.rb
 - lib/yabeda/version.rb