Rubyでの実行の確認、失敗の再試行、および例外の再発生

ensureで ブロック、 Net ::HTTP＃finish を呼び出して、TCP接続を確実に閉じます。 httpでない限り 変数はnilです 、TCP接続を開くことが失敗する可能性があります（これも例外を発生させます）。

require "net/http"
 
begin
  puts "Opening TCP connection..."
  http = Net::HTTP.start(uri.host, uri.port)
  puts "Sending HTTP request..."
  puts http.request_get(uri.path).body
ensure
  if http
    puts "Closing the TCP connection..."
    http.finish
  end
end

注 ：後で再試行するときに接続を使用できるように、TCP接続を手動で閉じます。ただし、 Net ::HTTP.start以降 接続が閉じられていることを確認するためのブロックを取得します。上記のサンプルを書き換えて、 ensureを削除できます。 。興味深いことに、ensureブロックは、これがNet::HTTP自体に実装される方法でもあります。

再試行

再試行 キーワードを使用すると、ブロック内のコードの一部を再試行できます。 レスキューと組み合わせる ブロックすると、接続を開くことができなかった場合、またはAPIの応答に時間がかかりすぎる場合に、これを使用して再試行できます。

そのために、 read_timeoutを追加します Net ::HTTP.startへ タイムアウトを10秒に設定する呼び出し。それまでにリクエストへの応答がない場合は、 Net ::ReadTimeoutが発生します。 。

Errno ::ECONNREFUSEDにも一致します APIが完全にダウンしていることを処理します。これにより、TCP接続を開くことができなくなります。その場合、 http 変数はnilです 。

例外は救出され、再試行 beginを開始するために呼び出されます 再度ブロックすると、タイムアウトが発生しなくなるまでコードが同じ要求を実行します。 httpを再利用します 接続がすでに存在する場合は接続を保持するオブジェクト。

require "net/http"
 
http = nil
uri = URI("https://localhost:4567/")
 
begin
  unless http
    puts "Opening TCP connection..."
    http = Net::HTTP.start(uri.host, uri.port, read_timeout: 10)
  end
  puts "Executing HTTP request..."
  puts http.request_get(uri.path).body
rescue Errno::ECONNREFUSED, Net::ReadTimeout => e
  puts "Timeout (#{e}), retrying in 1 second..."
  sleep(1)
  retry
ensure
  if http
    puts "Closing the TCP connection..."
    http.finish
  end
end

これで、 Net ::ReadTimeout がなくなるまで、リクエストは1秒ごとに再試行されます。 上げられます。

$ ruby retry.rb
Opening TCP connection...
Executing HTTP request...
Timeout (Net::ReadTimeout), retrying in 1 second...
Executing HTTP request...
Timeout (Net::ReadTimeout), retrying in 1 second...
Executing HTTP request...
Timeout (Net::ReadTimeout), retrying in 1 second...
Executing HTTP request...
... (in an endless loop)

これにより、タイムアウトに対して例外が発生しないようにすることができますが、このように再試行してハンマーで叩いても、そのAPIを再びバックアップすることはできません。 APIが応答しないままの場合、このコードは永久にループし続けるため、これは問題があります。代わりに、再試行を広げてしばらくしてあきらめる必要があります。

あきらめる： raiseを使用して例外を再発生させる

例外がレスキューされると、発生した例外オブジェクトが rescueに渡されます。 ブロック。これを使用して、メッセージをログに出力するなど、例外からデータを抽出できますが、同じスタックトレースを使用して、まったく同じ例外を再発生させることもできます。

begin
  raise "Exception!"
rescue RuntimeError => e
  puts "Exception happened: #{e}"
  raise e
end

rescueで例外オブジェクトにアクセスできるため ブロックすると、エラーをコンソールまたはエラーモニターに記録できます。実際、レスキューとリレイズは、まさにAppSignalの統合がエラーを追跡する方法です。

注 ：Rubyは、最後に発生した例外を $！という名前の変数に格納します 、および raise キーワードはデフォルトでそれを使用します。 raiseを呼び出す 引数なしで最後の例外を再発生させます。

私たちのライブラリでは、リレイズを使用して、数回の再試行後にAPIのプレッシャーを取り除くことができます。そのために、 retriesで行った再試行回数を追跡します。 変数。

タイムアウトが発生するたびに、最大で3回の再試行を再試行するため、数値をインクリメントして3以下かどうかを確認します。その場合は、再試行します 。そうでない場合は、 raise 最後の例外を再発生させます。

require "net/http"
 
http = nil
uri = URI("https://localhost:4567/")
retries = 0
 
begin
  unless http
    puts "Opening TCP connection..."
    http = Net::HTTP.start(uri.host, uri.port, read_timeout: 1)
  end
  puts "Executing HTTP request..."
  puts http.request_get(uri.path).body
rescue Errno::ECONNREFUSED, Net::ReadTimeout => e
  if (retries += 1) <= 3
    puts "Timeout (#{e}), retrying in #{retries} second(s)..."
    sleep(retries)
    retry
  else
    raise
  end
ensure
  if http
    puts 'Closing the TCP connection...'
    http.finish
  end
end

再試行を使用する sleepの呼び出しの変数 、新しい試行ごとに待機時間を増やすことができます。

$ ruby reraise.rb
Opening TCP connection...
Executing HTTP request...
Timeout (Net::ReadTimeout), retrying in 1 second(s)...
Executing HTTP request...
Timeout (Net::ReadTimeout), retrying in 2 second(s)...
Executing HTTP request...
Timeout (Net::ReadTimeout), retrying in 3 second(s)...
Executing HTTP request...
Closing the TCP connection...
/lib/ruby/2.4.0/net/protocol.rb:176:in `rbuf_fill': Net::ReadTimeout (Net::ReadTimeout)
...
from reraise.rb:13:in `<main>'

コードが放棄されて最後のエラーが再発生する前に、リクエストが3回再試行されます。その後、エラーを1レベル上で処理するか、APIの応答なしにアプリがジョブを完了できない場合はアプリをクラッシュさせることができます。

復元力のあるWebAPIクライアント

これらのメソッドを組み合わせることで、約20行のコードで復元力のあるWebAPIクライアントを構築しました。ダウンしている場合や応答がない場合はリクエストを再試行し、再度起動しない場合はあきらめます。

例外の処理について何か新しいことを学び、この記事（またはAppSignal Academyシリーズの他の記事）についてどう思ったかを知りたいと思います。ご意見をお聞かせください。または、Rubyのテーマについて詳しく知りたい場合は、遠慮なくお知らせください。