yabeda 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8303dda88bd4a759800248c44901f651992a8d38a0d75bf1d974b169a0e3020a
-  data.tar.gz: 53247638e8aa2697ceac88c70ff6155490a6dbcda5550feee1d5243e12280085
+  metadata.gz: 7c30404230f234aefbf4f0f8341f276583b30f5cc9a75495e5c57e8acab23187
+  data.tar.gz: 980db126d071f8fe8c879798bbe35d5755819dd0384770dae7fe19d940f09840
 SHA512:
-  metadata.gz: a4a8044919d940c2d1c4f4b779303e6424d68224aae578660cdd932630a57de4f4f41bd03b9f40aa1f285ecff0c09f1c6c760597ffe04f8a1a38d8e2e28c5f9a
-  data.tar.gz: 11d0aadd135fa73fa60d9764cc518abf0966b0d44d1f607ed4244e79d1166792d4de9c9857bcfc7ec62b1641f3b843a4b0fb63de02932c9eea1fb8a1435a408b
+  metadata.gz: 20bf75e05040cc0ea26035422a4a64a5856ba683c0b98c81b756cc39311e41488972a57fca6174554d2d5175d85b7c5e59f5bd2375627cfb3756155cb31423ee
+  data.tar.gz: df6d12199c647f43858d0b6f73cd09ce1f7ab62b00190f251a7e37cbb17257b682fc844bbd65a03816c6c007e5757aef444637fcf410b65809dcccc96ae1a17a

data/.rubocop.yml

@@ -10,6 +10,9 @@ Metrics/BlockLength:
   - "Gemfile"
   - "spec/**/*"
 
+Metrics/LineLength:
+  Max: 120
+
 Style/BracesAroundHashParameters:
   EnforcedStyle: context_dependent
 

data/.travis.yml

@@ -3,7 +3,7 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-- 2.5.1
-- 2.4.4
-- 2.3.7
-before_install: gem install bundler -v 1.16.5
+- 2.5.3
+- 2.4.5
+- 2.3.8
+before_install: gem install bundler -v 1.17.0

data/README.md

@@ -1,8 +1,16 @@
 # Yabeda
 
+[![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!** 
 
-Extensible solution for easy setup of monitoring in your Ruby apps.
+Extendable solution for easy setup of monitoring in your Ruby apps.
+
+<a href="https://evilmartians.com/?utm_source=yabeda&utm_campaign=project_page">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
+> Read more about Yabeda and the reasoning behind it in Martian Chronicles: [“Meet Yabeda: Modular framework for instrumenting Ruby applications”](https://evilmartians.com/chronicles/meet-yabeda-modular-framework-for-instrumenting-ruby-applications)
 
 ## Installation
 

data/Rakefile

@@ -2,7 +2,10 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: %i[rubocop spec]

data/lib/yabeda.rb

@@ -5,14 +5,26 @@ require "concurrent"
 require "yabeda/version"
 require "yabeda/dsl"
 
+# Extendable framework for collecting and exporting metrics from Ruby apps
 module Yabeda
   include DSL
 
-  cattr_reader :metrics,    default: Concurrent::Hash.new
-  cattr_reader :adapters,   default: Concurrent::Hash.new
-  cattr_reader :collectors, default: Concurrent::Array.new
-
   class << self
+    # @return [Hash<String, Yabeda::Metric>] All registered metrics
+    def metrics
+      @metrics ||= Concurrent::Hash.new
+    end
+
+    # @return [Hash<String, Yabeda::BaseAdapter>] All loaded adapters
+    def adapters
+      @adapters ||= Concurrent::Hash.new
+    end
+
+    # @return [Array<Proc>] All collectors for periodical retrieving of metrics
+    def collectors
+      @collectors ||= Concurrent::Array.new
+    end
+
     # @param [Symbol] name
     # @param [BaseAdapter] instance
     def register_adapter(name, instance)

data/lib/yabeda/base_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Yabeda
+  # Base class for adapters to particular monitoring systems
   class BaseAdapter
     def register!(metric)
       case metric

data/lib/yabeda/dsl.rb

@@ -6,33 +6,44 @@ require "yabeda/gauge"
 require "yabeda/histogram"
 
 module Yabeda
+  # DSL for ease of work with Yabeda
   module DSL
     def self.included(base)
       base.extend 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
@@ -49,5 +60,6 @@ module Yabeda
         metric
       end
     end
+    # rubocop: enable Style/Documentation
   end
 end

data/lib/yabeda/gauge.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Yabeda
-  # Arbitrary value
+  # Arbitrary value, can be changed in both sides
   class Gauge < Metric
     def set(tags, value)
       values[tags] = value

data/lib/yabeda/histogram.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Yabeda
+  # Base class for complex metric for measuring time values that allow to
+  # calculate averages, percentiles, and so on.
   class Histogram < Metric
     option :buckets
 

data/lib/yabeda/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yabeda
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrey Novikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby