vitals 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22251cae8ed5dfe457f58b95ab4ff44342551cb8
-  data.tar.gz: 81ba009c776476e8a2e92261e7d51b49a9ad6b27
+  metadata.gz: ca96cc1adb1b7c17cdb2acca6f7310620c514569
+  data.tar.gz: 010ec1d5084df975ab6725a7a283a83efeebee28
 SHA512:
-  metadata.gz: a6833d733be34fa74b38faa5b7eee2d49af619e1b41bd2119a4de160d5cf0f974f4144ff84298d8627fdece985f6e5400449da3043d64eb60610767a414be177
-  data.tar.gz: ecdabc5249ec20afef0bc8507f734cf255060a2dd21bc79e3922e7e5f86722ae2a3661074cb75f65332ff568a285daf72b4c3b8a1d565e46c19bf7dfc1957041
+  metadata.gz: 0c2d1718b765b1359cb49a4325c4047fb6253ce5e2525615c5447c2561ef8321fefa886d6ad25c5f95f37254f1105f19ea36ad7231fa5fb613140849b87d34e8
+  data.tar.gz: 5a3c71d712e5f8a639e5354c72eb1255f7f6884f39ccc6ef55f625daf7099e5124bbff493ecd0bfb514aabba8ed05778435471f6b14f8d9430aa6fec7eaf0ff3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vitals (0.7.0)
+    vitals (0.8.0)
       statsd-ruby (~> 1.3.0)
 
 GEM

data/README.md

@@ -140,9 +140,42 @@ Vitals.configure! do |c|
 
   # Use a different format perhaps? (default: ProductionFormat)
   # c.format = Vitals::Formats::HostLastFormat
+
+  # Use a different metric path separator, control how hierarcies are generated (default: '.')
+  # c.path_sep = '__'
 end
 ```
 
+### Metric Hierarchies
+
+If you leave the default metric path separator, it will be a dot. This means Graphite will parse
+this and generate a branch in the tree when ever it sees a new segment, so:
+
+```
+requests.api.status.registration.get.200.host-123
+```
+
+Will be created from a `GET /api/status/registration`
+
+On the other hand, if you choose a non-dot separator, like underscore, then:
+
+```
+requests.api_status_registration.get.200.host-123
+```
+
+Will be generated from a `GET /api/status/registration`.
+
+You can pick either of those and the trade-offs are:
+
+* Nested hierarchy (using a dot): fine-grained control over grouping your metrics efficiently. If you
+want to pick and choose a metric, and be able to group based on topics efficiently. You cannot group cross-segments of a path in graphite.
+
+* Flat hierarchy (using anything other than a dot, like an underscore): grouping over segments can be glob-like, so
+quick wins like "graph all errors" can be had like this: `api.*.500.*`. However, every time you want to group metrics, you will need to find
+the appropriate glob pattern, which will taxi Graphite for a huge amounts of metrics.
+
+The default separator is a dot, which makes everything hierarchical.
+
 
 
 ## Development

data/lib/vitals.rb

@@ -45,12 +45,12 @@ module Vitals
       klass.subscribe!
     end
   end
+
   #
   # reporter delegators
   #
   # hardwired for performance
-  # 
-  # TODO timing
+  # (forwardable delegators go through __send__ and generate gc waste)
   def self.inc(m)
     reporter.inc(m)
   end

data/lib/vitals/configuration.rb

@@ -12,6 +12,17 @@ module Vitals
       @host = fetch_host
       @reporter = Vitals::Reporters::InmemReporter.new
       @format = Vitals::Formats::ProductionFormat
+      self.path_sep = '.'
+    end
+
+    # delegate to utils, until this part of the utils
+    # finds a new home with a new abstraction
+    def path_sep=(val)
+      Vitals::Utils.path_sep = val
+    end
+
+    def path_sep
+      Vitals::Utils.path_sep = val
     end
 
     def build_format

data/lib/vitals/utils.rb

@@ -17,9 +17,16 @@ module Vitals
       path = route.route_path.dup[1..-1]          # /foo/bar/baz -> foo/bar/baz
       path.sub!(/\(\..*\)$/, '')                  # (.json) -> ''
       path.sub!(":version", version) if version   # :version -> v1
-      path.gsub!(/\//, ".")     # foo/bar -> foo.bar
-      path.gsub!(/\//, ".")
+      path.gsub!(/\//, self.path_sep)     # foo/bar -> foo.bar
       path
     end
+
+    def self.path_sep
+      @path_sep
+    end
+
+    def self.path_sep=(val)
+      @path_sep = val
+    end
   end
 end

data/lib/vitals/version.rb

@@ -1,3 +1,3 @@
 module Vitals
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitals
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Dotan Nahum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby