evil-metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57989b99c00c0dd7cbdb6867dc01c4bd1769d3399e53d47c498e82efce5992c2
+  data.tar.gz: 4723e6fab2b8b7203693426bac3130f32187209ed094bfda0946ce2ce3da893c
+SHA512:
+  metadata.gz: c8bf69f0e6ecd8a2b8f020b62751f85fdc8980f156042a4c1ad6a152aa235e6b9c9052698c3978ba58af371f49585b1b9db8873a3a6df231523561f451b65904
+  data.tar.gz: 0f414417e7dff665730c07527761e05dd7e0751bed0e102ff4f17278c4f1a0241adc42f49d54f40d163e42eab51e48ffa7053aa917ff43ba020c786392dd9b46

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+---
+require:
+- rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+  - "Gemfile"
+  - "spec/**/*"
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Allow to use let!
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-params-comma'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+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

data/.yardopts

@@ -0,0 +1 @@
+--plugin dry-initializer

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in evil-metrics.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry"
+  gem "pry-byebug", platform: :mri
+
+  gem "rubocop"
+  gem "rubocop-rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Novikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# Evil::Metrics
+
+**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.
+
+## Installation
+
+Most of the time you don't need to add this gem to your Gemfile directly (unless you're only collecting your custom metrics):
+
+```ruby
+gem 'evil-metrics'
+# Then add monitoring system adapter, e.g.:
+# gem 'evil-metrics-prometheus'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+ 1. Declare your metrics:
+
+    ```ruby
+    Evil::Metrics.configure do
+      group :your_app
+    
+      counter   :bells_rang_count, "Total number of bells being rang"
+      gauge     :whistles_active,  "Number of whistles ready to whistle"
+      histogram :whistle_runtime,  "How long whistles are being active", unit: :seconds
+    end
+    ```
+    
+ 2. Access metric in your app and use it!
+ 
+    ```ruby
+    def ring_the_bell(id)
+      bell = Bell.find(id)
+      bell.ring!
+      Evil::Metrics.your_app_bells_rang_count.increment({bell_size: bell.size}, by: 1)
+    end
+
+    def whistle!
+      Evil::Metrics.your_app_whistle_runtime.measure do
+        # Run your code
+      end
+    end
+    ```
+    
+ 3. Setup collecting of metrics that do not tied to specific events in you application. E.g.: reporting your app's current state
+    ```ruby
+    Evil::Metrics.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
+      end
+    end
+    ```
+
+  4. See the docs for the adapter you're using
+  5. Enjoy!
+
+## Roadmap (aka TODO or Help wanted)
+
+ - Ability to change metric settings for individual adapters
+ 
+   ```rb
+   histogram :foo, comment: "say what?" do
+     adapter :prometheus do
+       buckets [0.01, 0.5, …, 60, 300, 3600]
+     end
+   end
+   ```
+   
+ - Ability to route some metrics only for given adapter:
+ 
+   ```rb
+   adapter :prometheus do
+     include_group :sidekiq
+   end
+   ```
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/evil-metrics/evil-metrics.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "evil/metrics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/evil-metrics.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "evil/metrics/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "evil-metrics"
+  spec.version       = Evil::Metrics::VERSION
+  spec.authors       = ["Andrey Novikov"]
+  spec.email         = ["envek@envek.name"]
+
+  spec.summary       = "Extensible framework for collecting metric for your Ruby application"
+  spec.description   = <<~DESCRIPTION
+    Collect statistics about how your application is performing with ease. \
+    Export metrics to various monitoring systems.
+  DESCRIPTION
+  spec.homepage      = "https://github.com/evil-metrics/evil-metrics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "concurrent-ruby"
+  spec.add_dependency "dry-initializer"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "yard-dry-initializer"
+end

data/lib/evil/metrics.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "concurrent"
+
+require "evil/metrics/version"
+require "evil/metrics/dsl"
+
+module Evil
+  module Metrics
+    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
+      # @param [Symbol] name
+      # @param [BaseAdapter] instance
+      def register_adapter(name, instance)
+        adapters[name] = instance
+        # NOTE: Pretty sure there is race condition
+        metrics.each do |_, metric|
+          instance.register!(metric)
+        end
+      end
+    end
+  end
+end

data/lib/evil/metrics/base_adapter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Evil
+  module Metrics
+    class BaseAdapter
+      def register!(metric)
+        case metric
+        when Counter   then register_counter!(metric)
+        when Gauge     then register_gauge!(metric)
+        when Histogram then register_histogram!(metric)
+        else raise "#{metric.class} is unknown metric type"
+        end
+      end
+
+      def register_counter!(_metric)
+        raise NotImplementedError, "#{self.class} doesn't support counters as metric type!"
+      end
+
+      def perform_counter_increment!(_counter, _tags, _increment)
+        raise NotImplementedError, "#{self.class} doesn't support incrementing counters"
+      end
+
+      def register_gauge!(_metric)
+        raise NotImplementedError, "#{self.class} doesn't support gauges as metric type!"
+      end
+
+      def perform_gauge_set!(_metric, _tags, _value)
+        raise NotImplementedError, "#{self.class} doesn't support setting gauges"
+      end
+
+      def register_histogram!(_metric)
+        raise NotImplementedError, "#{self.class} doesn't support histograms as metric type!"
+      end
+
+      def perform_histogram_measure!(_metric, _tags, _value)
+        raise NotImplementedError, "#{self.class} doesn't support measuring histograms"
+      end
+    end
+  end
+end

data/lib/evil/metrics/counter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Evil
+  module Metrics
+    # Growing-only counter
+    class Counter < Metric
+      def increment(tags, by: 1)
+        values[tags] += by
+        ::Evil::Metrics.adapters.each do |_, adapter|
+          adapter.perform_counter_increment!(self, tags, by)
+        end
+        values[tags]
+      end
+
+      def values
+        @values ||= Concurrent::Hash.new(0)
+      end
+    end
+  end
+end

data/lib/evil/metrics/dsl.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "evil/metrics/metric"
+require "evil/metrics/counter"
+require "evil/metrics/gauge"
+require "evil/metrics/histogram"
+
+module Evil
+  module Metrics
+    module DSL
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def configure(&block)
+          class_exec(&block)
+          @group = nil
+        end
+
+        def collect(&block)
+          ::Evil::Metrics.collectors.push(block)
+        end
+
+        def group(group_name)
+          @group = group_name
+        end
+
+        def counter(*args, **kwargs)
+          register(Counter.new(*args, **kwargs, group: @group))
+        end
+
+        def gauge(*args, **kwargs)
+          register(Gauge.new(*args, **kwargs, group: @group))
+        end
+
+        def histogram(*args, **kwargs)
+          register(Histogram.new(*args, **kwargs, group: @group))
+        end
+
+        private
+
+        def register(metric)
+          name = [metric.group, metric.name].compact.join("_")
+          ::Evil::Metrics.define_singleton_method(name) { metric }
+          ::Evil::Metrics.metrics[name] = metric
+          ::Evil::Metrics.adapters.each do |_, adapter|
+            adapter.register!(metric)
+          end
+          metric
+        end
+      end
+    end
+  end
+end

data/lib/evil/metrics/gauge.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Evil
+  module Metrics
+    # Arbitrary value
+    class Gauge < Metric
+      def set(tags, value)
+        values[tags] = value
+        ::Evil::Metrics.adapters.each do |_, adapter|
+          adapter.perform_gauge_set!(self, tags, value)
+        end
+        value
+      end
+    end
+  end
+end

data/lib/evil/metrics/histogram.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Evil
+  module Metrics
+    class Histogram < Metric
+      option :buckets
+
+      def measure(tags, value)
+        values[tags] = value
+        ::Evil::Metrics.adapters.each do |_, adapter|
+          adapter.perform_histogram_measure!(self, tags, value)
+        end
+        value
+      end
+    end
+  end
+end

data/lib/evil/metrics/metric.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "dry-initializer"
+
+module Evil
+  module Metrics
+    # Base class for all metrics
+    class Metric
+      extend Dry::Initializer
+
+      param  :name,                    comment: "Metric name. Use snake_case. E.g. job_runtime"
+      option :comment, optional: true, comment: "Documentation string. 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"
+
+      # Returns the value for the given label set
+      def get(labels = {})
+        values[labels]
+      end
+
+      def values
+        @values ||= Concurrent::Hash.new
+      end
+    end
+  end
+end

data/lib/evil/metrics/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Evil
+  module Metrics
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: evil-metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Collect statistics about how your application is performing with ease.     Export
+  metrics to various monitoring systems.
+
+'
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- evil-metrics.gemspec
+- lib/evil/metrics.rb
+- lib/evil/metrics/base_adapter.rb
+- lib/evil/metrics/counter.rb
+- lib/evil/metrics/dsl.rb
+- lib/evil/metrics/gauge.rb
+- lib/evil/metrics/histogram.rb
+- lib/evil/metrics/metric.rb
+- lib/evil/metrics/version.rb
+homepage: https://github.com/evil-metrics/evil-metrics
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Extensible framework for collecting metric for your Ruby application
+test_files: []