rt-watchman 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2518ea25e48bd1335da7036b1f356abe99707b95
-  data.tar.gz: 8761422a4906f54a9a90a1cb0555d60173036e0f
+  metadata.gz: 0ea317e3767bb88fc1f9ad45dd8f0e59d390e878
+  data.tar.gz: 38d7f082ccc4f9232e22a3be8491ad994df0d31c
 SHA512:
-  metadata.gz: 910ff071eebce01b84107f71db699907b4a4eb29f680a2f5749143b2320cf8ecd12d6aefde11f00b93be8445839240772e336e26c76529a50120d2a2d93fac3f
-  data.tar.gz: 26f3715758b471d21d25678a49bd9d9d2a680321abcaf2c02b73995876e8c3fbe2314fc8449b0c120675bcfb21a5da19d0cc3e0a3bc1194611435503e55fbc28
+  metadata.gz: 729390c5b43c85c590e32c52cb73690f891c2a1d80286d1c33faaa5dbf90cc1433607265394342aeb45d7ce24b0afc6fd8c1b9457a26e8086f8e36695f417fc9
+  data.tar.gz: 3485485924f7705cdd29156f2279a78b0410b1d04670d9c037c3b590c74fa18c41adfff4d1ef85db4b27c8a596f1a0a5506ddaec8cddc17df8e2a0a0a9adf25d

data/README.md

@@ -17,7 +17,18 @@ Watchman.host = "localhost"
 Watchman.port = 22345
 ```
 
-To submit a simple value from your service:
+To submit a value to statsd from your service use:
+
+``` ruby
+Watchman.submit(name, value, type)
+```
+
+Available types:
+* :gauge `default`
+* :timing
+* :count
+
+Submitting a simple gauge value from your service would look like:
 
 ``` ruby
 Watchman.submit("number.of.kittens", 30)
@@ -33,12 +44,52 @@ Watchman.benchmark("time.to.wake.up") do
 end
 ```
 
-To submit a time value in miliseconds:
+To submit a time value in milliseconds use:
 
 ``` ruby
 Watchman.submit("number.of.kittens", 30, :timing)
 ```
 
+To submit a count value use:
+
+``` ruby
+# To increse:
+Watchman.increment("number.of.kittens")
+
+# or decrese:
+Watchman.decrement("number.of.kittens")
+```
+
+Alternatively you can use:
+
+``` ruby
+# To increse:
+Watchman.submit("number.of.kittens", 1, :count)
+
+# or decrese:
+Watchman.submit("number.of.kittens", -1, :count)
+```
+
+to achieve the equivalent effect, with the added possibility of tweaking the
+value.
+
+## Tags
+
+If you want to use a variable that changes often, don't use this:
+
+``` ruby
+Watchman.submit("user.#{id}", 30)
+```
+
+Use tags. A list of tags is an optional last parameter of `:submit`, `:benchmark`,
+`:increment` and `:decrement` methods.
+
+``` ruby
+Watchman.submit("user", 30, tags: [id])
+```
+
+Tags list is limited to 3 values.
+
 ## Global metric prefix
 
 If you want to prepend all the metric names with a prefix, do the following:

data/lib/watchman.rb

@@ -1,4 +1,5 @@
 require "watchman/version"
+require "watchman/metric_name"
 require "watchman/mock_statsd"
 require "benchmark"
 require "statsd"
@@ -12,35 +13,39 @@ class Watchman
     attr_accessor :port
     attr_accessor :test_mode
 
-    def submit(name, value, type = :gauge)
-      metric = metric_name_with_prefix(name)
-
-      case type
-      when :gauge  then statsd_client.gauge(metric, value)
-      when :timing then statsd_client.timing(metric, value)
-      when :count  then statsd_client.count(metric, value)
-      else raise SubmitTypeError.new("Submit type '#{type}' is not recognized")
-      end
-    end
-
-    def benchmark(name)
+    def benchmark(name, options = {})
       result = nil
 
       time = Benchmark.measure do
         result = yield
       end
 
-      submit(name, (time.real * 1000).floor, :timing)
+      timing(name, (time.real * 1000).floor, options)
 
       result
     end
 
-    def increment(name)
-      submit(name, 1, :count)
+    def timing(name, value, options = {})
+      submit(name, value, :timing, options)
+    end
+
+    def increment(name, options = {})
+      submit(name, 1, :count, options)
+    end
+
+    def decrement(name, options = {})
+      submit(name, -1, :count, options)
     end
 
-    def decrement(name)
-      submit(name, -1, :count)
+    def submit(name, value, type = :gauge, options = {})
+      metric = Watchman::MetricName.construct(name, prefix, options[:tags])
+
+      case type
+      when :gauge  then statsd_client.gauge(metric, value)
+      when :timing then statsd_client.timing(metric, value)
+      when :count  then statsd_client.count(metric, value)
+      else raise SubmitTypeError.new("Submit type '#{type}' is not recognized")
+      end
     end
 
     private
@@ -52,13 +57,5 @@ class Watchman
         @client ||= Statsd.new(@host, @port)
       end
     end
-
-    def metric_name_with_prefix(name)
-      if @prefix
-        "#{@prefix}.#{name}"
-      else
-        name
-      end
-    end
   end
 end

data/lib/watchman/metric_name.rb

@@ -0,0 +1,36 @@
+class Watchman
+  class MetricName
+    def self.construct(base_name, prefix, tags)
+      new(base_name, prefix, tags).construct
+    end
+
+    def initialize(base_name, prefix = nil, tags)
+      @base_name = base_name
+      @prefix = prefix
+      @tags = tags || []
+    end
+
+    def construct
+      full_name = []
+
+      full_name << "tagged"      if tagged?
+      full_name << @prefix       if @prefix
+      full_name << formated_tags if tagged?
+      full_name << @base_name
+
+      full_name.join(".")
+    end
+
+    def formated_tags
+      @tags
+        .map(&:to_s)
+        .fill("no_tag", @tags.length, [3 - @tags.length, 0].max)
+        .first(3)
+        .join(".")
+    end
+
+    def tagged?
+      @tags.size > 0
+    end
+  end
+end

data/lib/watchman/version.rb

@@ -1,3 +1,3 @@
 class Watchman
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rt-watchman
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Rendered Text
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -83,6 +83,7 @@ files:
 - bin/console
 - bin/setup
 - lib/watchman.rb
+- lib/watchman/metric_name.rb
 - lib/watchman/mock_statsd.rb
 - lib/watchman/version.rb
 - watchman.gemspec