Class: Fluent::MysqlBinlogFlydataInput

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

Constant Summary collapse

NON_DH_SSL_CIPHER =

Secondary ssl cipher is for a workaround to handle 'dh key too small' error If mysql-server is v5.6.25 or older, and client openssl is 1.0.1f-1ubuntu-2.15(for ubuntu) or later, client will get the above error because. the key length returned from mysql-server is only 512 bits.

In case of dh key error, we retry with non-DH cipher.

  • SECURITY IMPROVEMENT: reject dh keys smaller than 768 bits

launchpad.net/ubuntu/+source/openssl/1.0.1f-1ubuntu2.15

Supported ssl cipher list for mysql(openssl) dev.mysql.com/doc/refman/5.6/en/ssl-options.html

"AES256-GCM-SHA384:AES256-SHA:AES256-SHA256:CAMELLIA256-SHA:DES-CBC3-SHA:PSK-3DES-EDE-CBC-SHA:PSK-AES256-CBC-SHA:SRP-DSS-3DES-EDE-CBC-SHA:SRP-DSS-AES-128-CBC-SHA:SRP-DSS-AES-256-CBC-SHA:SRP-RSA-3DES-EDE-CBC-SHA:SRP-RSA-AES-128-CBC-S:SRP-RSA-AES-256-CBC-SHA"

Constants included from MysqlBinlogFlydataInputPreference

Fluent::MysqlBinlogFlydataInputPreference::CUSTOM_CONFIG_PARAMS

Instance Method Summary collapse

Methods included from MysqlBinlogFlydataInputPreference

included

Constructor Details

#initializeMysqlBinlogFlydataInput

Returns a new instance of MysqlBinlogFlydataInput.


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

def initialize
  super
  install_custom_signal_handler
end

Instance Method Details

#configure(conf) ⇒ Object


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
114
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
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 78

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, ssl_cipher: @ssl_cipher }

  $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_msg = `echo 'select version();' | #{FlydataCore::Mysql::CommandGenerator.generate_mysql_cmd(@db_opts)} 2>&1`
  if ($?.exitstatus == 0)
    $log.info "mysql server version: #{server_msg.strip}"
  else
    err_msg = "Failed to access mysql server... #{server_msg.strip}"
    $log.error err_msg
    $stderr.puts err_msg
    #exit 1   # causes retry loop
  end

  @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 = Flydata::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, @idle_timeout)
  @lock_file = Flydata::FLYDATA_LOCK
end

#event_listener(event) ⇒ Object


256
257
258
259
260
261
262
263
264
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 256

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_handlerObject

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


299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 299

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

#runObject


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 184

def run
  return if instance_variable_defined? :@abort

  @context.table_meta.update
  Flydata::Mysql::TableDdl.migrate_tables(@context.tables, @db_opts,
                                          @context.sync_fm, @position_file,
                                          @context) do |event|
    @record_dispatcher.dispatch(event)
  end

  current_ssl_cipher = @ssl_cipher
  retried = false
  begin
    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
        unless current_ssl_cipher.to_s.empty?
          $log.info "SSL cipher is set. (ssl_cipher: #{current_ssl_cipher})"
          c.ssl_cipher = current_ssl_cipher
        end
      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

      $log.info("Binlog position - resume_pos:'#{IO.read(@position_file) rescue IOError}' " +
                                  "sent_pos:'#{IO.read(@sent_position_file_path) rescue IOError}'")

      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 Binlog::Error => e
    if /dh key too small/.match(e.to_s) && !retried && !@secondary_ssl_cipher.to_s.empty?
      retried = true
      current_ssl_cipher = @secondary_ssl_cipher
      $log.warn("Retry with secondary ssl cipher list due to '#{e}' - secondary_ssl_cipher: '#{@secondary_ssl_cipher}'")
      retry
    else
      raise e
    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}'\n#{e.backtrace.join("\n")}"
  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

#shutdownObject


266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 266

def shutdown
  return if instance_variable_defined? :@abort

  if File.exists?(@lock_file) &&
     Process.pid == File.open(@lock_file, "r") {|f| f.read}.to_i
    File.delete(@lock_file)
  end

  @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

#startObject


141
142
143
144
145
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
180
181
182
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 141

def start
  if File.exists?(@lock_file)
    $log.error "Previous process was terminated abnormally.  To start, remove the lock file after checking data integrity."
    @abort = true
    Process.kill(:TERM, Process.ppid)
    return
  end

  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}"
    when :event_idle_timeout
      $log.error "No binary log event since #{timestamp}. Restart the process."
      Process.kill(:HUP, Process.ppid)
    end
  end

  positions_path = @context.sync_fm.table_positions_dir_path
  Dir.mkdir positions_path unless File.exists? positions_path

  File.open(@lock_file, "w") {|f| f.write(Process.pid)}
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


249
250
251
252
253
254
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 249

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_stopObject


288
289
290
291
292
293
294
295
# File 'lib/flydata/fluent-plugins/in_mysql_binlog_flydata.rb', line 288

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