active_metrics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ed1297fe6d975516ee3607c0adb3d4bb2f26fe8
+  data.tar.gz: 86f76bc841aa9eddf53f2e6c13f393dc218987f3
+SHA512:
+  metadata.gz: 91489920993ab225dda277c72c6b0d43a97dade84122c4e15085cef3c53c506bdc6029b44c8a7869bab34beaa6328f41e7cfc7b09172782a5f745ebe9966c094
+  data.tar.gz: 63dbabc8ddba27fa7be55eace95a920fa8590c9e7882fcb3831484449d25b778953b8825f5abecf33e31d2aa287ddca5a06e0c5cc7cc9dd8694e7cdf5683c754

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/docker-compose.override.yml
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Dockerfile

@@ -0,0 +1,62 @@
+FROM ruby:2.4.2-slim
+
+# Bundler options
+#
+# The default value is taken from Travis's build options, so they should be
+# good enough for most cases. For development, be sure to set a blank default
+# in docker-compose.override.yml.
+ARG BUNDLER_OPTS="--jobs=3 \
+                  --retry=3 \
+                  --deployment"
+
+# The home directory of the gem.
+#
+# During development, make sure that the APP_DIR environment variable is
+# identical to the variable in your docker-compose.override.yml file,
+# otherwise things might not work as expected.
+ENV APP_DIR="/opt/active_metrics"
+
+# Install required packages
+RUN apt-get update -y \
+      && apt-get install -y --no-install-recommends \
+        git-core \
+        build-essential \
+        libffi-dev \
+        libxml2-dev \
+        libssl-dev \
+        libcurl4-gnutls-dev \
+        apt-utils \
+      && rm -rf /var/lib/apt/lists/*
+
+# Create a non-root user
+RUN groupadd -r travis \
+    && useradd -m -r -g travis travis
+RUN mkdir -p ${APP_DIR} \
+    && chown -R travis:travis ${APP_DIR}
+
+# Move the the application folder to perform all the following tasks.
+WORKDIR ${APP_DIR}
+# Use the non-root user to perform any commands from this point forward.
+#
+# NOTE: The COPY command requires the --chown flag set otherwise it will
+#       copy things as root.
+USER travis
+
+# Copy the gem's gemspec file so `bundle install` can run when the
+# container is initialized.
+#
+# The added benefit is that Docker will cache this file and will not trigger
+# the bundle install unless the gemspec changed on the filesystem.
+#
+# NOTE: If the command fails because of the --chown flag, make sure you have a
+#       recent stable version of Docker.
+COPY --chown=travis:travis . ./
+
+
+RUN bundle install ${BUNDLER_OPTS}
+
+# Copy over the files, in case the Docker Compose file does not specify a
+# mount point.
+COPY --chown=travis:travis . ./
+
+CMD ["bash"]

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_metrics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    active_metrics (0.0.1)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    docile (1.1.5)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  active_metrics!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  pry (~> 0.11)
+  rake (~> 10.0)
+  simplecov (~> 0.15)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrei Maxim
+
+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,52 @@
+# ActiveMetrics
+
+[![Build Status](https://travis-ci.org/andreimaxim/active_metrics.svg?branch=master)](https://travis-ci.org/andreimaxim/active_metrics)
+[![Maintainability](https://api.codeclimate.com/v1/badges/50e30f3b65985e299e9e/maintainability)](https://codeclimate.com/github/andreimaxim/active_metrics/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/50e30f3b65985e299e9e/test_coverage)](https://codeclimate.com/github/andreimaxim/active_metrics/test_coverage)
+
+
+A gem to simplify how metrics are being collected in Ruby-based applications.
+
+As of now, the code is tested and optimized for usage on Heroku with the Librato
+add-on and all the metrics are collected via the application log.
+
+## Usage
+
+Make sure that you start the collector somewhere in an initializer or before the
+you want to start collecting metrics:
+
+```ruby
+ActiveMetrics::Collector.attach
+```
+
+Then include the module and then start collecting the metrics you want:
+
+```ruby
+require 'active_metrics'
+
+class Foo
+
+  include ActiveMetrics::Instrumentable
+  
+  def bar
+    count 'method.bar'
+  end
+
+end
+```
+
+Available methods:
+
+* `count`: add a value (default is 1) to a counter
+* `measure`: individual measurements that comprise a statistical distribution (i.e. latency measurements)
+* `sample`: simple key/numerical value pair
+
+Be mindful of any kind of conflicts when including the module in your class.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/andreimaxim/active_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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/active_metrics.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_metrics'
+  spec.version       = ActiveMetrics::VERSION
+  spec.authors       = ['Andrei Maxim']
+  spec.email         = ['andrei@andreimaxim.ro']
+
+  spec.summary       = %q{Metrics based on ActiveSupport::Notifications}
+  spec.homepage      = 'https://github.com/andreimaxim/active_metrics'
+  spec.license       = 'MIT'
+
+  spec.cert_chain  = ['certs/andreimaxim.pem']
+  spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/
+
+  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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'pry', '~> 0.11'
+
+  # This is a bit sketchy for now as we generally need just
+  # ActiveSupport::Notifications but specifying a fixed version might create
+  # issues with various Rails installations (AS::N v4 vs Rails v5 for example)
+  #
+  # This will have to do for now, unless somebody has a better idea.
+  spec .add_dependency 'activesupport', '>= 3.0.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/certs/andreimaxim.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMQ8wDQYDVQQDDAZhbmRy
+ZWkxGzAZBgoJkiaJk/IsZAEZFgthbmRyZWltYXhpbTESMBAGCgmSJomT8ixkARkW
+AnJvMB4XDTE4MDIwODE0MDY1OVoXDTE5MDIwODE0MDY1OVowQjEPMA0GA1UEAwwG
+YW5kcmVpMRswGQYKCZImiZPyLGQBGRYLYW5kcmVpbWF4aW0xEjAQBgoJkiaJk/Is
+ZAEZFgJybzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALdTaGJxq8LS
+BvQ21mseXIg+GTwpw28yIu3I8Y4y9dbCMsYSkiFpb1Gyxkc4/OBdch5LWZMY4Kek
+tN2tesl/pI2PoCoQ6ogcn/FxBI23OK4GyYtwLq3xDPYDk4Onaa84tTLSgiZey2Ml
+sgUb0ADMS+dVJWYZDUiYJZ8vDvK//ikcLbCY05WpH2x5LpJeapzA+lOiVIn5PC3W
+lgP295hS8fqah3GF7TtC4ByFNwUnv9BrXXiaxvcQxX2KNKVib5CahTSA4R4H9nLu
+hFA/pTftVjAQGNEoUhU9O3VpUCG9Yt0oP9FUCVsUAWtuj3H+BaTak6g6FmVDTRuv
+D0ANHY5WdlUCAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+BBYEFIzifXvS7qF30ai0d+1gE3iuajBzMCAGA1UdEQQZMBeBFWFuZHJlaUBhbmRy
+ZWltYXhpbS5ybzAgBgNVHRIEGTAXgRVhbmRyZWlAYW5kcmVpbWF4aW0ucm8wDQYJ
+KoZIhvcNAQEFBQADggEBACefrEXpo9etDtbh5zpT/VdHIVhPXZvg5xsatQT/5avo
+LA/ViXzdK+vgvzSPJeTIuado4S99yCXvCcykolmeQNh3q7913oM9rdX0+hmPJGnA
+T+Bdfx/Fny1fdmPDIDmOETY3aBIhi8C4TStZId3ljbfWZMWUiwG9xPcxBAEyvQvc
+6tStBYtHshxnBdc5h6K7pzhfVxQJwW2ginSpmcRFKjw6laDKKywYprRWKuVMM42t
+rPPwQsEaMMSGpCTMKe7vlWXJhWOuC9msqqkU/o5TeSuEEsr5kflYoXMI41nC4sz7
+P4zlDD+LhwEtllWACsKJgJFkEy28Mp1o4lQM4zO3I/E=
+-----END CERTIFICATE-----

data/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '3'
+
+services:
+
+  gem:
+    build: .

data/lib/active_metrics/collector.rb

@@ -0,0 +1,49 @@
+module ActiveMetrics
+  class Collector
+
+    PREFIX = 'com.active_metrics'.freeze
+
+    class << self
+
+      # Start subscribing to the metrics-related events.
+      def attach
+        ActiveSupport::Notifications.subscribe(/#{PREFIX}/i) do |name, _, _, _, data|
+          deliver(name, data)
+        end
+      end
+
+      # Deliver a metric to Librato
+      #
+      # According to the Heroku DevCenter there is already a tight integration
+      # between Heroku logs and Librato so simply using `$stdout.puts` will be
+      # enough, as long as a specific format is used.
+      #
+      # @param name [String] The name of the event being measured
+      # @param data [Hash] a Hash with type of metric and the value to be recorded
+      def deliver(name, data = {})
+        key    = name.gsub(PREFIX, '')
+        value  = data[:value]
+        metric = data[:metric]
+
+        $stdout.puts "#{metric}##{key}=#{value}"
+      end
+
+      # Record an event
+      #
+      # @param event [String] The name of the event
+      # @param payload [Hash] A hash that contains the event-related data.
+      def record(event, payload = {})
+        # Add a prefix to all events so things broadcasted using this method
+        # will not get picked up by possibly other `ActiveSupport::Notifications`
+        # subscribers.
+        name = "#{PREFIX}#{event}"
+
+        if block_given?
+          ActiveSupport::Notifications.instrument(name, payload) { yield }
+        else
+          ActiveSupport::Notifications.instrument(name, payload)
+        end
+      end
+    end
+  end
+end

data/lib/active_metrics/instrumentable.rb

@@ -0,0 +1,46 @@
+module ActiveMetrics
+  ##
+  # Custom metrics for Librato
+  module Instrumentable
+
+    # Count log lines are used to submit increments to Librato.
+    #
+    # You can submit increments as frequently as desired and every minute the
+    # current total will be flushed to Librato and reset to zero.
+    #
+    # @param event [String] The name of the event
+    # @param number [Integer] The number to increment the current count (defaults to 1)
+    def count(event, number = 1)
+      ActiveMetrics::Collector.record(event, { metric: 'count', value: number })
+    end
+
+    # Measure log lines are used to submit individual measurements that comprise
+    # a statistical distribution. The most common use case are timings i.e.
+    # latency measurements, but it can also be used to represent non-temporal
+    # distributions such as counts.
+    #
+    # You can submit as many measures as you’d like (typically they are
+    # submitted per-request) and every minute Librato will calculate/record a
+    # complete set of summary statistics over the measures submitted in that
+    # interval.
+    #
+    # @param event [String] The name of the event
+    # @param value [Integer, String] The value measured.
+    def measure(event, value = 0)
+      ActiveMetrics::Collector.record(event, { metric: 'measure', value: value })
+    end
+
+    # Sample metrics are used to convey simple key/numerical value pairs when
+    # you are already calculating some kind of summary statistic in your app and
+    # merely need a simple transport mechanism to Librato.
+    #
+    # Typically you would submit sample metrics on some periodic tick and set
+    # said period on the metric in Librato.
+    #
+    # @param key [String] The name of the sample
+    # @param value [Object] The value of the sample
+    def sample(key, value)
+      ActiveMetrics::Collector.record(key, { metric: 'sample', value: value })
+    end
+  end
+end

data/lib/active_metrics/version.rb

@@ -0,0 +1,3 @@
+module ActiveMetrics
+  VERSION = '0.0.1'.freeze
+end

data/lib/active_metrics.rb

@@ -0,0 +1,10 @@
+require 'active_support'
+
+require 'active_metrics/version'
+
+require 'active_metrics/collector'
+require 'active_metrics/instrumentable'
+
+module ActiveMetrics
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: active_metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrei Maxim
+autorequire: 
+bindir: exe
+cert_chain:
+- certs/andreimaxim.pem
+date: 2018-02-08 00:00:00.000000000 Z
+dependencies:
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- andrei@andreimaxim.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_metrics.gemspec
+- bin/console
+- bin/setup
+- certs/andreimaxim.pem
+- docker-compose.yml
+- lib/active_metrics.rb
+- lib/active_metrics/collector.rb
+- lib/active_metrics/instrumentable.rb
+- lib/active_metrics/version.rb
+homepage: https://github.com/andreimaxim/active_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.6.13
+signing_key: 
+specification_version: 4
+summary: Metrics based on ActiveSupport::Notifications
+test_files: []