yabeda 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84d57c72434b9d26ac68f5244de32338f90203c73f8c488541ea3e284ca763bf
-  data.tar.gz: c06c5b0475a260a15962c98d89346fa894eebad8200e728234814686cedbee48
+  metadata.gz: 30e7d6e3fee4aac1922285af3fe9abc61cbfedff88ec2c2b95f70478383c02df
+  data.tar.gz: b5ff1691c1c692672b3d03fd46fc13f299d8851f61d3a65e1571389787b8b050
 SHA512:
-  metadata.gz: ce0c24fc3f77ae77295b9b0746cc4885743a60bb9d02ce092f71beaf4493cf9bf135703ebfbb39d44c990aa2409c4e423fe99aeeebb6ac1f0cec2f0b5279496e
-  data.tar.gz: 3f709b4c288ccf9fed8ddf9f890de3182c427cfe3837e3bb47cc70eec350a754ee19736fd788eaa6b7ed3a9f785160301d597eff5347fa4506667ae16c4027d2
+  metadata.gz: 0b0872f973fe39a30be8c3c74f91e7c472aa246f7be08ed0d719c605b9ab42c7625b47c294dec04a15f82b4cc90984953b5658cc8041c51776ce3bb3ea70a1a9
+  data.tar.gz: 6ae9978212486a4deeefbb173cc7c103f5fa3a3f64db4c5ec21188a9a38aa94af39c741b900970ab5649d5ced0bf5979acd65bd531fdfa7b577640d85e7ab531

data/CHANGELOG.md

@@ -5,6 +5,14 @@ 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.4.0 - 2020-01-28
+
+### Changed
+
+ - Configuration of gem was changed from synchronous (at the moment when `configure` block was executed) to postponed (only on `configure!` method call). [@Envek]
+
+   This should allow to fix problems when metrics from gems are registered too early, before required changes to the monitoring system clients.
+
 ## 0.3.0 - 2020-01-15
 
 ### Added
@@ -41,4 +49,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
  - Initial release of evil-metrics gem. @Envek
 
+[@Envek]: https://github.com/Envek "Andrey Novikov"
 [@asusikov]: https://github.com/asusikov "Alexander Susikov"

data/README.md

@@ -43,7 +43,15 @@ And then execute:
     end
     ```
 
- 2. Access metric in your app and use it!
+ 2. After your application was initialized and all metrics was declared, you need to apply Yabeda configuration:
+
+    ```ruby
+    Yabeda.configure!
+    ```
+
+    _But [yabeda-rails] will do this for you automatically._
+
+ 3. Access metric in your app and use it!
 
     ```ruby
     def ring_the_bell(id)
@@ -59,7 +67,7 @@ And then execute:
     end
     ```
 
- 3. Setup collecting of metrics that do not tied to specific events in you application. E.g.: reporting your app's current state
+ 4. 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
@@ -71,15 +79,15 @@ And then execute:
     end
     ```
 
-  4. _Optionally_ setup default tags that will be added to all metrics
+  5. _Optionally_ setup default tags that will be added to all metrics
      ```ruby
      Yabeda.configure do
        default_tag :rails_environment, 'production'
      end
      ```
 
-  5. See the docs for the adapter you're using
-  6. Enjoy!
+  6. See the docs for the adapter you're using
+  7. Enjoy!
 
 ## Roadmap (aka TODO or Help wanted)
 
@@ -116,3 +124,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[yabeda-rails]: https://github.com/yabeda-rb/yabeda-rails/ "Yabeda plugin for collecting and exporting basic metrics for Rails applications"

data/lib/yabeda.rb

@@ -5,6 +5,7 @@ require "concurrent"
 require "yabeda/version"
 require "yabeda/dsl"
 require "yabeda/tags"
+require "yabeda/errors"
 
 # Extendable framework for collecting and exporting metrics from Ruby apps
 module Yabeda
@@ -45,5 +46,43 @@ module Yabeda
         instance.register!(metric)
       end
     end
+
+    # @return [Array<Proc>] All configuration blocks for postponed setup
+    def configurators
+      @configurators ||= Concurrent::Array.new
+    end
+
+    # @return [Boolean] Whether +Yabeda.configure!+ has been already called
+    def configured?
+      !@configured_by.nil?
+    end
+    alias already_configured? configured?
+
+    # Perform configuration: registration of metrics and collector blocks
+    # @return [void]
+    def configure!
+      raise(AlreadyConfiguredError, @configured_by) if already_configured?
+
+      configurators.each do |(group, block)|
+        group group
+        class_eval(&block)
+        group nil
+      end
+
+      @configured_by = caller_locations(1, 1)[0].to_s
+    end
+
+    # Forget all the configuration.
+    # For testing purposes as it doesn't rollback changes in adapters.
+    # @api private
+    def reset!
+      default_tags.clear
+      adapters.clear
+      groups.clear
+      metrics.clear
+      collectors.clear
+      configurators.clear
+      instance_variable_set(:@configured_by, nil)
+    end
   end
 end

data/lib/yabeda/dsl/class_methods.rb

@@ -14,7 +14,8 @@ module Yabeda
     module ClassMethods
       # Block for grouping and simplifying configuration of related metrics
       def configure(&block)
-        class_exec(&block)
+        Yabeda.configurators.push([@group, block])
+        class_exec(&block) if Yabeda.configured?
         @group = nil
       end
 

data/lib/yabeda/dsl/metric_builder.rb

@@ -3,8 +3,6 @@
 require "yabeda/dsl/option_builder"
 
 module Yabeda
-  class ConfigurationError < StandardError; end
-
   module DSL
     # Handles DSL for working with individual metrics
     class MetricBuilder

data/lib/yabeda/errors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Yabeda
+  class ConfigurationError < StandardError; end
+
+  # Raises on repeated call to +Yabeda.configure!+
+  class AlreadyConfiguredError < StandardError
+    def initialize(configuring_location)
+      super
+      @message = "Yabeda was already configured in #{configuring_location}"
+    end
+
+    attr_reader :message
+  end
+end

data/lib/yabeda/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -137,6 +137,7 @@ files:
 - lib/yabeda/dsl/class_methods.rb
 - lib/yabeda/dsl/metric_builder.rb
 - lib/yabeda/dsl/option_builder.rb
+- lib/yabeda/errors.rb
 - lib/yabeda/gauge.rb
 - lib/yabeda/group.rb
 - lib/yabeda/histogram.rb