Class: Fluent::MixpanelOutput

Inherits:
BufferedOutput
  • Object
show all
Includes:
HandleTagNameMixin
Defined in:
lib/fluent/plugin/out_mixpanel.rb

Defined Under Namespace

Classes: MixpanelError

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MixpanelOutput

Returns a new instance of MixpanelOutput.



22
23
24
25
 
# File 'lib/fluent/plugin/out_mixpanel.rb', line 22

def initialize
  super
  require 'mixpanel-ruby'
end

Instance Method Details

#configure(conf) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/fluent/plugin/out_mixpanel.rb', line 27

def configure(conf)
  super
  @project_tokey = conf['project_token']
  @distinct_id_key = conf['distinct_id_key']
  @event_key = conf['event_key']
  @ip_key = conf['ip_key']
  @event_map_tag = conf['event_map_tag']
  @api_key = conf['api_key']
  @use_import = conf['use_import']
  @use_legacy_prefix_behavior = conf['use_legacy_prefix_behavior']
  @discard_event_on_send_error = conf['discard_event_on_send_error']

  if @event_key.nil? and !@event_map_tag
    raise Fluent::ConfigError, "'event_key' must be specifed when event_map_tag == false."
  end
end

#format(tag, time, record) ⇒ Object 



54
55
56
57
 
# File 'lib/fluent/plugin/out_mixpanel.rb', line 54

def format(tag, time, record)
  time = record['time'] if record['time'] && @use_import
  [tag, time, record].to_msgpack
end

#send_to_mixpanel(records) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/fluent/plugin/out_mixpanel.rb', line 104

def send_to_mixpanel(records)
  log.debug("sending #{records.length} to mixpanel")

  records.each do |record|
    success = true

    if @use_import
      success = @tracker.import(@api_key, record['distinct_id'], record['event'], record['properties'])
    else
      success = @tracker.track(record['distinct_id'], record['event'], record['properties'])
    end

    unless success
      if @discard_event_on_send_error
        msg = "Failed to track event to mixpanel:\n"
        msg += "\tRecord: #{record.to_json}"
        log.info(msg)
      else
        raise MixpanelError.new("Failed to track event to mixpanel")
      end
    end
  end
end

#shutdown ⇒ Object 



50
51
52
 
# File 'lib/fluent/plugin/out_mixpanel.rb', line 50

def shutdown
  super
end

#start ⇒ Object 



44
45
46
47
48
 
# File 'lib/fluent/plugin/out_mixpanel.rb', line 44

def start
  super
  error_handler = Fluent::MixpanelOutputErrorHandler.new(log)
  @tracker = Mixpanel::Tracker.new(@project_token, error_handler)
end

#write(chunk) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/fluent/plugin/out_mixpanel.rb', line 59

def write(chunk)
  records = []
  chunk.msgpack_each do |tag, time, record|
    data = {}
    prop = data['properties'] = record.dup

    # Ignore token in record
    prop.delete('token')

    if @event_map_tag
      tag.gsub!(/^\./, '') if @use_legacy_prefix_behavior
      data['event'] = tag
    elsif record[@event_key]
      data['event'] = record[@event_key]
      prop.delete(@event_key)
    else
      log.warn("no event, tag: #{tag}, time: #{time.to_s}, record: #{record.to_json}")
      next
    end

    # Ignore browswer only special event
    next if data['event'].start_with?('mp_')

    if record[@distinct_id_key]
      data['distinct_id'] = record[@distinct_id_key]
      prop.delete(@distinct_id_key)
    else
      log.warn("no distinct_id, tag: #{tag}, time: #{time.to_s}, record: #{record.to_json}")
      next
    end

    if !@ip_key.nil? and record[@ip_key]
      prop['ip'] = record[@ip_key]
      prop.delete(@ip_key)
    end

    prop.select! {|key, _| !key.start_with?('mp_') }
    prop.merge!('time' => time.to_i)

    records << data
  end

  send_to_mixpanel(records)
end