Class: Fluent::MysqlBinlogFlydataInput

Inherits:
MysqlBinlogInput
  • Object
show all
Includes:
MysqlBinlogFlydataInputPreference
Defined in:
lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb

Constant Summary

Constants included from MysqlBinlogFlydataInputPreference

Fluent::MysqlBinlogFlydataInputPreference::CUSTOM_CONFIG_PARAMS

Instance Method Summary collapse

Methods included from MysqlBinlogFlydataInputPreference

included

Constructor Details

#initialize ⇒ MysqlBinlogFlydataInput

Returns a new instance of MysqlBinlogFlydataInput.



46
47
48
49
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 46

def initialize
  super
  install_custom_signal_handler
end

Instance Method Details

#configure(conf) ⇒ 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
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 59

def configure(conf)
  super
  @binlog_position_file = Mysql::BinLogPositionFile.new(@position_file)
  unless @binlog_position_file.exists?
    raise "No position file(#{@position_file}). Initial synchronization is required before starting."
  end

  @sync_fm = Flydata::SyncFileManager.new(nil) # Passing nil for data_entry as this class does not use methods which require data_entry
  @sent_position_file_path = @sync_fm.sent_binlog_path(@position_file)

  load_custom_conf

  # SSL configuration
  unless @ssl_ca_content.to_s.strip.empty?
    @ssl_ca_path = @sync_fm.ssl_ca_path(@position_file)
    @sync_fm.save_ssl_ca(FlydataCore::Fluent::ConfigHelper.unescape_conf(@ssl_ca_content), @ssl_ca_path)
  end

  # Db access opts
  db_opts = { host: @host, port: @port, username: @username, password: @password, database: @database, ssl_ca: @ssl_ca_path }

  $log.info "mysql host:\"#{@host}\" port:\"#{@port}\" username:\"#{@username}\" database:\"#{@database}\" tables:\"#{@tables}\" tables_append_only:\"#{tables_append_only}\""
  $log.info "mysql client version: #{`mysql -V`}"
  server_version = `echo 'select version();' | #{Flydata::Util::MysqlUtil.generate_mysql_cmd(db_opts)} 2>/dev/null`
  $log.info "mysql server version: #{server_version}"

  @tables = @tables.split(/,\s*/)
  @omit_events = Hash.new
  @tables_append_only.split(/,\s*/).each do |table|
    @tables << table unless @tables.include?(table)
    @omit_events[table] = [:delete, :truncate_table]
  end

  # Remove tables that do not have pos files
  new_tables = @sync_fm.get_new_table_list(@tables, "pos")
  @tables -= new_tables
  $log.info "Not watching these tables: #{new_tables.join(", ")}"

  table_meta = Mysql::TableMeta.new(db_opts.merge(tables: @tables))

  table_revs = tables.inject({}) do |h, table_name|
    h[table_name] = @sync_fm.table_rev(table_name)
    h
  end


  # Set context
  @context = Mysql::Context.new(
    database: @database, tables: @tables,
    tag: @tag, sync_fm: @sync_fm, omit_events: @omit_events,
    table_meta: table_meta, table_revs: table_revs,
  )
  @record_dispatcher = Mysql::FlydataBinlogRecordDispatcher.new(@context)
  @idle_event_detector = IdleEventDetector.new(@initial_idle_interval, @continuous_idle_interval, @check_interval)
end

#event_listener(event) ⇒ Object 



188
189
190
191
192
193
194
195
196
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 188

def event_listener(event)
  @idle_event_detector.notify
  @record_dispatcher.dispatch(event)
rescue Exception => e
  position = @binlog_position_file.read
  $log.error "error occured while processing #{event.event_type} event at #{position}\n#{e.message}\n#{$!.backtrace.join("\n")}"
  # Not reraising a StandardError because the underlying code can't handle an error well.
  raise unless e.kind_of?(StandardError)
end

#install_custom_signal_handler ⇒ Object

Hack: All that has been added here is ‘Fluent::Engine.shutdown_source`. This should be in fluentd’s supervisor#install_main_process_signal_handlers



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 224

def install_custom_signal_handler
    trap :USR1 do
      $log.debug "fluentd main process get SIGUSR1"
      $log.info "force flushing buffered events"
      #@log.reopen!

      # Creating new thread due to mutex can't lock
      # in main thread during trap context
      Thread.new {
        begin
          Fluent::Engine.shutdown_source
          Fluent::Engine.flush!
          $log.debug "flushing thread: flushed"
        rescue Exception => e
          $log.warn "flushing thread error: #{e}"
        end
      }.run
    end
end

#run ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 146

def run
  @context.table_meta.update
  start_kodama(mysql_url) do |c|
    c.binlog_position_file = @position_file
    if @ssl_ca_path.to_s != '' && c.respond_to?(:ssl_ca=)
      $log.info "SSL is enabled. (ssl_ca: #{@ssl_ca_path})"
      c.ssl_ca = @ssl_ca_path
    end

    if c.respond_to?(:sent_binlog_position_file=)
      $log.info "Sent position feature is enabled. sent_position_file:#{@sent_position_file_path}"
      c.sent_binlog_position_file = @sent_position_file_path
    end
    c.connection_retry_limit = @retry_limit
    c.connection_retry_wait = @retry_wait
    c.log_level = @log_level.to_sym
    @listen_events.each do |event_type|
      $log.trace { "registered binlog event listener '#{event_type}'" }
      c.send("on_#{event_type}", &method(:event_listener))
    end
  end
rescue => e
  # HACK: mysql-replication-listener has a network connection leak bug which doesn't release a connection
  # to MySQL.  Rather than fixing the bug, restarting the fluentd process for now.
  $log.warn "kodama died with an error.  Restart the process after #{@retry_wait} seconds.  error: #{e.class.to_s} '#{e.to_s}'"
  sleep @retry_wait
  Process.kill(:HUP, Process.ppid) # Send SIGHUP to the supervisor to restart fluentd
rescue SignalException
  $log.debug "signal exception. exception: #{$!.class.to_s}, error: #{$!.to_s}"
  raise
rescue Exception
  $log.error "unexpected fatal error. exception: #{$!.class.to_s}, error: #{$!.to_s}\n#{$!.backtrace.join("\n")}"
  raise
end

#shutdown ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 198

def shutdown
  @idle_event_detector.stop
  if @thread and @thread.alive?
    $log.info "Requesting stop Kodama"
    @kodama_client.stop_request
    if wait_till_safe_to_stop
      $log.info "Killing Kodama client"
      Thread.kill(@thread)
    else
      $log.error "Unable to stop Kodama"
    end
  end
  @sync_fm.close
end

#start ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 115

def start
  super
  @idle_event_detector.start do |reason, timestamp|
    case reason
    when :event_not_coming
      $log.warn "No binary log event since #{timestamp}"
    when :event_still_not_coming
      $log.warn "No binary log event since #{timestamp}"
    when :event_arrived_finally
      $log.info "Binary log event has come at #{timestamp}"
    end
  end

  positions_path = @context.sync_fm.table_positions_dir_path
  Dir.mkdir positions_path unless File.exists? positions_path
rescue Binlog::Error
  if (/basic_string::_M_replace_aux/ === $!.to_s)
    # TODO Fix the root cause in mysql-replication-listener
    $log.error <<EOS
a mysql-replication-listener error.  This could have been caused by one of the following reasons.
- Failed on connect: Your host is blocked because of many connection errors; unblock with 'mysqladmin flush-hosts'
EOS
  else
    $log.error "unexpected mysql-replication-listener error. exception: #{$!.class.to_s}, error: #{$!.to_s}\n#{$!.backtrace.join("\n")}"
  end
  raise
rescue Exception
  $log.error "unexpected fatal error. exception: #{$!.class.to_s}, error: #{$!.to_s}\n#{$!.backtrace.join("\n")}"
  raise
end

#start_kodama(options, &block) ⇒ Object 



181
182
183
184
185
186
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 181

def start_kodama(options, &block)
  @kodama_client = Kodama::Client.new(Kodama::Client.mysql_url(options))
  @kodama_client.logger = $log
  block.call(@kodama_client)
  @kodama_client.start
end

#wait_till_safe_to_stop ⇒ Object 



213
214
215
216
217
218
219
220
 
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 213

def wait_till_safe_to_stop
  retry_count = 5
  1.upto(retry_count) do |i|
    return true if @kodama_client.safe_to_stop?
    sleep 3
  end
  false
end