yabeda 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a4867a0d04b93eebd708a3fcf4b21797194066c26e2a96809b85c2139926be9
-  data.tar.gz: 78a8e47cf194e30641c285505a199465518d5f6e0d1b73c07b4f4222bc2e5f31
+  metadata.gz: df5873bc79b044f45361239ef207d63f8a97776d39908652b11629dbb67fd317
+  data.tar.gz: d6d170503bfbc5ea7a2e1b2ce4415710efc1e68487350a67e270ae4b2f77c102
 SHA512:
-  metadata.gz: 9f05aeeec7451c222ebe6713da7ddca289b1922ff294f3acd0ad8350647e996173ac5c2a642445011cf8549cfc3db4e9a8d804ab74da4cc946e536b14ffa773e
-  data.tar.gz: d8e3b98d6889f4af3af3273c9e8abfc876b778eeb2bddd94babf9489dcb421d4ab5412f58b293026e6ecffc066ea3eaa42b6965192a5fa22b928a246e9a75de2
+  metadata.gz: a8bde67925e08a45425963e778c1e6cd5dcc9a24c46cce96abeb84d56adc99529ecc58556cb930652be64d7cea604563181b69abc1157388e896d9eb76af53a8
+  data.tar.gz: 77d9400f003c06e387b3b75cf42d95a52546c2b240021905e649198fe78f0ff2b502da771dbce50c95e837608218026bbea5e310334371cc417567ee67c60392

data/CHANGELOG.md

@@ -5,6 +5,20 @@ 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).
 
+## Unreleased
+
+## 0.10.0 - 2021-07-21
+
+### Added
+
+- Ability to pass a block to `Yabeda::Histogram#measure` to automatically measure its runtime in seconds using [monotonic time](https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/).
+- Debug mode that will enable some additional metrics to help debug performance issues with your usage of Yabeda (or Yabeda itself). Use environment variable `YABEDA_DEBUG` to enable it or call `Yabeda.debug!`.
+- Debugging histogram `yabeda_collect_duration` that measures duration of every collect block, as they are used for collecting metrics of application state and usually makes some potentially slow queries to databases, network requests, etc.
+
+### Changed
+
+- Adapters now should use method `Yabeda.collect!` instead of manual calling of every collector block. 
+
 ## 0.9.0 - 2021-05-07
 
 ### Added

data/README.md

@@ -1,4 +1,4 @@
-# Yabeda
+# ![Yabeda](./yabeda-logo.png)
 
 [![Gem Version](https://badge.fury.io/rb/yabeda.svg)](https://rubygems.org/gems/yabeda)
 
@@ -147,6 +147,20 @@ These are developed and maintained by other awesome folks:
  - [yabeda-gc](https://github.com/ianks/yabeda-gc) — metrics for Ruby garbage collection.
  - _…and more! You can write your own adapter and open a pull request to add it into this list._
 
+## Configuration
+
+Configuration is handled by [anyway_config] gem. With it you can load settings from environment variables (which names are constructed from config key upcased and prefixed with `YABEDA_`), YAML files, and other sources. See [anyway_config] docs for details.
+
+Config key | Type     | Default | Description |
+---------- | -------- | ------- | ----------- |
+`debug`    | boolean  | `false` | Collects metrics measuring Yabeda performance |
+
+## Debugging metrics
+
+ - Time of collector block run: `yabeda_collect_duration` (segmented by block source location). Collector blocks are used for collecting metrics of application state and usually makes some potentially slow queries to databases, network requests, etc.
+
+These are only enabled in debug mode. To enable it either set `debug` config key to `true` (e.g. by specifying `YABEDA_DEBUG=true` in your environment variables or executing `Yabeda.debug!` in your code).
+
 ## Roadmap (aka TODO or Help wanted)
 
  - Ability to change metric settings for individual adapters
@@ -220,3 +234,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 [yabeda-puma-plugin]: https://github.com/yabeda-rb/yabeda-puma-plugin/ "Collects Puma web-server metrics from puma control application"
 [yabeda-http_requests]: https://github.com/yabeda-rb/yabeda-http_requests/ "Builtin metrics to monitor external HTTP requests"
 [yabeda-schked]: https://github.com/yabeda-rb/yabeda-schked/ "Built-in metrics for monitoring Schked recurring jobs out of the box"
+[anyway_config]: https://github.com/palkan/anyway_config "Configuration library for Ruby gems and applications"

data/lib/yabeda.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require "concurrent"
+require "forwardable"
 
 require "yabeda/version"
+require "yabeda/config"
 require "yabeda/dsl"
 require "yabeda/tags"
 require "yabeda/errors"
@@ -13,6 +15,8 @@ module Yabeda
   include DSL
 
   class << self
+    extend Forwardable
+
     # @return [Hash<String, Yabeda::Metric>] All registered metrics
     def metrics
       @metrics ||= Concurrent::Hash.new
@@ -35,6 +39,25 @@ module Yabeda
       @collectors ||= Concurrent::Array.new
     end
 
+    def config
+      @config ||= Config.new
+    end
+
+    def_delegators :config, :debug?
+
+    # Execute all collector blocks for periodical retrieval of metrics
+    #
+    # This method is intended to be used by monitoring systems adapters
+    def collect!
+      collectors.each do |collector|
+        if config.debug?
+          yabeda.collect_duration.measure({ location: collector.source_location.join(":") }, &collector)
+        else
+          collector.call
+        end
+      end
+    end
+
     # @return [Hash<Symbol, Symbol>] All added global default tags
     def default_tags
       @default_tags ||= Concurrent::Hash.new
@@ -67,6 +90,8 @@ module Yabeda
     def configure!
       raise(AlreadyConfiguredError, @configured_by) if already_configured?
 
+      debug! if config.debug?
+
       configurators.each do |(group, block)|
         group group
         class_eval(&block)
@@ -83,6 +108,27 @@ module Yabeda
 
       @configured_by = caller_locations(1, 1)[0].to_s
     end
+
+    # Enable and setup service metrics to monitor yabeda performance
+    def debug!
+      return false if @debug_was_enabled_by # Prevent multiple calls
+
+      config.debug ||= true # Enable debug mode in config if it wasn't enabled from other sources
+      @debug_was_enabled_by = caller_locations(1, 1)[0].to_s
+
+      configure do
+        group :yabeda
+
+        histogram :collect_duration,
+                  tags: %i[location], unit: :seconds,
+                  buckets: [0.0001, 0.001, 0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60].freeze,
+                  comment: "A histogram for the time required to evaluate collect blocks"
+      end
+
+      adapters.each_value(&:debug!)
+
+      true
+    end
     # rubocop: enable Metrics/MethodLength, Metrics/AbcSize
 
     # Forget all the configuration.
@@ -99,6 +145,7 @@ module Yabeda
       collectors.clear
       configurators.clear
       instance_variable_set(:@configured_by, nil)
+      instance_variable_set(:@debug_was_enabled_by, nil)
     end
     # rubocop: enable Metrics/AbcSize
   end

data/lib/yabeda/base_adapter.rb

@@ -35,5 +35,8 @@ module Yabeda
     def perform_histogram_measure!(_metric, _tags, _value)
       raise NotImplementedError, "#{self.class} doesn't support measuring histograms"
     end
+
+    # Hook to enable debug mode in adapters when it is enabled in Yabeda itself
+    def debug!; end
   end
 end

data/lib/yabeda/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "anyway"
+
+module Yabeda
+  # Runtime configuration for the main yabeda gem
+  class Config < ::Anyway::Config
+    config_name :yabeda
+
+    # Declare and collect metrics about Yabeda performance
+    attr_config debug: false
+  end
+end

data/lib/yabeda/histogram.rb

@@ -6,7 +6,18 @@ module Yabeda
   class Histogram < Metric
     option :buckets
 
-    def measure(tags, value)
+    # rubocop: disable Metrics/MethodLength
+    def measure(tags, value = nil)
+      if value.nil? ^ block_given?
+        raise ArgumentError, "You must provide either numeric value or block for Yabeda::Histogram#measure!"
+      end
+
+      if block_given?
+        starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        yield
+        value = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - starting)
+      end
+
       all_tags = ::Yabeda::Tags.build(tags, group)
       values[all_tags] = value
       ::Yabeda.adapters.each do |_, adapter|
@@ -14,5 +25,6 @@ module Yabeda
       end
       value
     end
+    # rubocop: enable Metrics/MethodLength
   end
 end

data/lib/yabeda/version.rb

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

data/yabeda.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "anyway_config", ">= 1.3", "< 3"
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "dry-initializer"
 

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: yabeda
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +153,7 @@ files:
 - bin/setup
 - lib/yabeda.rb
 - lib/yabeda/base_adapter.rb
+- lib/yabeda/config.rb
 - lib/yabeda/counter.rb
 - lib/yabeda/dsl.rb
 - lib/yabeda/dsl/class_methods.rb
@@ -147,6 +168,7 @@ files:
 - lib/yabeda/railtie.rb
 - lib/yabeda/tags.rb
 - lib/yabeda/version.rb
+- yabeda-logo.png
 - yabeda.gemspec
 homepage: https://github.com/yabeda-rb/yabeda
 licenses: