fluent-plugin-amplitude 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2df4393337ff57bd66d8282d7d27d00e18fd11f
-  data.tar.gz: 0bb12c933cdfed442fdec1c8cde1fe66e06712b6
+  metadata.gz: 5a99dfa0622abec2b9b5b7eced10c234698e62f9
+  data.tar.gz: 0b2b2e968e091881426eae51e4b812d22351bc0f
 SHA512:
-  metadata.gz: 9f3a3f198523457df7d57b82ee7eb6bb75536be0665a8c4ef9e027118878fa09459988092d78913377eaae44251e29d4b70d92cd79a665172dda71e8c57b7dec
-  data.tar.gz: 08ac45b1b9eea96014545ff9c9e9c11b05f524c7de17541125410ca3e323fcc36049df41bdf17b163a9a9641bbf89122d917cdcc466ba50a81a6d486cf8a1eea
+  metadata.gz: 2dba48d6ac9d57bfc8871c91371bb9ee789f54ff232a28d7405f6cd11275ad606df15d4a58107a4bb45518ad4f3c1fcafcbf0afcbfc818d9d14459c6607e63a1
+  data.tar.gz: b3e098e985a55091aee6e17668e2b92779456f39e96eb3a6e15039555225ab210f211655f45e6062217e49ba6dbfccd0ec68ee700215d70f3bf63e4754cadea1

data/README.md

@@ -23,6 +23,7 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-amplitude
   api_key XXXXXX
   user_id_key user_id
   device_id_key uuid
+  time_key created_at
   user_properties first_name, last_name
   event_properties current_source
   properties_blacklist user
@@ -44,6 +45,9 @@ AmplitudeOutput needs your Amplitude `api_key` ([see Amplitude for more informat
 #### user_id_key and device_id_key
 You must set at least one of `user_id_key` and `device_id_key`. They will be used to pull out the `user_id` and `device_id` values from the record to send to the Amplitude API. Note these can both be arrays, and the first matching key will be used.
 
+#### time_key
+If set, `time_key` will be used to pull out a timestamp field to set as `time` in the Amplitude API request. This can be an array, the first matching key will be used.
+
 #### user_properties and event_properties
 You can optionally specify lists of `user_properties` and `event_properties` to pull from the record.
 

data/fluent-plugin-amplitude.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'fluent-plugin-amplitude'
-  spec.version       = '0.0.9'
+  spec.version       = '0.1.0'
   spec.authors       = ['Vijay Ramesh']
   spec.email         = ['vijay@change.org']
   spec.summary       = 'Fluentd plugin to output event data to Amplitude'

data/lib/fluent/plugin/out_amplitude.rb

@@ -10,6 +10,7 @@ module Fluent
     config_param :api_key, :string, secret: true
     config_param :device_id_key, :array, default: nil
     config_param :user_id_key, :array, default: nil
+    config_param :time_key, :array, default: nil
     config_param :user_properties, :array, default: nil
     config_param :event_properties, :array, default: nil
     config_param :properties_blacklist, :array, default: nil
@@ -42,6 +43,7 @@ module Fluent
 
       filter_properties_blacklist!(record)
       extract_user_and_device!(amplitude_hash, record)
+      set_time!(amplitude_hash, record)
       extract_user_properties!(amplitude_hash, record)
       extract_event_properties!(amplitude_hash, record)
 
@@ -98,6 +100,25 @@ module Fluent
       present?(user_id) || present?(device_id)
     end
 
+    def set_time!(amplitude_hash, record)
+      return unless @time_key && !@time_key.empty?
+      @time_key.each do |time_key|
+        next unless record[time_key]
+        if (time = parse_time_from_string(record[time_key]))
+          amplitude_hash[:time] = time
+          break
+        end
+      end
+    end
+
+    def parse_time_from_string(time_string)
+      # this should be seconds since epoch; amplitude-api
+      # converts it to milliseconds since epoch as needed.
+      Time.parse(time_string).to_i
+    rescue StandardError => e
+      log.info("failed to parse #{time_string}: #{e.message}")
+    end
+
     def extract_user_properties!(amplitude_hash, record)
       # if user_properties are specified, pull them off of the record
       return unless @user_properties
@@ -132,8 +153,11 @@ module Fluent
           errors << [[res.response_code, res.body]]
         end
       end
-      return if errors.empty?
+      log_errors(errors)
+    end
 
+    def log_errors(errors)
+      return if errors.empty?
       errors_string = errors.map do |code, body|
         "Response: #{code} Body: #{body}"
       end

data/spec/out_amplitude_spec.rb

@@ -285,6 +285,51 @@ describe Fluent::AmplitudeOutput do
         }
       end
 
+      it 'produces the expected output' do
+        amplitude.expect_format [tag, now, formatted_event].to_msgpack
+        amplitude.run
+      end
+    end
+    context 'time_key specified' do
+      let(:conf) do
+        %(
+          api_key XXXXXX
+          user_id_key user_id
+          device_id_key uuid
+          time_key created_at
+          user_properties first_name, last_name
+          event_properties current_source
+        )
+      end
+      let(:event) do
+        {
+          'user_id' => 42,
+          'uuid' => 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          'first_name' => 'Bobby',
+          'last_name' => 'Weir',
+          'state' => 'CA',
+          'current_source' => 'fb_share',
+          'recruiter_id' => 710,
+          'created_at' => '2016-12-20T00:00:06Z'
+        }
+      end
+
+      let(:formatted_event) do
+        {
+          event_type: tag,
+          user_id: 42,
+          device_id: 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          time: Time.parse('2016-12-20T00:00:06Z').to_i,
+          user_properties: {
+            first_name: 'Bobby',
+            last_name: 'Weir'
+          },
+          event_properties: {
+            current_source: 'fb_share'
+          }
+        }
+      end
+
       it 'produces the expected output' do
         amplitude.expect_format [tag, now, formatted_event].to_msgpack
         amplitude.run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-amplitude
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Vijay Ramesh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd