yabeda 0.1.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3a3991d4dbb2b060ba55ad682d20eb14012c8fb674cebc335e36ae5c0ab8067
-  data.tar.gz: 56190b3fae34f414ba1afa58ec0ffc05ca36ee7c5f5209148b64a7a7a9936197
+  metadata.gz: 44b181b32e9a07ba7095d67d782e85587fd76280dae1ac5e0feb0a2e5c6ed2c4
+  data.tar.gz: 7c21877d04cc6e5284934619e22e47b75047000c9b1ccb6a936f07d4f5db6fb2
 SHA512:
-  metadata.gz: def5c6a2dfaf0bff0b17aadb9af664fc5b36427c1b52eff208afc7a43f275691a32d3c2cea2c19c2abd5643339a788f78b7f30f9294a8c882897abd57d060bee
-  data.tar.gz: 3548e381cf4b1b2fefe93d0211887e040022d02f4fbfc3a23f6404407bdb82e5b5a951a446d461a333978e5892054921593c4ea4a43de956ecefecf121408c0f
+  metadata.gz: e4dfbb234b9e84e911ec9c2d5b0477d144eed2c9904d06bed7a1f773646975a1f768277db68732750f2d2d91af509cc5d97b1dbff88f541ab28afb8ee7055c1e
+  data.tar.gz: eecd735270b91d2b8e204edbf547be8f77df5094123590a900c574cb54b2a3fe95eb9295940fab6e097abd396b45417f254269f4a84a9a82ed44b6bc296f0f0f

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,9 +1,9 @@
 ---
-sudo: false
 language: ruby
 cache: bundler
 rvm:
-- 2.5.3
-- 2.4.5
-- 2.3.8
-before_install: gem install bundler -v 1.17.0
+- 2.7.0
+- 2.6.5
+- 2.5.7
+- 2.4.9
+before_install: gem install bundler -v "~> 2.0"

data/CHANGELOG.md

@@ -5,6 +5,45 @@ 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.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
+
+ - Ability to specify default tag which value will be automatically added to all metrics. [#7](https://github.com/yabeda-rb/yabeda/pull/7) by [@asusikov].
+
+## 0.2.0 - 2020-01-14
+
+### Added
+
+ - Ability to specify an optional list of allowed `tags` as an option to metric declaration. @Envek
+
+   Some monitoring systems clients (like official prometheus client for Ruby) require to declare all possible metric labels upfront.
 
 ## 0.1.3 - 2018-12-18
 
@@ -27,3 +66,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## 0.1.0 - 2018-10-03
 
  - 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

@@ -33,7 +33,7 @@ And then execute:
     ```ruby
     Yabeda.configure do
       group :your_app do
-        counter   :bells_rang_count, comment: "Total number of bells being rang"
+        counter   :bells_rang_count, comment: "Total number of bells being rang", tags: %i[bell_size]
         gauge     :whistles_active,  comment: "Number of whistles ready to whistle"
         histogram :whistle_runtime do
           comment "How long whistles are being active"
@@ -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,20 +67,40 @@ 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
       # (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
+        your_app.whistles_active.set({}, Whistle.where(state: :active).count)
       end
     end
     ```
 
-  4. See the docs for the adapter you're using
-  5. Enjoy!
+  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
+     ```
+
+  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)
 
@@ -109,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

@@ -4,6 +4,8 @@ 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
@@ -30,6 +32,11 @@ module Yabeda
       @collectors ||= Concurrent::Array.new
     end
 
+    # @return [Hash<Symbol, Symbol>] All added default tags
+    def default_tags
+      @default_tags ||= Concurrent::Hash.new
+    end
+
     # @param [Symbol] name
     # @param [BaseAdapter] instance
     def register_adapter(name, instance)
@@ -39,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/counter.rb

@@ -4,11 +4,12 @@ module Yabeda
   # Growing-only counter
   class Counter < Metric
     def increment(tags, by: 1)
-      values[tags] += by
+      all_tags = ::Yabeda::Tags.build(tags)
+      values[all_tags] += by
       ::Yabeda.adapters.each do |_, adapter|
-        adapter.perform_counter_increment!(self, tags, by)
+        adapter.perform_counter_increment!(self, all_tags, by)
       end
-      values[tags]
+      values[all_tags]
     end
 
     def values

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
 
@@ -53,13 +54,36 @@ module Yabeda
         register_metric(metric)
       end
 
+      # Add default tag for all metric
+      #
+      # @param name [Symbol] Name of default tag
+      # @param value [String] Value of default tag
+      def default_tag(name, value)
+        ::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
         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
@@ -21,8 +19,8 @@ module Yabeda
 
       def initialize_metric(params, options, group)
         metric_klass.new(*params, **options, group: group)
-      rescue KeyError => error
-        raise ConfigurationError, "#{error.message} for #{metric_klass.name}"
+      rescue KeyError => e
+        raise ConfigurationError, "#{e.message} for #{metric_klass.name}"
       end
     end
   end

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/gauge.rb

@@ -4,9 +4,10 @@ module Yabeda
   # Arbitrary value, can be changed in both sides
   class Gauge < Metric
     def set(tags, value)
-      values[tags] = value
+      all_tags = ::Yabeda::Tags.build(tags)
+      values[all_tags] = value
       ::Yabeda.adapters.each do |_, adapter|
-        adapter.perform_gauge_set!(self, tags, value)
+        adapter.perform_gauge_set!(self, all_tags, value)
       end
       value
     end

data/lib/yabeda/histogram.rb

@@ -7,9 +7,10 @@ module Yabeda
     option :buckets
 
     def measure(tags, value)
-      values[tags] = value
+      all_tags = ::Yabeda::Tags.build(tags)
+      values[all_tags] = value
       ::Yabeda.adapters.each do |_, adapter|
-        adapter.perform_histogram_measure!(self, tags, value)
+        adapter.perform_histogram_measure!(self, all_tags, value)
       end
       value
     end

data/lib/yabeda/metric.rb

@@ -9,9 +9,11 @@ module Yabeda
 
     param  :name,                    comment: "Metric name. Use snake_case. E.g. job_runtime"
     option :comment, optional: true, comment: "Documentation string. Required by some adapters."
+    option :tags,    optional: true, comment: "Allowed labels to be set. Required by some adapters."
     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 = {})
@@ -21,5 +23,9 @@ module Yabeda
     def values
       @values ||= Concurrent::Hash.new
     end
+
+    def tags
+      (Yabeda.default_tags.keys + Array(super)).uniq
+    end
   end
 end

data/lib/yabeda/tags.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Yabeda
+  # Class to merge tags
+  class Tags
+    def self.build(tags)
+      ::Yabeda.default_tags.merge(Yabeda.temporary_tags, tags)
+    end
+  end
+end

data/lib/yabeda/version.rb

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

data/yabeda.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "dry-initializer"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "yard"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrey Novikov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,10 +108,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Collect statistics about how your application is performing with ease.     Export
-  metrics to various monitoring systems.
+description: 'Collect statistics about how your application is performing with ease.
+  Export metrics to various monitoring systems.
 
-'
+  '
 email:
 - envek@envek.name
 executables: []
@@ -137,17 +137,19 @@ 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
 - lib/yabeda/metric.rb
+- lib/yabeda/tags.rb
 - lib/yabeda/version.rb
 - yabeda.gemspec
 homepage: https://github.com/yabeda-rb/yabeda
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,9 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Extensible framework for collecting metric for your Ruby application
 test_files: []