nsa 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1a996fa5af6727cff0da62c3bea2c03121e0e39
-  data.tar.gz: b60c21f202615307e3c5c2d0bda20db393fcd79d
+  metadata.gz: 86ff263225b7d77e1d87aa520fb425173097effd
+  data.tar.gz: 723e3953685a9dc67a6c09dbda7e137e5f52a2cc
 SHA512:
-  metadata.gz: 22112240d62da1536e1dc24e3f9c904d0c65ab6d8152376a2a124f9f21a6243b7961ed935577f92f3b02c2da460b4001ed51c9ac09aa180420b9dc56ac839e6f
-  data.tar.gz: 51a0f98d21e227da7ee8a65df55e272b828e906066d99959c7a78bccf66d540ac59ffd8ca7069f9e850f9d1b3fedbeb742c7e3230c2fbc7dd3a6f7dac7c8e55d
+  metadata.gz: 41a998fa86f209cc2803eee4f233e7c94ff39e465cf920f37c09cb76245091fa04d15b6023f592e64a9a4abc7c30de322c06dbc603753473a30f1d41ba4f7330
+  data.tar.gz: 99da7edeabcc395718a7470c24003ed7dd79fef900f138b6ae88b9938b0aa49b8e30ba06be83e9fe46db8a3f5c4b2147eff6fc8d6d2fd9c5cedf341e776f4812

data/README.md

@@ -109,8 +109,10 @@ Metrics recorded:
 Writing your own collector is very simple. To take advantage of the keyspace handling you must:
 
 1. Create an object/module which responds to `collect`, taking the `key_prefix` as its only argument.
-2. Include or extend your class/module with `NSA::Statsd::Publisher`.
-3. Call any of the `statsd_*` prefixed methods provided by the `Publisher`:
+2. Include or extend your class/module with `NSA::Statsd::Publisher` or `NSA::Statsd::Publisher`.
+3. Call any of the `statsd_*` prefixed methods provided by the included Publisher:
+
+__`Publisher` methods:__
 
 + `statsd_count(key, value = 1, sample_rate = nil)`
 + `statsd_decrement(key, sample_rate = nil)`
@@ -120,10 +122,23 @@ Writing your own collector is very simple. To take advantage of the keyspace han
 + `statsd_time(key, sample_rate = nil, &block)`
 + `statsd_timing(key, value = 1, sample_rate = nil)`
 
+__`AsyncPublisher` methods:__
+
++ `async_statsd_count(key, sample_rate = nil, &block)`
++ `async_statsd_gauge(key, sample_rate = nil, &block)`
++ `async_statsd_set(key, sample_rate = nil, &block)`
++ `async_statsd_time(key, sample_rate = nil, &block)`
++ `async_statsd_timing(key, sample_rate = nil, &block)`
+
+___Note:___ When using the `AsyncPublisher`, the value is derived from the block. This is useful
+when the value is not near at hand and has a relatively high cost to compute (e.g. db query)
+and you don't want your current thread to wait.
+
 For example, first define your collector. Our (very naive) example will write
 a gauge metric every 10 seconds of the User count in the db.
 
 ```ruby
+# Publishing User.count gauge using a collector
 module UsersCollector
   extend ::NSA::Statsd::Publisher
 
@@ -148,6 +163,30 @@ NSA.inform_statsd($statsd) do |informant|
 end
 ```
 
+You could also implement the provided example not as a Collector, but using
+`AsyncPublisher` directly in your ActiveRecord model:
+
+```ruby
+# Publishing User.count gauge using AsyncPublisher methods
+class User <  ActiveRecord::Base
+  include NSA::Statsd::AsyncPublisher
+
+  after_commit :write_count_gauge, :on => [ :create, :destroy ]
+
+  # ...
+
+  private
+
+  def write_count_gauge
+    async_statsd_gauge("models.User.all.count") { ::User.count }
+  end
+
+end
+```
+
+Using this technique, publishing the `User.count` stat gauge will not hold up
+the thread responsible for creating the record (and processing more callbacks).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/nsa/statsd/async_publisher.rb

@@ -5,33 +5,43 @@ module NSA
     module AsyncPublisher
       include ::NSA::Statsd::Publisher
 
-      def async_statsd_count(key, sample_rate = nil, &block)
+      def async_statsd_count(key, sample_rate = 1, &block)
+        return unless sample_rate == 1 || rand < sample_rate
+
         ::Concurrent::Promise.execute(&block).then do |value|
-          statsd_count(key, value, sample_rate)
+          statsd_count(key, value)
         end
       end
 
-      def async_statsd_gauge(key, sample_rate = nil, &block)
+      def async_statsd_gauge(key, sample_rate = 1, &block)
+        return unless sample_rate == 1 || rand < sample_rate
+
         ::Concurrent::Promise.execute(&block).then do |value|
-          statsd_gauge(key, value, sample_rate)
+          statsd_gauge(key, value)
         end
       end
 
-      def async_statsd_set(key, sample_rate = nil, &block)
+      def async_statsd_set(key, sample_rate = 1, &block)
+        return unless sample_rate == 1 || rand < sample_rate
+
         ::Concurrent::Promise.execute(&block).then do |value|
-          statsd_set(key, value, sample_rate)
+          statsd_set(key, value)
         end
       end
 
-      def async_statsd_time(key, sample_rate = nil, &block)
+      def async_statsd_time(key, sample_rate = 1, &block)
+        return unless sample_rate == 1 || rand < sample_rate
+
         ::Concurrent::Future.execute do
-          statsd_time(key, sample_rate, &block)
+          statsd_time(key, &block)
         end
       end
 
-      def async_statsd_timing(key, sample_rate = nil, &block)
+      def async_statsd_timing(key, sample_rate = 1, &block)
+        return unless sample_rate == 1 || rand < sample_rate
+
         ::Concurrent::Promise.execute(&block).then do |value|
-          statsd_timing(key, value, sample_rate)
+          statsd_timing(key, value)
         end
       end
 

data/lib/nsa/version.rb

@@ -1,3 +1,3 @@
 module NSA
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nsa
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - BJ Neilsen