fluent-plugin-amplitude 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 757d43474f5a6517ea2efdd15f43655fd6ca3edd
+  data.tar.gz: 7be8f650adad1bd3565391b92cf970fcc0db223f
+SHA512:
+  metadata.gz: 1c307bc96c613dca51aed3360b2bde8871e16685dd84bb3c00db8e00960dadadc9bb89075a9f729188ecafc9325fa41a23c031cd769b0ac018489f753044860d
+  data.tar.gz: e6f941184f8d4deb9d57d7cf9674fac275d6ff99815e4993ed1776ce265a2c79346b80009e2a6a0fc086db4fd9d448559c80f40edd8d752c842fac49792d44e0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vijay Ramesh <vijay@change.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# fluent-plugin-amplitude
+Output plugin for [Fluentd](http://fluentd.org) to [Amplitude](https://amplitude.com/)
+
+This plugin uses the [amplitude-api](https://github.com/toothrot/amplitude-api) gem, which itself talks to Amplitude's [HTTP API](https://amplitude.zendesk.com/hc/en-us/articles/204771828-HTTP-API).
+
+## Installation
+Install with gem or fluent-gem command as:
+
+```bash
+# for fluentd
+$ gem install fluent-plugin-amplitude
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-amplitude
+```
+
+## Configuration
+
+#### Example configuration
+```xml
+<match output.amplitude.*>
+  @type amplitude
+  api_key XXXXXX
+  user_id_key user_id
+  device_id_key uuid
+  user_properties first_name, last_name
+  event_properties current_source
+  properties_blacklist user
+  events_whitelist petition_view, petition_share
+  flush_interval 5s
+  retry_limit 2
+  remove_tag_prefix output.amplitude.
+  <secondary>
+    @type file
+    path /var/log/fluent/forward-failed
+  </secondary>
+</match>
+```
+
+#### api_key
+AmplitudeOutput needs your Amplitude `api_key` ([see Amplitude for more information](https://amplitude.zendesk.com/hc/en-us/articles/206728448-Where-can-I-find-my-app-s-API-Key-or-Secret-Key-))
+
+#### 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.
+
+#### user_properties and event_properties
+You can optionally specify lists of `user_properties` and `event_properties` to pull from the record.
+
+If `user_properties` are specified, only those properties will be included as `user_properties` in the Amplitude API call.  Otherwise no `user_properties` will be sent.
+
+If `event_properties` are specified, only those properties will be included as `event_properties` in the Amplitude API call. Otherwise the entire record (minus the key/value for `user_id_key` and `device_id_key`, and minus any `user_properties`) will be sent as `event_properties` to Amplitude.
+
+#### event type
+The event_type is the tag.  To modify this, fluent-plugin-amplitude includes the `HandleTagNameMixin` mixin which allows the following options:
+
+```xml
+remove_tag_prefix <tag_prefix_to_remove_including_the_dot>
+remove_tag_suffix <tag_suffix_to_remove_including_the_dot>
+add_tag_prefix <tag_prefix_to_add_including_the_dot>
+add_tag_suffix <tag_suffix_to_add_including_the_dot>
+```
+
+#### properties_blacklist
+Any properties included in the blacklist will be scrubbed from the record.
+
+#### events_whitelist
+If your `<match>` is using a wildcard, you can specify specific events to whitelist. If the `events_whitelist` is empty all events will be sent to Amplitude. Note the event name here is the `event_type` (so should not include, e.g., any prefixes that were removed via `remove_tag_prefix`)
+
+#### Error handling
+Any error will result in the message retrying. In the case of an incorrectly configured API key, this can result in the messages infinitely retrying.  You should set the normal [buffered output plugin options](http://docs.fluentd.org/articles/buffer-plugin-overview) to prevent this (and to preserve data in the case of misconfigured records failing to be submitted to Amplitude).
+
+## Contributing
+
+1. Fork it ( http://github.com/change/fluent-plugin-amplitude/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts 'Unable to load rspec. Have you run `bundle install`?'
+end
+
+task(:default).clear
+task default: ['rubocop:auto_correct', :spec]

data/fluent-plugin-amplitude.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fluent-plugin-amplitude'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Vijay Ramesh']
+  spec.email         = ['vijay@change.org']
+  spec.summary       = 'Fluentd plugin to output event data to Amplitude'
+  spec.description   = 'Fluentd plugin to output event data to Amplitude'
+  spec.homepage      = 'https://github.com/change/fluent-plugin-amplitude'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'fluentd', '>= 0.10.55'
+  spec.add_runtime_dependency 'amplitude-api', '~> 0.0.9'
+  spec.add_runtime_dependency 'msgpack', '~> 1.0', '>= 1.0.2'
+
+  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'test-unit', '~> 3.2', '>= 3.2.1'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.44.1'
+end

data/lib/fluent/plugin/out_amplitude.rb

@@ -0,0 +1,130 @@
+module Fluent
+  # Fluent::AmplitudeOutput plugin
+  class AmplitudeOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('amplitude', self)
+
+    include Fluent::HandleTagNameMixin
+
+    config_param :api_key, :string, secret: true
+    config_param :device_id_key, :string
+    config_param :user_id_key, :string
+    config_param :user_properties, :array, default: nil
+    config_param :event_properties, :array, default: nil
+    config_param :properties_blacklist, :array, default: nil
+    config_param :events_whitelist, :array, default: nil
+    class AmplitudeError < StandardError
+    end
+
+    def initialize
+      super
+      require 'amplitude-api'
+    end
+
+    def configure(conf)
+      super
+      raise Fluent::ConfigError, "'api_key' must be specified." if @api_key.nil?
+
+      invalid = @device_id_key.nil? && @user_id_key.nil?
+      raise Fluent::ConfigError,
+            "'device_id_key' or 'user_id_key' must be specified." if invalid
+    end
+
+    def start
+      super
+      AmplitudeAPI.api_key = @api_key
+    end
+
+    def format(tag, time, record)
+      return if @events_whitelist && !@events_whitelist.include?(tag)
+
+      amplitude_hash = { event_type: tag }
+
+      filter_properties_blacklist!(record)
+      extract_user_and_device_or_fail!(amplitude_hash, record)
+      extract_user_properties!(amplitude_hash, record)
+      extract_event_properties!(amplitude_hash, record)
+
+      [tag, time, amplitude_hash].to_msgpack
+    end
+
+    def write(chunk)
+      records = []
+      chunk.msgpack_each do |_tag, _time, record|
+        records << AmplitudeAPI::Event.new(simple_symbolize_keys(record))
+      end
+
+      send_to_amplitude(records)
+    end
+
+    private
+
+    def filter_properties_blacklist!(record)
+      return unless @properties_blacklist
+      record.reject! { |k, _| @properties_blacklist.include?(k) }
+    end
+
+    def extract_user_and_device_or_fail!(amplitude_hash, record)
+      if @user_id_key && record[@user_id_key]
+        amplitude_hash[:user_id] = record.delete(@user_id_key)
+      end
+
+      if @device_id_key && record[@device_id_key]
+        amplitude_hash[:device_id] = record.delete(@device_id_key)
+      end
+
+      verify_user_and_device_or_fail(amplitude_hash)
+    end
+
+    def verify_user_and_device_or_fail(amplitude_hash)
+      return if amplitude_hash[:user_id] || amplitude_hash[:device_id]
+      raise AmplitudeError, 'Error: either user_id or device_id must be set'
+    end
+
+    def extract_user_properties!(amplitude_hash, record)
+      # if user_properties are specified, pull them off of the record
+      return unless @user_properties
+      amplitude_hash[:user_properties] = {}.tap do |user_properties|
+        @user_properties.each do |prop|
+          next unless record[prop]
+          user_properties[prop.to_sym] = record.delete(prop)
+        end
+      end
+    end
+
+    def extract_event_properties!(amplitude_hash, record)
+      # if event_properties are specified, pull them off of the record
+      # otherwise, use the remaining record (minus any user_properties)
+      amplitude_hash[:event_properties] = begin
+        if @event_properties
+          record.select do |k, _v|
+            @event_properties.include?(k)
+          end
+        else
+          record
+        end
+      end
+    end
+
+    def send_to_amplitude(records)
+      log.info("sending #{records.length} to amplitude")
+      begin
+        res = AmplitudeAPI.track(records)
+        unless res.response_code == 200
+          raise "Got #{res.response_code} #{res.body} from AmplitudeAPI"
+        end
+      rescue StandardError => e
+        raise AmplitudeError, "Error: #{e.message}"
+      end
+    end
+
+    def simple_symbolize_keys(hsh)
+      Hash[hsh.map do |k, v|
+        begin
+          [k.to_sym, v]
+        rescue
+          [k, v]
+        end
+      end]
+    end
+  end
+end

data/spec/out_amplitude_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+require 'amplitude-api'
+describe Fluent::AmplitudeOutput do
+  let(:amplitude_api) { double(:amplitude_api) }
+  let(:now) { Time.now.to_i }
+  let(:tag) { 'after_sign' }
+  let(:amplitude) do
+    Fluent::Test::BufferedOutputTestDriver.new(
+      Fluent::AmplitudeOutput.new
+    ).configure(conf)
+  end
+  let(:conf) do
+    %(
+      api_key XXXXXX
+      user_id_key user_id
+      device_id_key uuid
+      user_properties first_name, last_name
+      event_properties current_source
+    )
+  end
+
+  before do
+    Fluent::Test.setup
+    expect(AmplitudeAPI).to receive(:api_key=).with('XXXXXX')
+    allow(AmplitudeAPI).to receive(:track).with(kind_of(Array)).and_return(
+      double(:response, response_code: 200)
+    )
+  end
+
+  describe '#format' do
+    before do
+      amplitude.tag = tag
+      amplitude.emit(event, now)
+    end
+
+    context 'everything is set' do
+      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
+        }
+      end
+
+      let(:formatted_event) do
+        {
+          event_type: tag,
+          user_id: 42,
+          device_id: 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          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
+      end
+    end
+
+    context 'the input only contains the user_id_key' do
+      let(:event) do
+        {
+          'user_id' => 42,
+          'first_name' => 'Bobby',
+          'last_name' => 'Weir',
+          'state' => 'CA',
+          'current_source' => 'fb_share',
+          'recruiter_id' => 710
+        }
+      end
+      let(:formatted_event) do
+        {
+          event_type: tag,
+          user_id: 42,
+          user_properties: {
+            first_name: 'Bobby',
+            last_name: 'Weir'
+          },
+          event_properties: {
+            current_source: 'fb_share'
+          }
+        }
+      end
+      it 'produces the expected output without device_id' do
+        amplitude.expect_format [tag, now, formatted_event].to_msgpack
+        amplitude.run
+      end
+    end
+
+    context 'the input only contains the device_id field' do
+      let(:event) do
+        {
+          'uuid' => 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          'first_name' => 'Bobby',
+          'last_name' => 'Weir',
+          'state' => 'CA',
+          'current_source' => 'fb_share',
+          'recruiter_id' => 710
+        }
+      end
+      let(:formatted_event) do
+        {
+          event_type: tag,
+          device_id: 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          user_properties: {
+            first_name: 'Bobby',
+            last_name: 'Weir'
+          },
+          event_properties: {
+            current_source: 'fb_share'
+          }
+        }
+      end
+      it 'produces the expected output without user_id' do
+        amplitude.expect_format [tag, now, formatted_event].to_msgpack
+        amplitude.run
+      end
+    end
+
+    context 'the input only contains neither user_id nor device_id field' do
+      let(:event) do
+        {
+          'first_name' => 'Bobby',
+          'last_name' => 'Weir',
+          'state' => 'CA',
+          'current_source' => 'fb_share',
+          'recruiter_id' => 710
+        }
+      end
+      it 'raises a Fluent::AmplitudeOutput::AmplitudeError' do
+        expect { amplitude.run }.to raise_error(
+          Fluent::AmplitudeOutput::AmplitudeError
+        )
+      end
+    end
+
+    context 'properties_blacklist is specified' do
+      let(:conf) do
+        %(
+          api_key XXXXXX
+          user_id_key user_id
+          device_id_key uuid
+          user_properties first_name, last_name
+          properties_blacklist foo, state
+        )
+      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,
+          'foo' => 'bar'
+        }
+      end
+      let(:formatted_event) do
+        {
+          event_type: tag,
+          user_id: 42,
+          device_id: 'e6153b00-85d8-11e6-b1bc-43192d1e493f',
+          user_properties: {
+            first_name: 'Bobby',
+            last_name: 'Weir'
+          },
+          event_properties: {
+            current_source: 'fb_share',
+            recruiter_id: 710
+          }
+        }
+      end
+      it 'produces the expected output without blacklisted properties' do
+        amplitude.expect_format [tag, now, formatted_event].to_msgpack
+        amplitude.run
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'fluent/test'
+require 'rspec'
+
+Test::Unit::AutoRunner.need_auto_run = false if defined?(Test::Unit::AutoRunner)
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fluent/plugin/out_amplitude'

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-amplitude
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vijay Ramesh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.55
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.55
+- !ruby/object:Gem::Dependency
+  name: amplitude-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+description: Fluentd plugin to output event data to Amplitude
+email:
+- vijay@change.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-amplitude.gemspec
+- lib/fluent/plugin/out_amplitude.rb
+- spec/out_amplitude_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/change/fluent-plugin-amplitude
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to output event data to Amplitude
+test_files:
+- spec/out_amplitude_spec.rb
+- spec/spec_helper.rb