measurometer 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 145560329721f78f9988635eb5bbfcdeffd37ddaf3a5a14e2cf5891f76b94544
-  data.tar.gz: a59156c128ce042aeb54ef08c94c8786aeed80456a2c38ea2a892861d0cd1642
+  metadata.gz: 29dcab627b5e7f4c4ed909b8d9fa740cdcb3c1ab038a8b288d3ac48fc49fe189
+  data.tar.gz: 03d734f978f1e76fa6e87af71b5859d258b51eebc579046abe3f2b4200a27cb1
 SHA512:
-  metadata.gz: 667108345d55245fed14812c07608f2fde96d6455e92d14be8dd2e56a9a298c82464703a46e42e349a670277197adc6b105239e5c89711161bc6f9cabf0efff4
-  data.tar.gz: c24c904cee40f2be10bbadba2aafe3c91b1e973782597678ad9e87cd7920a66a77b897c11739c961edf7c7ef10f990dc2d7ccb15adee68305c372ef0bbf5b10b
+  metadata.gz: d3b707c8511e4708fe75fc84d19335e59816ae896334b15781b0075b970515090d661bc44949d5c4fc11595c5e8aff1818c3b92622748721c9616439c275a2a6
+  data.tar.gz: 469e275e66e13485347d75dd9a855552b8c29ec4306bb187093ed0126a4999bddd3715ffbe12e8d4fa1f45b00c4633b9d7ed0d4bbdc1d93476bfbd9c06abcaff

data/CHANGELOG.md

@@ -1,7 +1,24 @@
+# 1.3.0
+
+* Adds support to set a tag on Appsignal in `add_distribution_value` as well (in addition to gauges and counters)
+
 # 1.2.0
 
 * Adds support to set a tag on Appsignal in methods `increment_counter` and `set_gauge`
 
+**Warning**: this version introduced a breaking change. It will be necessary to
+add the new 3rd argument to the methods `#increment_counter` and `#set_gauge` if you
+have a custom driver defined in your application, for example:
+
+```diff
+-class CustomDriver
+-  def increment_counter(counter_name, by)
+-  def set_gauge(gauge_name, value)
++class CustomDriver
++  def increment_counter(counter_name, by, _tags={})
++  def set_gauge(gauge_name, value, _tags={})
+```
+
 # 1.1.1
 
 * Automatically convert metric and instrumentation block names to Strings, since i.e.

data/lib/measurometer.rb

@@ -60,9 +60,10 @@ module Measurometer
     #
     # @param value_path[String] under which path to push the metric
     # @param value[Numeric] distribution value
+    # @param tags[Hash] tags for the sample
     # @return nil
-    def add_distribution_value(value_path, value)
-      @drivers.each { |d| d.add_distribution_value(value_path.to_s, value) }
+    def add_distribution_value(value_path, value, tags = {})
+      @drivers.each { |d| d.add_distribution_value(value_path.to_s, value, tags) }
       nil
     end
 
@@ -71,7 +72,7 @@ module Measurometer
     # @param counter_path[String] under which path to push the metric
     # @param by[Integer] the counter increment to apply
     # @return nil
-    def increment_counter(counter_path, by = 1, tags={})
+    def increment_counter(counter_path, by = 1, tags = {})
       @drivers.each { |d| d.increment_counter(counter_path.to_s, by, tags) }
       nil
     end
@@ -81,7 +82,7 @@ module Measurometer
     # @param gauge_name[String] under which path to push the metric
     # @param value[Integer] the absolute value of the gauge
     # @return nil
-    def set_gauge(gauge_name, value, tags={})
+    def set_gauge(gauge_name, value, tags = {})
       @drivers.each { |d| d.set_gauge(gauge_name.to_s, value, tags) }
       nil
     end

data/lib/measurometer/statsd_driver.rb

@@ -17,15 +17,15 @@ module Measurometer
       end
     end
 
-    def increment_counter(counter_name, by, _tags={})
+    def increment_counter(counter_name, by, _tags = {})
       @statsd_client.increment(counter_name, by)
     end
 
-    def add_distribution_value(key_path, value)
+    def add_distribution_value(key_path, value,  _tags = {})
       @statsd_client.count(key_path, value)
     end
 
-    def set_gauge(gauge_name, value, _tags={})
+    def set_gauge(gauge_name, value, _tags = {})
       @statsd_client.gauge(gauge_name, value)
     end
 

data/lib/measurometer/version.rb

@@ -1,3 +1,3 @@
 module Measurometer
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/measurometer.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Measurometer::VERSION
   spec.authors       = ['Julik Tarkhanov']
   spec.email         = ['me@julik.nl']
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.summary       = 'Minimum viable API for instrumentation in libraries'
   spec.description   = 'Minimum viable API for instrumentation in libraries. Source metrics from your libraries to Measurometer, pick them up on the other end in the application, centrally.'

data/spec/measurometer_spec.rb

@@ -39,12 +39,21 @@ RSpec.describe Measurometer do
   describe '.add_distribution_value' do
     it 'converts the metric name to a String before passing it to the driver' do
       driver = double
-      expect(driver).to receive(:add_distribution_value).with('bar_intensity', 114.4)
+      expect(driver).to receive(:add_distribution_value).with('bar_intensity', 114.4, {})
 
       Measurometer.drivers << driver
       result = Measurometer.add_distribution_value(:bar_intensity, 114.4)
       expect(result).to be_nil
     end
+
+    it 'accepts tags and passes them through' do
+      driver = double
+      expect(driver).to receive(:add_distribution_value).with('bar_intensity', 114.4, host: 'server1')
+
+      Measurometer.drivers << driver
+      result = Measurometer.add_distribution_value(:bar_intensity, 114.4, host: 'server1')
+      expect(result).to be_nil
+    end
   end
 
   describe '.increment_counter' do
@@ -142,17 +151,17 @@ RSpec.describe Measurometer do
         end
       end
 
-      def add_distribution_value(value_path, value)
+      def add_distribution_value(value_path, value, _tags = {})
         @distributions ||= []
         @distributions << [value_path, value]
       end
 
-      def increment_counter(value_path, value, tags={})
+      def increment_counter(value_path, value, _tags = {})
         @counters ||= []
         @counters << [value_path, value]
       end
 
-      def set_gauge(value_path, value, tags={})
+      def set_gauge(value_path, value, _tags = {})
         @gauges ||= []
         @gauges << [value_path, value]
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: measurometer
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-22 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler