hallmonitor 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7417d6498baf7f73a8d717ed8497503ab3ffc22
-  data.tar.gz: 3e5887d9e7bf1220f1fc12e02479cff211c9cbed
+  metadata.gz: 515e56a7cec5188387c88051f7ef6be3ab963b48
+  data.tar.gz: be30442a4e44804fbf679630fd4c67893907fa89
 SHA512:
-  metadata.gz: 13952cb19e2809073797e2a2c99b2b540b0d192090442de5b406ca424075b0be32bd4cf4c257897803e636af0cb5ced054f840b64f297d716593010d3a97255c
-  data.tar.gz: a23cf1b369e6713251b0f34c2920862b0bf18697f22536a97da80bb73205a48df64da4f7960fa74916caa4a36bcb2af4563c7174e33027f4844ba3e1ec340e0d
+  metadata.gz: 58e504bc5324180efb1af75aae1d73274b43b135fab2eff72788d7f296599454cb908b1c185ccd4560b535cd45aec5daee1fbb11582102b0f3ddc87a88ce33f6
+  data.tar.gz: 5bb63718cefb76199d649f4b066d05f67d63d738682758f2dc00c3d976d1a3ec4c640f850dd7cb2fd771849da329aadc5e96f1a53a70e4b5dd9169d22cad22e4

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Version 3.0.0
+- Refactored the Transformer concept in the InfluxDB outputter so that
+  it is more flexible. This was in response to the InfluxDB client gem
+  "fixing" a bug where numerical values were previously always sent as
+  floats, now numbers are marked as "integer" type if they are ruby
+  Integers which can lead to some field-type conflicts if you update
+  your InfluxDB gem version and were previously sending integers at
+  floats.  Using the Transformer now allows you to modify the values
+  that will be sent to InfluxDB immediately before they're sent out.x

data/lib/hallmonitor/outputters/influxdb.rb

@@ -7,82 +7,70 @@ module Hallmonitor
   module Outputters
     # An outputter for InfluxDB
     class Influxdb < Outputter
+      # Simple EventData struct, used to communicate with an optional Transformer
+      EventData = Struct.new(:name, :tags, :fields)
+
       # Builds a new Influxdb outputter
       # @param influxdb_client [InfluxDB::Client] client instance to use
       # @param tags [Hash] Set of default tags applied to all events output to
       #   InfluxDB, will be overridden by tags set by events if they conflict
-      # @param transformer [#transform(String)] An object that responds
-      #   to #transform(String).  If supplied it will be passed each event name
-      #   and should return a hash with keys :name and :tags.  This is to allow
-      #   for transition from a statsd/graphite style event naming convention to
-      #   an InfluxDb style name+tags convention.  Any tags returned by the
-      #   transformer will defer to tags specified in the event itself, in
-      #   other words if the event has tags already they will take precedence
-      #   over tags built by the transformer
+      # @param transformer [#transform(Event, EventData)] An object
+      #   that responds to #transform(Event, EventData).  If supplied
+      #   it will be passed the {EventData} struct that has been built
+      #   so far and it should return an {EventData} struct that will
+      #   be written out to InfluxDB.  This allows a hook to modify data
+      #   before it is written out to InfluxDB
       # @raise if influxdb_client does not respond to :write_point
       #   (InfluxDB::Client contract)
       def initialize(influxdb_client, tags = {}, transformer = nil)
         unless influxdb_client.respond_to?(:write_point)
-          fail 'Supplied InfluxDB Client was not as expected'
+          raise 'Supplied InfluxDB Client was not as expected'
         end
 
         if transformer && !transformer.respond_to?(:transform)
-          fail 'Supplied transformer does not respond to :transform'
+          raise 'Supplied transformer does not respond to :transform'
         end
 
         super('influxdb')
         @tags = {}.merge(tags)
-        @client = influxdb_client || fail('Must supply an InfluxDb client')
+        @client = influxdb_client || raise('Must supply an InfluxDb client')
         @transformer = transformer
       end
 
       # Sends events to InfluxDB instance
-      # @param evvent []
+      # @param event [Hallmonitor::Event]
       def process(event)
-        data =
-          if event.is_a?(Hallmonitor::TimedEvent)
-            build_timer_data(event)
-          elsif event.is_a?(Hallmonitor::GaugeEvent)
-            build_gauge_data(event)
-          else
-            build_counter_data(event)
-          end
-        transform_and_write(event, data)
+        event_data = build_event_data(event)
+        transform_and_write(event, event_data)
       end
 
       private
 
-      def transform_and_write(event, data)
-        to_write = transform(event, data)
-        @client.write_point(to_write[:name], to_write[:data])
+      # @param event [Event] The original event we're working with
+      # @param data [EventData] Struct of data we're building for InfluxDB
+      def transform_and_write(event, event_data)
+        event_data = @transformer.transform(event, event_data) if @transformer
+        data = { tags: event_data.tags, values: event_data.fields }
+        @client.write_point(event_data.name, data)
       end
 
-      # If @transformer exists, use it to transform the event name
-      # and possibly build tags from it.
-      # @param event [Event] The event we're working with
-      # @param data [Hash] Hash of data we're building for InfluxDB,
-      #   Will be modified directly if the transformer is specified.
-      # @see {#build_data} for information on the structure of `data`
-      def transform(event, data)
-        if @transformer
-          t = @transformer.transform(event.name)
-          data[:tags] = (t[:tags] || {}).merge(data[:tags])
-          { name: t[:name], data: data }
+      # Builds an {EventData} from the Hallmonitor::Event
+      def build_event_data(event)
+        if event.is_a?(Hallmonitor::TimedEvent)
+          build_timer_data(event)
+        elsif event.is_a?(Hallmonitor::GaugeEvent)
+          build_gauge_data(event)
         else
-          { name: event.name, data: data }
+          build_counter_data(event)
         end
       end
 
+      # Builds an EventData struct for the event
       def build_data(event, type, value)
-        data = {
-          tags: @tags.merge(event.tags.merge(type: type))
-        }
-
-        if value.is_a?(Hash)
-          data[:values] = value
-        else
-          data[:values] = { value: value }
-        end
+        data = EventData.new
+        data.name = event.name
+        data.tags = @tags.merge(event.tags.merge(type: type))
+        data.fields = value.is_a?(Hash) ? value : { value: value }
         data
       end
 

data/lib/hallmonitor/version.rb

@@ -1,6 +1,6 @@
 module Hallmonitor
   module Version
-    MAJOR = 2
+    MAJOR = 3
     MINOR = 0
     PATCH = 0
     BUILD = nil

data/spec/hallmonitor/outputters/influxdb_spec.rb

@@ -11,7 +11,7 @@ module Hallmonitor
       context '#initialize' do
         context 'with a bad influxdb client' do
           it 'raises an error' do
-            expect { outputter }.to raise_error(String)
+            expect { outputter }.to raise_error
           end
         end
 
@@ -70,22 +70,31 @@ module Hallmonitor
           end
         end
 
-        context 'with a name transformer' do
-          let(:transformer) { double('name_transformer') }
+        context 'with a transformer' do
+          let(:transformer) { double('transformer') }
           let(:outputter) do
             described_class.new(influxdb_client, default_tags, transformer)
           end
 
+          let(:expected_data) do
+            {
+              values: { value: expected_value },
+              tags: { additional: 'foo' }
+            }
+          end
+
           it 'builds event information using the transformer' do
             expect(transformer).to(
               receive(:transform)
-              .with(event.name)
-              .and_return(
-                name: 'foo',
-                tags: { additional: 'foo' }
-              )
+                .with(event, anything)
+                .and_return(
+                  Influxdb::EventData.new(
+                    'foo',
+                    { additional: 'foo' },
+                    value: 1
+                  )
+                )
             )
-            expected_data[:tags][:additional] = 'foo'
             expect(influxdb_client).to(
               receive(:write_point).with('foo', expected_data))
             outputter.process(event)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hallmonitor
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Chris TenHarmsel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -145,6 +145,7 @@ extra_rdoc_files: []
 files:
 - ".document"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md