fluent-plugin-mixpanel 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9406e78fac736d2fd7b8b6b4dfa4645f741170db
-  data.tar.gz: 43835b93670babcdfe3d6cf184b6b65413507315
+  metadata.gz: d484a01b3b20513d87cef2561d3472e2cf4447b1
+  data.tar.gz: 56622c0ebdfc8cfb822e542cecd31516ffec9079
 SHA512:
-  metadata.gz: 9aa1ecf98277f977a110929ea16356265fc02f858253fcf100f0f5c6f569e65766fce3f20809b0c72286971becb16fae7aa113529774ed5b166f7264898731c4
-  data.tar.gz: 33c231f32a0eed37ff3225ad41f93dfbb72c6e9383e7afb419fc76c037692e1ce3ad8de3f234aaef89480291b4d3a62224247ff0b69525d98bef6717708bd7f9
+  metadata.gz: 6a5c41e85c1d43fdd6ec3b2ecde7425fc210e1bb6c980a4ecb8967c96a97aeaa4617cdc6bcc7f384ccc015d3281bb8bb7a05df797c3f1beb65b65644b2000ef5
+  data.tar.gz: 5cbbe5f96c417112b3b80ae6006767664865758922de36b9ac4f4df197bab68145be69d5b79fa965ea69c3345cf120551ae7fde7d33f07f0c5386ebfc0f7d5bf

data/README.md

@@ -29,6 +29,9 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-mixpanel
 ### MixpanelOutput
 
 MixpanelOutput needs mixpanel's `project_token`, that can get from your mixpanel project settings.
+
+#### Use distinct_id_key and event_key
+
 You should also specify property key name by `distinct_id_key` and `event_key`.
 
 ```
@@ -53,6 +56,33 @@ tracker = Mixpanel::Tracker.new(YOUR_PROJECT_TOKEN)
 tracker.track("123", "event1", { key1: "value1", key2: "value2" })
 ```
 
+#### Use distinct_id_key and event_map_tag
+
+You can use tag name as event name like this.
+
+```
+<match output.mixpanel.*>
+  type mixpanel
+  project_token YOUR_PROJECT_TOKEN
+  distinct_id_key user_id
+  remove_tag_prefix output.mixpanel
+  event_map_tag true
+</match>
+```
+
+If tag name is `output.mixpanel.event1` and record like this:
+
+```rb
+{ user_id: "123", key1: "value1", key2: "value2" }
+```
+
+above settings send to the following data to mixpanel, using [mixpanel-ruby](https://github.com/mixpanel/mixpanel-ruby) gem.
+
+```rb
+tracker = Mixpanel::Tracker.new(YOUR_PROJECT_TOKEN)
+tracker.track("123", "event1", { key1: "value1", key2: "value2" })
+```
+
 ### HttpMixpanelInput
 
 HttpMixpanelInput has same configuration as [http Input Plugin](http://docs.fluentd.org/en/articles/in_http).

data/example/index.html

@@ -14,7 +14,7 @@
   (function(c,a){window.mixpanel=a;var b,d,h,e;b=c.createElement("script");
   b.type="text/javascript";b.async=!0;b.src=("https:"===c.location.protocol?"https:":"http:")+'//cdn.mxpnl.com/libs/mixpanel-2.2.min.js';d=c.getElementsByTagName("script")[0];d.parentNode.insertBefore(b,d);a._i=[];a.init=function(b,c,f){function d(a,b){var c=b.split(".");2==c.length&&(a=a[c[0]],b=c[1]);a[b]=function(){a.push([b].concat(Array.prototype.slice.call(arguments,0)))}}var g=a;"undefined"!==typeof f?g=a[f]=[]:f="mixpanel";g.people=g.people||[];h=['disable','track','track_pageview','track_links','track_forms','register','register_once','unregister','identify','alias','name_tag','set_config','people.set','people.set_once','people.increment','people.track_charge','people.append'];for(e=0;e<h.length;e++)d(g,h[e]);a._i.push([b,c,f])};a.__SV=1.2;})(document,window.mixpanel||[]);
   mixpanel.init("dummy", {
-    api_host: 'http://0.0.0.0:8888',
+    api_host: '//0.0.0.0:5000',
     debug: true
   });
 </script>

data/fluent-plugin-mixpanel.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-mixpanel"
-  spec.version       = "0.0.3"
+  spec.version       = "0.0.4"
   spec.authors       = ["Kazuyuki Honda"]
   spec.email         = ["hakobera@gmail.com"]
   spec.summary       = %q{Fluentd plugin to input/output event track data to mixpanel}

data/lib/fluent/plugin/out_mixpanel.rb

@@ -3,9 +3,12 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
 
   config_param :project_token, :string
   config_param :distinct_id_key, :string
-  config_param :event_key, :string
+  config_param :event_key, :string, :default => nil
   config_param :ip_key, :string, :default => nil
 
+  config_param :remove_tag_prefix, :string, :default => nil
+  config_param :event_map_tag, :bool, :default => false
+
   def initialize
     super
     require 'mixpanel-ruby'
@@ -17,17 +20,11 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
     @distinct_id_key = conf['distinct_id_key']
     @event_key = conf['event_key']
     @ip_key = conf['ip_key']
+    @remove_tag_prefix = conf['remove_tag_prefix']
+    @event_map_tag = conf['event_map_tag']
 
-    if @project_token.empty?
-      raise Fluent::ConfigError, "'project_token' must be specifed."
-    end
-
-    if @distinct_id_key.empty?
-      raise Fluent::ConfigError, "'distinct_id_key' must be specifed."
-    end
-
-    if @event_key.empty?
-      raise Fluent::ConfigError, "'event_key' must be specifed."
+    if @event_key.nil? and !@event_map_tag
+      raise Fluent::ConfigError, "'event_key' must be specifed when event_map_tag == false."
     end
   end
 
@@ -57,7 +54,9 @@ class Fluent::MixpanelOutput < Fluent::BufferedOutput
         return
       end
 
-      if record[@event_key]
+      if @event_map_tag
+        data['event'] = tag.gsub(/^#{@remove_tag_prefix}(\.)?/, '')
+      elsif record[@event_key]
         data['event'] = record[@event_key]
         record.delete(@event_key)
       else 

data/test/plugin/test_out_mixpanel.rb

@@ -11,11 +11,10 @@ class MixpanelOutputTest < Test::Unit::TestCase
   CONFIG = %[
     project_token test_token
     distinct_id_key user_id
-    event_key event
   ]
 
   def create_driver(conf = CONFIG)
-    Fluent::Test::BufferedOutputTestDriver.new(Fluent::MixpanelOutput).configure(conf)
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::MixpanelOutput, 'mixpanel.test').configure(conf)
   end
 
   def stub_mixpanel(url="https://api.mixpanel.com/track")
@@ -34,7 +33,7 @@ class MixpanelOutputTest < Test::Unit::TestCase
   end
 
   def test_configure
-    d = create_driver
+    d = create_driver(CONFIG + "event_key event")
 
     assert_equal 'test_token', d.instance.project_token
     assert_equal 'user_id', d.instance.distinct_id_key
@@ -42,7 +41,7 @@ class MixpanelOutputTest < Test::Unit::TestCase
   end
 
   def test_configure_with_ip_key
-    d = create_driver(CONFIG + 'ip_key ip')
+    d = create_driver(CONFIG + "event_key event\n ip_key ip")
 
     assert_equal 'test_token', d.instance.project_token
     assert_equal 'user_id', d.instance.distinct_id_key
@@ -50,9 +49,19 @@ class MixpanelOutputTest < Test::Unit::TestCase
     assert_equal 'ip', d.instance.ip_key
   end
 
+  def test_configure_with_event_map_tag
+    d = create_driver(CONFIG + "remove_tag_prefix mixpanel\n event_map_tag true")
+
+    assert_equal 'test_token', d.instance.project_token
+    assert_equal 'user_id', d.instance.distinct_id_key
+    assert_equal nil, d.instance.event_key
+    assert_equal 'mixpanel', d.instance.remove_tag_prefix
+    assert_equal true.to_s, d.instance.event_map_tag
+  end
+
   def test_write
     stub_mixpanel
-    d = create_driver
+    d = create_driver(CONFIG + "event_key event")
     time = Time.new('2014-01-01T01:23:45+00:00')
     d.emit(sample_record, time)
     d.run
@@ -66,7 +75,7 @@ class MixpanelOutputTest < Test::Unit::TestCase
 
   def test_write_multi_request
     stub_mixpanel
-    d = create_driver
+    d = create_driver(CONFIG + "event_key event")
     time1 = Time.new('2014-01-01T01:23:45+00:00')
     time2 = Time.new('2014-01-02T01:23:45+00:00')
 
@@ -90,7 +99,7 @@ class MixpanelOutputTest < Test::Unit::TestCase
 
   def test_write_with_ip_key
     stub_mixpanel
-    d = create_driver(CONFIG + 'ip_key ip_address')
+    d = create_driver(CONFIG + "event_key event\n ip_key ip_address")
     time = Time.new('2014-01-01T01:23:45+00:00')
     d.emit(sample_record.merge('ip_address' => '192.168.0.2'), time)
     d.run
@@ -103,9 +112,37 @@ class MixpanelOutputTest < Test::Unit::TestCase
     assert_equal "value2",      @out[0]['properties']['key2']
   end
 
+  def test_write_with_event_map_tag
+    stub_mixpanel
+    d = create_driver(CONFIG + "remove_tag_prefix mixpanel\n event_map_tag true")
+    time = Time.new('2014-01-01T01:23:45+00:00')
+    d.emit(sample_record, time)
+    d.run
+
+    assert_equal "123",     @out[0]['properties']['distinct_id']
+    assert_equal "test",    @out[0]['event']
+    assert_equal time.to_i, @out[0]['properties']['time']
+    assert_equal "value1",  @out[0]['properties']['key1']
+    assert_equal "value2",  @out[0]['properties']['key2']
+  end
+
+  def test_write_with_no_remove_tag_prefix
+    stub_mixpanel
+    d = create_driver(CONFIG + "event_map_tag true")
+    time = Time.new('2014-01-01T01:23:45+00:00')
+    d.emit(sample_record, time)
+    d.run
+
+    assert_equal "123",           @out[0]['properties']['distinct_id']
+    assert_equal "mixpanel.test", @out[0]['event']
+    assert_equal time.to_i,       @out[0]['properties']['time']
+    assert_equal "value1",        @out[0]['properties']['key1']
+    assert_equal "value2",        @out[0]['properties']['key2']
+  end
+
   def test_request_error
     stub_mixpanel_unavailable
-    d = create_driver
+    d = create_driver(CONFIG + "event_key event")
     d.emit(sample_record)
     assert_raise(Mixpanel::ConnectionError) {
       d.run

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mixpanel
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kazuyuki Honda