コンテンツにスキップ

NATS出力

この出力は、選択したAdderイベントをJSONとしてCore NATS subjectへ公開します。公式のGo clientを使用します。Core NATSの配信はat-most-onceであり、この出力はJetStreamや永続ストレージを必要としません。

output: nats
plugins:
output:
nats:
servers: "nats://127.0.0.1:4222"
subject-prefix: "adder.events"
event-types: "blocks,rollbacks,governance"
オプション省略時の値説明
serversnats://127.0.0.1:4222NATS server URLをコンマ区切りで指定します。
token空文字列NATS認証トークンを指定します。
subject-prefixadder.eventsイベントsubjectのプレフィックスを指定します。
event-typesblocks,rollbacks,governance配信するイベントタイプをコンマ区切りで指定します。少なくとも1つの対応タイプを指定します。

serversには少なくとも1つのNATS URLを指定します。各URLには次の規則を適用します。

  • nats://またはtls://スキームを使用します。
  • ホスト名を指定します。
  • 認証情報、クエリ、フラグメントを含めません。
  • パスを指定しないか、/だけを指定します。
  • ポートを指定する場合は1から65535の範囲にします。

tokenを指定する場合はTLSにtls://を使用します。認証情報はsecret管理された設定から渡します。

subject-prefixには、ワイルドカードを含まない空でないNATS subject tokenを指定します。次の値は拒否されます。

  • スペース、タブ、復帰、改行、*、>、/を含む値
  • .で始まる値または.で終わる値
  • ..を含む値

event-typesには、次の対応イベント名を指定できます。Adderは未知の名前を拒否します。

イベント名Adderイベントタイプ既定で選択subjectの例
blocksinput.blockはいadder.events.block
transactionsinput.transactionいいえadder.events.transaction
rollbacksinput.rollbackはいadder.events.rollback
governanceinput.governanceはいadder.events.governance
drep-registrationinput.drep-registrationいいえadder.events.drep-registration
drep-updateinput.drep-updateいいえadder.events.drep-update
drep-retirementinput.drep-retirementいいえadder.events.drep-retirement

Adderは選択したイベントごとに、subject-prefix、.、input.を除いたイベントタイプを連結してsubjectを作成します。

各ペイロードには、Adderイベント全体をJSONとして含めます。

Adderは各publishの後に接続をflushします。各イベントでこのラウンドトリップを実行するため、サーバーがpublish commandを処理したことを確認できますが、ブローカーとのラウンドトリップ1回あたりおよそ1イベントに処理量が制限されます。flushは5秒でタイムアウトします。

flushの成功は、サーバーが先行するpublish commandを処理したことを示します。subscriberがイベントを受け取ったことや、Core NATSが配信を永続化したことは示しません。

publish、flush、非同期ブローカー拒否の失敗は、Adderのエラー通知で報告します。曖昧なflush失敗はメッセージを重複させる可能性があるため再試行しません。

クライアントは後続イベントのために再接続しますが、オフラインpublishのバッファリングは無効です。切断中に公開したイベントは失敗し、キューに蓄積されません。停止時に接続を閉じ、メモリ上の保留イベントを復元しません。

  1. adder.events.>を購読します。
  2. 選択したイベントを送信します。
  3. subjectとJSONペイロードが期待した値であることを確認します。
  4. ブローカーとの接続を切断し、出力がエラーを報告することを確認します。

個別のブローカーを用意しない場合でも、パッケージテストはローカルのCore NATS protocol peerを使用してsubjectの対応とシリアライズ済みペイロードを確認できます。


Doc Holiday logo

Docs authored by Doc Holiday