active_metrics 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82af20ffaf35ac07447725515c74159d5d6c7605
-  data.tar.gz: 6398d51851ec95a8821e9c68343d5200a5a00197
+SHA256:
+  metadata.gz: a99f62aed5e38e762fcaba320d21fce604fb938d6e5d88d7149c427c4e631522
+  data.tar.gz: 1c41b03b70bee9233f393d56928bf27a7d1ccdbc73fe15ad26463e18a30adc6a
 SHA512:
-  metadata.gz: 9c631ce7c816a8ed6e7d57efa628d6f289c36c769b8ad7f52fd60775038137230c7fb116ec882fb106021bca5ffcf35734054e1055d649909d5c530a95e74479
-  data.tar.gz: c98272fcde5a3783f70b96189b8e1d17ea6dbdfd80dca23ed9f3a36b3d5facbaada2b4fee48c976286b61ce61e3d88bef5b8a2cefb86f35a046ff38862836af6
+  metadata.gz: 819bfc8020b1a0a1a73d9bcf71a9ac6bde6221e8f5e9a59e2f209f3df04aa92a30fa8ec7ef852dee7099326cfecd29a779b9af4b0f23306e466564e2894456ae
+  data.tar.gz: 541ec4d9652984784e88cc474e9e495926bba7c43899d698e2e55e3d4c4fb7160278ed083dc002cf5ca8566ebf41091ce48479413897e7a08097401123f57399

data/Dockerfile

@@ -1,50 +1,50 @@
-FROM ruby:2.5.0
-
-# 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"
-
-# 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 . ./
-
+FROM ruby:2.5.0
+
+# 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"
+
+# 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.lock

@@ -23,7 +23,7 @@ GEM
     pry (0.11.1)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
+    rake (13.0.1)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -42,8 +42,8 @@ DEPENDENCIES
   bundler (~> 1.16)
   minitest (~> 5.0)
   pry (~> 0.11)
-  rake (~> 10.0)
+  rake (~> 13.0)
   simplecov (~> 0.15)
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/README.md

@@ -28,7 +28,7 @@ require 'active_metrics'
 class Foo
 
   include ActiveMetrics::Instrumentable
-  
+
   def bar
     count 'method.bar'
   end
@@ -44,6 +44,12 @@ Available methods:
 
 Be mindful of any kind of conflicts when including the module in your class.
 
+### Disabling the metrics
+
+For various environments (development and QA), the metrics can be a bit too
+verbose and have very little value. In those cases, the metrics can be disabled
+using by using the `SILENT_METRICS=1` environment variable.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/andreimaxim/active_metrics.]()

data/active_metrics.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_metrics/version'
@@ -21,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'simplecov', '~> 0.15'
   spec.add_development_dependency 'pry', '~> 0.11'

data/docker-compose.yml

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

data/lib/active_metrics/collector.rb

@@ -1,49 +1,57 @@
-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
+module ActiveMetrics
+  class Collector
+
+    PREFIX = 'com.active_metrics'.freeze
+
+    class << self
+
+      # Should the metrics be silent?
+      #
+      # Useful especially in QA or development environments, where you'll
+      # might not want your logs to be filled with various metrics.
+      def silent?
+        [1, '1', 'true'].include?(ENV['SILENT_METRICS'])
+      end
+
+      # 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}" unless silent?
+      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

@@ -1,67 +1,67 @@
-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.
-    #
-    # The `measure` method also accepts a block of code which will automatically
-    # measure the amount of time spent running that block:
-    #
-    #     measure 'foo.bar.baz' do
-    #       Foo.bar #=> 'baz'
-    #     end
-    #
-    # For convenience, when `measure` is used with a block it will return the
-    # value returned by the block.
-    #
-    # @param event [String] The name of the event
-    # @param value [Integer, String] The value measured.
-    def measure(event, value = 0)
-      if block_given?
-        time = Time.now
-        # Store the value returned by the block for future reference
-        value = yield
-        delta = Time.now - time
-
-        ActiveMetrics::Collector.record(event, { metric: 'measure', value: delta })
-
-        value
-      else
-        ActiveMetrics::Collector.record(event, { metric: 'measure', value: value })
-      end
-    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
+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.
+    #
+    # The `measure` method also accepts a block of code which will automatically
+    # measure the amount of time spent running that block:
+    #
+    #     measure 'foo.bar.baz' do
+    #       Foo.bar #=> 'baz'
+    #     end
+    #
+    # For convenience, when `measure` is used with a block it will return the
+    # value returned by the block.
+    #
+    # @param event [String] The name of the event
+    # @param value [Integer, String] The value measured.
+    def measure(event, value = 0)
+      if block_given?
+        time = Time.now
+        # Store the value returned by the block for future reference
+        value = yield
+        delta = Time.now - time
+
+        ActiveMetrics::Collector.record(event, { metric: 'measure', value: delta })
+
+        value
+      else
+        ActiveMetrics::Collector.record(event, { metric: 'measure', value: value })
+      end
+    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

@@ -1,3 +1,3 @@
 module ActiveMetrics
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,100 +1,100 @@
 --- !ruby/object:Gem::Specification
 name: active_metrics
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrei Maxim
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2020-05-06 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'
-  name: bundler
-  prerelease: false
   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'
-  name: rake
-  prerelease: false
+        version: '13.0'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-  name: minitest
-  prerelease: false
   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'
-  name: simplecov
-  prerelease: false
   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'
-  name: pry
-  prerelease: false
   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
-  name: activesupport
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-description:
+description: 
 email:
 - andrei@andreimaxim.ro
 executables: []
@@ -122,7 +122,7 @@ homepage: https://github.com/andreimaxim/active_metrics
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -137,9 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.14.1
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Metrics based on ActiveSupport::Notifications
 test_files: []