yabeda 0.3.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84d57c72434b9d26ac68f5244de32338f90203c73f8c488541ea3e284ca763bf
-  data.tar.gz: c06c5b0475a260a15962c98d89346fa894eebad8200e728234814686cedbee48
+  metadata.gz: fbc7c44d3d257c23cdbce5b423db52c4f2591c21737d939d9dce8df53c557f04
+  data.tar.gz: 9c68a889b0f978a4471b0458e4d48903ab019ae7dfc6948b55cb5a5147060127
 SHA512:
-  metadata.gz: ce0c24fc3f77ae77295b9b0746cc4885743a60bb9d02ce092f71beaf4493cf9bf135703ebfbb39d44c990aa2409c4e423fe99aeeebb6ac1f0cec2f0b5279496e
-  data.tar.gz: 3f709b4c288ccf9fed8ddf9f890de3182c427cfe3837e3bb47cc70eec350a754ee19736fd788eaa6b7ed3a9f785160301d597eff5347fa4506667ae16c4027d2
+  metadata.gz: 2cd9007fda7bd41d90a20238ac81dd4d2efe46e39f5473e7e0c318f5efb984f6b3e0843a06fb5c325514f0e4282fae98b2fcfc9f9920bdfbccfca946de32b910
+  data.tar.gz: 0d429f2971ff62ec68d36bedf089ef5f203a8c63cabaddd917704529d6aaf307999ac3d2716207abb9c37be23e42d5dcdc3115d5a6eb8551eb23ef940aefb80d

data/.rubocop.yml

@@ -10,12 +10,9 @@ Metrics/BlockLength:
   - "Gemfile"
   - "spec/**/*"
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
@@ -47,3 +44,11 @@ Style/TrailingCommaInHashLiteral:
   Enabled: true
   EnforcedStyleForMultiline: consistent_comma
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -1,5 +1,4 @@
 ---
-sudo: false
 language: ruby
 cache: bundler
 rvm:

data/CHANGELOG.md

@@ -5,6 +5,44 @@ 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.6.2 - 2020-08-04
+
+### Fixed
+
+ - Compatibility with plugins (like [yabeda-puma-plugin](https://github.com/yabeda-rb/yabeda-puma-plugin)) that for some reason configures itself after Yabeda configuration was already applied by `Yabeda.configure!` (was broken in 0.6.0). [@Envek]
+
+## 0.6.1 - 2020-07-16
+
+### Fixed
+
+ - Compatibility with Ruby < 2.6 due to usage of [new `Hash#merge(*others)` with multiple arguments](https://rubyreferences.github.io/rubychanges/2.6.html#hashmerge-with-multiple-arguments) in 0.6.0. [@Envek]
+
+## 0.6.0 - 2020-07-15
+
+### Added
+
+ - `Yabeda.with_tags` to redefine default tags for limited amount of time–for all metrics measured during a block execution. [@Envek]
+
+### Fixed
+
+ - Default tags were not sent to adapters for metrics declared before `default_tag` declaration. [@Envek]
+
+## 0.5.0 - 2020-01-29
+
+### Added
+
+ - Ability to specify aggregation policy for metrics collected from multiple process and exposed via single endpoint. [@Envek]
+
+   For now it is only used by yabeda-prometheus when official Prometheus client is configured to use file storage for metrics.
+
+## 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 +79,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/Gemfile

@@ -11,6 +11,6 @@ group :development, :test do
   gem "pry"
   gem "pry-byebug", platform: :mri
 
-  gem "rubocop"
+  gem "rubocop", "~> 0.80.0"
   gem "rubocop-rspec"
 end

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,28 @@ 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
+
+     # You can redefine them for limited amount of time
+     Yabeda.with_tags(rails_environment: 'staging') do
+       Yabeda.your_app.bells_rang_count.increment({bell_size: bell.size}, by: 1)
+     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!
+
+## Available monitoring system adapters
+
+ - [Prometheus](https://github.com/yabeda-rb/yabeda-prometheus)
+ - [Datadog](https://github.com/yabeda-rb/yabeda-datadog)
+ - [NewRelic](https://github.com/yabeda-rb/yabeda-newrelic)
+ - [Statsd](https://github.com/asusikov/yabeda-statsd)
+ - _…and more! You can write your own adapter and open a pull request to add it into this list._
 
 ## Roadmap (aka TODO or Help wanted)
 
@@ -116,3 +137,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,53 @@ 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]
+    # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
+    def configure!
+      raise(AlreadyConfiguredError, @configured_by) if already_configured?
+
+      configurators.each do |(group, block)|
+        group group
+        class_eval(&block)
+        group nil
+      end
+
+      # Register metrics in adapters after evaluating all configuration blocks
+      # to ensure that all global settings (like default tags) will be applied.
+      adapters.each_value do |adapter|
+        metrics.each_value do |metric|
+          adapter.register!(metric)
+        end
+      end
+
+      @configured_by = caller_locations(1, 1)[0].to_s
+    end
+    # rubocop: enable Metrics/MethodLength, Metrics/AbcSize
+
+    # 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
 
@@ -61,14 +62,30 @@ module Yabeda
         ::Yabeda.default_tags[name] = value
       end
 
+      # Redefine default tags for a limited amount of time
+      # @param tags Hash{Symbol=>#to_s}
+      def with_tags(**tags)
+        Thread.current[:yabeda_temporary_tags] = tags
+        yield
+      ensure
+        Thread.current[:yabeda_temporary_tags] = {}
+      end
+
+      # Get tags set by +with_tags+
+      # @api private
+      # @return Hash
+      def temporary_tags
+        Thread.current[:yabeda_temporary_tags] || {}
+      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
+        ::Yabeda.adapters.each_value { |adapter| adapter.register!(metric) } if ::Yabeda.configured?
         metric
       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/metric.rb

@@ -13,6 +13,7 @@ module Yabeda
     option :unit,    optional: true, comment: "In which units it is measured. E.g. `seconds`"
     option :per,     optional: true, comment: "Per which unit is measured `unit`. E.g. `call` as in seconds per call"
     option :group,   optional: true, comment: "Category name for grouping metrics"
+    option :aggregation, optional: true, comment: "How adapters should aggregate values from different processes"
 
     # Returns the value for the given label set
     def get(labels = {})

data/lib/yabeda/tags.rb

@@ -4,7 +4,7 @@ module Yabeda
   # Class to merge tags
   class Tags
     def self.build(tags)
-      ::Yabeda.default_tags.merge(tags)
+      ::Yabeda.default_tags.merge(Yabeda.temporary_tags).merge(tags)
     end
   end
 end

data/lib/yabeda/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -111,7 +111,7 @@ dependencies:
 description: 'Collect statistics about how your application is performing with ease.
   Export metrics to various monitoring systems.
 
-  '
+'
 email:
 - envek@envek.name
 executables: []
@@ -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
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Extensible framework for collecting metric for your Ruby application