better_fx 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55b10acd6ff246c5c3079d2a7b758489b39bd724
-  data.tar.gz: e047c129bde742ccbb1912e3caac85ac5f9dbad1
+  metadata.gz: ff923b091c09a0c2e4f23274f3d4189d32775e5c
+  data.tar.gz: 0c84f088ff4c5b4030a90ba2f7dce02065894ef3
 SHA512:
-  metadata.gz: 8de14bee27628714f05d675d0686df71a9d7cfca13cee16ea0258bc9f61af0c4a3dd3252ff8fa747eebcf5d3fd517a3bcb8ce9134d79360440a039621ccd557f
-  data.tar.gz: d234b348ef4051e3c373f63f4a3ea25cd32fe4a8598bead1cb0f8fdbd5c4233349b49f3f43e85fca7139013e05b5ea7e95a041e0db01e8a1a5ba94347eb5add8
+  metadata.gz: 2b72084b4f6cffd71bb56240378ecf9dd187a9cae630491efff48a1b4f880a16b37a3fa857eac1dbecdeea59c5723aa75f991790949799259bbf349056cf41ec
+  data.tar.gz: d2ce91f3eced03a85f5995ac35963270619f0f02cfce94dbabc14adaef5b04e490fd1ec7a9b68d78490971dd9ae8850f2cc5cb6e2ce33917ea49cf2290b33ba4

data/README.md

@@ -13,6 +13,17 @@ bfx = BetterFx::Client.new
 bfx.increment_counter :beans
 ```
 
+Or you might want to report the value of a measurement you've taken
+
+```ruby
+require "better_fx"
+bfx = BetterFx::Client.new
+# This will send the value 11 to the SignalFx gauge metric named
+#  "soccer_ball_air_pressure" with the current unix timestamp and vanilla
+#  metadata dimensions
+bfx.gauge :soccer_ball_air_pressure, value: 11
+```
+
 ## Configuration
 
 To use BetterFx with the least amount of code, just set the environment variable

data/better_fx.gemspec

@@ -1,8 +1,12 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "better_fx/version"
+
 Gem::Specification.new do |s|
   s.name        = "better_fx"
-  s.version     = "0.1.1"
+  s.version     = BetterFx::VERSION
+  s.date        = BetterFx::VERSION_DATE
   s.license     = "MIT"
-  s.date        = "2016-05-17"
   s.summary     = "A more idiomatic interface to SignalFx."
   s.description = "A convenient gem for developers to interact with SignalFx with a trivial amount of effort"
   s.authors     = ["Courtland Caldwell"]

data/lib/better_fx/client.rb

@@ -15,7 +15,7 @@ module BetterFx
     # @params dimensions [Array<Hash>] the metadata dimensions to be associated with the counter
     def increment_counter(counter_name, value: 1, timestamp: nil, dimensions: [])
       return unless configuration.supported_environments.include? configuration.current_environment
-      timestamp ||= 1000 * Time.now.to_i
+      timestamp ||= default_timestamp
       dimensions << { env: configuration.current_environment } if dimensions.empty?
       signalfx_client.bf_xmit(counters: [
                                 metric:     counter_name.to_s,
@@ -25,8 +25,31 @@ module BetterFx
                               ])
     end
 
+    # Send a gauge measurement to SignalFx (if the current environment supports using SignalFx)
+    #
+    # @params gauge_name [Symbol, String] the name of the gauge to send a measurement of
+    # @params value [Fixnum] the measured value
+    # @params timestamp [Fixnum, String] the timestamp, in milliseconds since the unix epoch (defaults to the timestamp
+    #  on the host running your code)
+    # @params dimensions [Array<Hash>] the metadata dimensions to be associated with the gauge measurement
+    def gauge(gauge_name, value: nil, timestamp: nil, dimensions: [])
+      return unless configuration.supported_environments.include? configuration.current_environment
+      timestamp ||= default_timestamp
+      dimensions << { env: configuration.current_environment } if dimensions.empty?
+      signalfx_client.bf_xmit(gauges: [
+                                metric:     gauge_name.to_s,
+                                value:      value,
+                                timestamp:  timestamp.to_s,
+                                dimensions: dimensions,
+                              ])
+    end
+
     private
 
+    def default_timestamp
+      1000 * Time.now.to_i
+    end
+
     def signalfx_client
       SignalFx.new configuration.signalfx_api_token
     end

data/lib/better_fx/version.rb

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

data/spec/better_fx/client_spec.rb

@@ -3,16 +3,64 @@ require "spec_helper"
 describe BetterFx::Client do
   subject { described_class.new }
 
-  describe "#increment_counter" do
-    let(:value) { 1 }
-    let(:timestamp) { 12_345 }
-    let(:dimensions) { [{ env: BetterFx.configuration.current_environment }] }
-    let(:mock_fx_client) { FxMocks::MockFxClient.new }
+  let(:value) { 1 }
+  let(:timestamp) { 12_345 }
+  let(:dimensions) { [{ env: BetterFx.configuration.current_environment }] }
+  let(:mock_fx_client) { FxMocks::MockFxClient.new }
+
+  before do
+    allow(SignalFx).to receive(:new).and_return mock_fx_client
+  end
 
-    before do
-      allow(SignalFx).to receive(:new).and_return mock_fx_client
+  describe "#gauge" do
+    it "sends the value to SignalFx for the specified gauge" do
+      expect(mock_fx_client).
+        to receive(:bf_xmit).
+        with(gauges: [
+               hash_including(
+                 metric: "sample_gauge",
+                 value:  value
+               ),
+             ])
+      subject.gauge :sample_gauge, value: value
     end
 
+    describe "specifying the timestamp" do
+      let(:timestamp) { 1111 }
+      it "sends the user specified timestamp as a string" do
+        expect(mock_fx_client).
+          to receive(:bf_xmit).
+          with(gauges: [
+                 hash_including(
+                   metric:    "sample_gauge",
+                   value:     value,
+                   timestamp: timestamp.to_s
+                 ),
+               ])
+
+        subject.gauge :sample_gauge, value: value, timestamp: timestamp
+      end
+    end
+
+    describe "specifying dimensional metadata" do
+      let(:dimensions) { [{ size: "Large" }] }
+      it "sends the user specified dimensional metadata" do
+        expect(mock_fx_client).
+          to receive(:bf_xmit).
+          with(gauges: [
+                 hash_including(
+                   metric:     "sample_gauge",
+                   value:      value,
+                   dimensions: dimensions
+                 ),
+               ])
+
+        subject.gauge :sample_gauge, value: value, dimensions: dimensions
+      end
+    end
+  end
+
+  describe "#increment_counter" do
     it "sends the default incremental value to SignalFx for the specified counter" do
       expect(mock_fx_client).
         to receive(:bf_xmit).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_fx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Courtland Caldwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: signalfx
@@ -110,6 +110,7 @@ files:
 - lib/better_fx.rb
 - lib/better_fx/client.rb
 - lib/better_fx/configuration.rb
+- lib/better_fx/version.rb
 - spec/better_fx/client_spec.rb
 - spec/better_fx_spec.rb
 - spec/simplecov_custom_profile.rb