better_fx 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff923b091c09a0c2e4f23274f3d4189d32775e5c
-  data.tar.gz: 0c84f088ff4c5b4030a90ba2f7dce02065894ef3
+  metadata.gz: 4b9a9c55efdf7a86cd3183221c5d675024c4b9c3
+  data.tar.gz: 36a119c9ae945b44eb1f03ac44c2101ae930be9e
 SHA512:
-  metadata.gz: 2b72084b4f6cffd71bb56240378ecf9dd187a9cae630491efff48a1b4f880a16b37a3fa857eac1dbecdeea59c5723aa75f991790949799259bbf349056cf41ec
-  data.tar.gz: d2ce91f3eced03a85f5995ac35963270619f0f02cfce94dbabc14adaef5b04e490fd1ec7a9b68d78490971dd9ae8850f2cc5cb6e2ce33917ea49cf2290b33ba4
+  metadata.gz: ece668019a30ae4d48910e838212c409f303aeba53bcaf64e8867edf2e7034fa4da5f6a13693093300a9ecf86c0d6f0e5133a0f0bd6f8caa782a2000b5a033ed
+  data.tar.gz: 0cf961fa42da0e35c301ef9e800869a9e871563e347d054cc8d3ac3e480d128fe53bc9ff9dfce823b0e1a99f79b3ff216f794d9d6ac9bfcef83331701ff15efc

data/README.md

@@ -24,6 +24,47 @@ bfx = BetterFx::Client.new
 bfx.gauge :soccer_ball_air_pressure, value: 11
 ```
 
+## OO functionality
+
+Usually you'll be reporting the same measurement over and over and the gauge syntax is a bit
+ too functional
+ 
+In the following example we have an imaginary worker that is invoked like so:
+
+```ruby
+TelemetricWorker.new.run
+```
+
+It's implementation is ...
+
+```ruby
+class TelemetricWorker
+  include BetterFx::Measurement
+  attr_accessor :filename
+  
+  measurement :file_size do |worker|
+    File.size worker.filename
+  end
+  
+  def step_gets_file
+    # get file from s3
+  end
+  
+  def step_does_other_thing
+    # use your imagination
+  end
+  
+  def run
+    step_gets_file
+    measure :file_size
+    step_does_other_thing
+  end
+end
+```
+
+This way everytime `#run` is executed the file_size measurement is sent to SignalFx. Note this functionality is 
+currently available for measurements (gauges) only.
+
 ## Configuration
 
 To use BetterFx with the least amount of code, just set the environment variable

data/better_fx.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.homepage =
     "https://github.com/Referly/better_fx"
   s.add_runtime_dependency "signalfx", "~> 0.1"                         # Apache2 - @link https://github.com/signalfx/signalfx-ruby
+  s.add_runtime_dependency "activesupport", "~> 4"                      # MIT - @link https://github.com/rails/rails/blob/master/activesupport/MIT-LICENSE
   s.add_development_dependency "rspec", "~> 3.2"                        # MIT - @link https://github.com/rspec/rspec/blob/master/License.txt
   s.add_development_dependency "byebug", "~> 3.5"                       # BSD (content is BSD) https://github.com/deivid-rodriguez/byebug/blob/master/LICENSE
   s.add_development_dependency "simplecov", "~> 0.10"                   # MIT - @link https://github.com/colszowka/simplecov/blob/master/MIT-LICENSE

data/lib/better_fx/configuration.rb

@@ -3,12 +3,14 @@ module BetterFx
   class Configuration
     attr_accessor :signalfx_api_token,
                   :supported_environments,
-                  :current_environment
+                  :current_environment,
+                  :signalfx_metric_namespace
 
     def initialize
       @signalfx_api_token       = ENV["SIGNALFX_API_TOKEN"]
       @supported_environments   = [:production, :prod, "production", "prod"]
       @current_environment      = ENV["APP_ENV"] || :production
+      @signalfx_metric_namespace = ENV["SIGNALFX_METRIC_NAMESPACE"] || :better_fx
     end
   end
 end

data/lib/better_fx/measurement.rb

@@ -0,0 +1,64 @@
+require "active_support/inflector"
+module BetterFx
+  # A mixin for creating declarative telemetry to send
+  # to BetterFx (plan being to move this into BetterFx)
+  module Measurement
+    def self.included(mod)
+      mod.extend ClassMethods
+      mod.send :include, InstanceMethods
+    end
+    # Instance methods
+    module InstanceMethods
+      # Perform a measurement and send the results
+      #  to the Telemetry system
+      #
+      # @param name [String, Symbol] the name of the measurement to perform
+      def measure(name, _opts = {})
+        name = name.to_s
+        prok = self.class.measurements[name]
+        value = prok ? prok.call(self) : nil
+        return unless value
+        fq_gauge_name = self.class.gauge_name name
+        self.class.bfx.gauge fq_gauge_name, value: value
+        value
+      end
+    end
+
+    # Class methods
+    module ClassMethods
+      # Defines a measurement
+      #
+      # @param name [String, Symbol] the name of the measurement (measurement names
+      #  are inherently namespaced by class so should just use a meaningful name. It will
+      #  show up in the telemetry system as gauge.$CLASS.name)
+      # @param blk [Block] you must provide a block which contains the code for performing
+      #  the measurement; the block must return the value of the measurement
+      def measurement(name, _opts = {}, &blk)
+        name = name.to_s
+        @_measurements ||= {}
+        @_measurements[name] = blk
+      end
+
+      # Returns all of the defined measurements
+      #
+      # @return [Hash] the measurements with names as keys and procs as values
+      def measurements
+        @_measurements
+      end
+
+      # A memoized BetterFx Client instance
+      #
+      # @return [BetterFx::Client] a BetterFx client
+      def bfx
+        @_bfx ||= BetterFx::Client.new
+      end
+
+      # Generates the fully qualified gauge name
+      #
+      # @param measurement_name [String, Symbol] the name of the measurement
+      def gauge_name(measurement_name)
+        "#{BetterFx.configuration.signalfx_metric_namespace}.#{name.to_s.underscore.downcase}.#{measurement_name}".tr "/", "."
+      end
+    end
+  end
+end

data/lib/better_fx/version.rb

@@ -1,4 +1,4 @@
 module BetterFx
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
   VERSION_DATE = "2016-10-13".freeze
 end

data/lib/better_fx.rb

@@ -3,6 +3,7 @@ require "signalfx"
 SignalFxClient.send :alias_method, :bf_xmit, :send
 require_relative "better_fx/configuration"
 require_relative "better_fx/client"
+require_relative "better_fx/measurement"
 module BetterFx
   class << self
     # Allows the user to set configuration options

data/spec/better_fx/telemetry_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe BetterFx::Measurement do
+  module TestClasses
+    class Telemetric
+      include BetterFx::Measurement
+
+      def inst_method
+        "instance method found"
+      end
+    end
+    class OtherTelemetric
+      include BetterFx::Measurement
+    end
+  end
+
+  let(:k1) { TestClasses::Telemetric }
+  let(:k2) { TestClasses::OtherTelemetric }
+  let(:mock_fx) { double "BetterFxClient", gauge: true }
+  before do
+    k1.instance_variable_set :@_bfx, nil
+    k2.instance_variable_set :@_bfx, nil
+    allow(BetterFx::Client).to receive(:new).and_return mock_fx
+  end
+  describe "defining a measurement" do
+    describe ".measurement" do
+      it "defines a new measurement of the specified name" do
+        k1.measurement :foo do
+          5
+        end
+        expect(k1.new.measure(:foo)).to eq 5
+      end
+      it "isolates measurements by class" do
+        k1.measurement :foo do
+          5
+        end
+        k2.measurement :foo do
+          12
+        end
+        expect(k1.instance_variable_get(:@_measurements)["foo"]).to be_a Proc
+        expect(k1.instance_variable_get(:@_measurements)["foo"].call).to eq 5
+        expect(k2.instance_variable_get(:@_measurements)["foo"]).to be_a Proc
+        expect(k2.instance_variable_get(:@_measurements)["foo"].call).to eq 12
+      end
+    end
+  end
+
+  describe "performing a measurement" do
+    describe "#measure" do
+      let(:prok) { proc { 123 } }
+      let(:instance_of_k1) { k1.new }
+      before do
+        k1.measurement :foo, &prok
+      end
+
+      it "executes the proc associated with the measurement name" do
+        expect(prok).to receive :call
+        k1.new.measure :foo
+      end
+
+      it "sends the result of the proc to BetterFx" do
+        expect(mock_fx).to receive(:gauge).with(k1.gauge_name(:foo), hash_including(value: 123))
+        instance_of_k1.measure :foo
+      end
+
+      it "returns the result of the proc" do
+        expect(instance_of_k1.measure(:foo)).to eq prok.call
+      end
+
+      it "yields the current instance to the block" do
+        k1.measurement :bar, &:inst_method
+        expect(instance_of_k1.measure(:bar)).to eq "instance method found"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_fx
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Courtland Caldwell
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -110,8 +124,10 @@ files:
 - lib/better_fx.rb
 - lib/better_fx/client.rb
 - lib/better_fx/configuration.rb
+- lib/better_fx/measurement.rb
 - lib/better_fx/version.rb
 - spec/better_fx/client_spec.rb
+- spec/better_fx/telemetry_spec.rb
 - spec/better_fx_spec.rb
 - spec/simplecov_custom_profile.rb
 - spec/spec_helper.rb
@@ -142,6 +158,7 @@ specification_version: 4
 summary: A more idiomatic interface to SignalFx.
 test_files:
 - spec/better_fx/client_spec.rb
+- spec/better_fx/telemetry_spec.rb
 - spec/better_fx_spec.rb
 - spec/simplecov_custom_profile.rb
 - spec/spec_helper.rb