mettric 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41c233719f5671881896f6de5b3eb238cc0a5b0b
-  data.tar.gz: 47db5d7f82128a21c00e2d3db2dcfbac75edb42f
+  metadata.gz: a54c6667cd180fa2a4f52f5159f9973f56b50c43
+  data.tar.gz: 1dee7f23fb2987d2bd4e74081816deaff2f1f2f3
 SHA512:
-  metadata.gz: de15a514621130bfe913d651637caefb698338021b3515569df7620f0f96320ebe60cda9da5d85c77418a48f273778e0697bc61d79c42096f8783cd5a16b4859
-  data.tar.gz: b91d7c2f89420d45ad30754c5ca2a0d96b4ef453c79cd1de49b0ac1e542f90d2b1c0f08d1e5784df03d32a08f27592e11a8af071abc0c8d655a05a92a1c60275
+  metadata.gz: d860f9b44f28156054d3969f7ad388b903579a98580d3d3aea9db081d36afa6aa447d87308d23174ee96fd03cbc394d8280ca4557fa3844cd71cc9e0f9b477bf
+  data.tar.gz: 6ca35061b4b86a7c68f0fd5b1838a153e5f18aed7d3a12e7e0ed79f01000af8550e348c92ef0a8e0679e96b7dd8a96177e5010f78abd158fc4a758fe1240bd26

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Jannis Hermanns
+Copyright (c) 2016 Moviepilot, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,39 +1,133 @@
 # Mettric
 
-Track to riemann.
+Tracks events, meter readings and timings to [riemann.io](http://riemann.io) in a background thread using [riemann-ruby-client](https://github.com/riemann/riemann-ruby-client). Fire and forget.
 
-## Configuration
+Mettric will also prepend your app's name to the services you track with riemann and set the reporting host and tags automatically.
+
+
+## Getting started
+
+```ruby
+gem install mettric
+```
+
+
+### Configuration
+
+You can configure Mettric like this:
 
 ```ruby
 Mettric.config = {
   host: 'my-riemann-server',
   port: 5555,
 
-  reporting_host: 'override' # Defaults to system hostname
-  app: 'my_app'              # Defaults to rails app (if in rails)
-  poll_intervall: 100        # Defaults to 50ms
+  reporting_host: 'override', # Defaults to system hostname
+  app: 'my_app',              # Defaults to rails app (if in rails)
+  poll_intervall: 100,        # Defaults to 50 (ms)
+  sidekiq_middleware: false   # Defaults to true
 }
 ```
 
-## Track events
+Upon configuration, Mettric will install a [sidekiq](http://sidekiq.org/) middleware that automatically tracks the success and error rates of your workers as well as their duration (see below for details)
+
+
+### Track events
 
 ```ruby
 # Tracks payload with metric=1 and tags it 'event'
-🛎 service: 'User created'
+🛎 service: 'users.created'
+
+# Will send the following payload via riemann-ruby-client:
+#
+# {
+#    host: 'override',
+#    service: 'my_app.users.created',
+#    metric: 1,
+#    tags: ['event']
+# }
 ```
 
-## Track meter readings
+### Track meter readings
 
 ```ruby
 🌡 service: 'Rails req/s', metric: 400, state: 'normal'
+
+# Will send the following payload via riemann-ruby-client:
+#
+# {
+#    host: 'override',
+#    service: 'my_app.Rails req/s',
+#    metric: 400,
+#    state: 'normal'
+# }
 ```
 
-## Time things
+### Time things
 
 ```ruby
-# This will track the duration in milliseconds as the `metric` value
-# as "Sleep duration ms" (note the added ' ms') and tag it 'timing'
-⏱ (service: 'Sleep duration') do
+⏱ (service: 'test.slept', tags: [:tired]) do
   sleep 1
 end
+
+# Will send the following payload via riemann-ruby-client:
+#
+# {
+#    host: 'override',
+#    service: 'my_app.test.slept',
+#    metric: 1000,
+#    description: '(ms)',
+#    tags: ['timing', 'tired']
+# }
 ```
+
+### For grown ups
+
+Just in case you don't want to use the silly methods names, please know that the emoji variants of above methods just call `Mettric.event(payload)`, `Mettric.meter(payload` and `Mettric.time(paylod) { ... }` respectively. Be aware, though, that the emoji methods ignore a misconfigured or unavailable riemann server by rescuing `Mettric::CouldNotStartWorkerThread` exceptions. The non-emoji methods will throw that exception. Just have a look at [lib/mettric/scnr.rb](lib/mettric/scnr.rb) and you'll see what I mean.
+
+
+## Sidekiq
+
+Let's assume you have sidekiq worker class called `MyWorker` that uses the `my_queue` queue. Each time it runs, Mettric will automatically track how long the worker took by sending the following payload to Riemann (assuming the worker took 80ms):
+
+```ruby
+{
+  host: 'override',
+  service: 'my_app.sidekiq.my_queue.my_worker.duration',
+  metric: 80,
+  tags: ['sidekiq']
+}
+```
+
+Also, it will track the success
+
+```ruby
+{
+  host: 'override',
+  service: 'my_app.sidekiq.my_queue.my_worker.success',
+  metric: 1,
+  tags: ['event']
+}
+```
+
+or error
+
+```ruby
+{
+  host: 'override',
+  service: 'my_app.sidekiq.my_queue.my_worker.error',
+  metric: 1,
+  tags: ['event']
+}
+```
+
+of the worker's execution. If you want a worker not to be tracked by mettric, you would write:
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+  sidekiq_options mettric: false
+
+  def perform
+    …
+  end
+end

data/lib/mettric/mettric.rb

@@ -7,9 +7,20 @@ class Mettric
   end
 
   def self.config=(config)
+    # See if the config is valid
     config_test = Client.new(config)
     config_test.close
+
+    # Set the config
     @config = config
+
+    # Attempt to install sidekiq middleware unless
+    # we're told not to
+    if config.delete(:sidekiq_middleware) != false
+      Mettric::SidekiqMiddleware.install
+    end
+
+    @config
   end
 
   def self.track(payload)

data/lib/mettric/scnr.rb

@@ -6,7 +6,7 @@ rescue Mettric::CouldNotStartWorkerThread
   puts "***WARNING***  Mettric::CouldNotStartWorkerThread raised"
 end
 
-# A meter
+# A meter reading
 def 🌡 (payload)
   Mettric.meter(payload)
 rescue Mettric::CouldNotStartWorkerThread

data/lib/mettric/sidekiq_middleware.rb

@@ -1,42 +1,42 @@
 require 'active_support/inflector'
 
 class Mettric::SidekiqMiddleware
+
+  def self.install
+    return if @installed
+    return unless Kernel.const_defined?(:Sidekiq)
+    @installed = true
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add Mettric::SidekiqMiddleware
+      end
+    end
+  end
+
   def initialize(_options = {})
   end
 
   def call(worker, msg, queue)
-    begin
-      opts = worker.class.sidekiq_options['mettric']
+    opts = worker.class.sidekiq_options['mettric']
 
-      # Don't do anything if we're told to skip this class
-      if opts != true and opts != nil
-        return yield
-      end
+    # Don't do anything if we're told to skip this class
+    if opts != true and opts != nil
+      return yield
+    end
 
-      # Tracking under this name
-      service = "sidekiq.queue:#{queue.to_s.underscore}.worker:#{worker.class.name.underscore}"
+    # Tracking under this name
+    service = "sidekiq.#{queue.to_s.underscore}.#{worker.class.name.underscore}"
 
-      # Yield & time
-      Mettric.time(service: "#{service}.duration", tags: ['sidekiq']) do
-        yield
-      end
-    rescue
-      Mettric.event(service: "#{service}.error", tags: ['sidekiq'])
-      raise
+    # Yield & time
+    Mettric.time(service: "#{service}.duration", tags: ['sidekiq']) do
+      yield
     end
 
     # Track success
     Mettric.event(service: "#{service}.success", tags: ['sidekiq'])
-  end
-rescue => e
-  raise unless e.is_a?(Mettric::Error)
-end
-
-if Kernel.const_defined?(:Sidekiq)
-  Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.add Mettric::SidekiqMiddleware
-    end
+  rescue => e
+    Mettric.event(service: "#{service}.failure", tags: ['sidekiq', 'error'], description: e.to_s)
+    raise unless e.is_a?(Mettric::Error)
   end
 end
 

data/lib/mettric/version.rb

@@ -1,3 +1,3 @@
 class Mettric
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mettric
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Jannis Hermanns
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport