バッチ・ジョブ・イベント公開の有効化
Java Messaging System (JMS) を使用することによって、バッチ・サーバーはジョブ関連イベントを外部クライアントに公開できます。
このタスクについて
ジョブ関連イベントを外部クライアントに公開するというバッチ・サーバーの機能は、モニター担当者がジョブ関連イベントおよび障害レポートを確認することを可能にします。バッチ・ディスパッチャー・サーバーは、ディスパッチ・フェーズで、ジョブに関するイベントを公開できます。バッチ executor サーバーは、実行の各フェーズを進んでいくときに、ジョブに関するイベントを公開できます。これらのイベントは、次のような構造のトピック・ツリー形式で公開されます。
構造 | 説明 |
---|---|
batch | トピック・ツリーのデフォルト・ルート。![]() |
batch/jobs | すべてのジョブ関連イベントのトピック・ツリー。 |
batch/jobs/instance | 1 つのジョブ・インスタンスに関連するすべてのイベントのトピック・ツリー。 |
batch/jobs/instance/submitted | トピック・ツリーのノード。新しいジョブ実行依頼のためにバッチ・サーバーがジョブ・インスタンスを作成するとメッセージが公開されます。 |
batch/jobs/instance/jms_queued | トピック・ツリーのノード。バッチ JMS ディスパッチャーによってジョブ実行依頼がジョブ実行依頼キューに置かれるとメッセージが公開されます。 |
batch/jobs/instance/jms_consumed | トピック・ツリーのノード。バッチ executor がジョブ実行依頼キューからジョブ実行依頼を受け取るとメッセージが公開されます。 |
batch/jobs/instance/dispatched | トピック・ツリーのノード。バッチ executor が実行のためにジョブ・インスタンスを受け入れるとメッセージが公開されます。 |
batch/jobs/instance/completed | トピック・ツリーのノード。ジョブ・インスタンスが完了するとメッセージが公開されます。 |
batch/jobs/instance/stopped | トピック・ツリーのノード。ジョブ・インスタンスが停止するとメッセージが公開されます。 |
batch/jobs/instance/stopping | トピック・ツリーのノード。ジョブ・インスタンスが停止しているとメッセージが公開されます。 |
batch/jobs/instance/failed | トピック・ツリーのノード。ジョブ・インスタンスが失敗するとメッセージが公開されます。 |
batch/jobs/instance/purged | トピック・ツリーのノード。ジョブ・インスタンスが正常に消去されるとメッセージが公開されます。 |
batch/jobs/execution | 1 つのジョブ実行に関連するすべてのイベントのトピック・ツリー。 |
batch/jobs/execution/restarting | トピック・ツリーのノード。バッチ executor が実行を再始動しているとメッセージが公開されます。 |
batch/jobs/execution/starting | トピック・ツリーのノード。ジョブ実行が開始しているとメッセージが公開されます。 |
batch/jobs/execution/completed | トピック・ツリーのノード。ジョブ実行が正常に終了するとメッセージが公開されます。 |
batch/jobs/execution/failed | トピック・ツリーのノード。障害のためにジョブ実行が終了するとメッセージが公開されます。 |
batch/jobs/execution/stopped | トピック・ツリーのノード。ジョブ実行が停止するとメッセージが公開されます。 |
batch/jobs/execution/jobLogPart | トピック・ツリーのノード。新規ジョブ・ログ・パートが作成されるか、ジョブが停止するか、ジョブが終了すると、メッセージが公開されます。 |
batch/jobs/execution/step/started | トピック・ツリーのノード。ステップ実行が開始するとメッセージが公開されます。 |
batch/jobs/execution/step/completed | トピック・ツリーのノード。ステップ実行が正常に完了するとメッセージが公開されます。 |
batch/jobs/execution/step/failed | トピック・ツリーのノード。ステップ実行が失敗するとメッセージが公開されます。 |
batch/jobs/execution/step/stopped | トピック・ツリーのノード。ステップ実行が停止するとメッセージが公開されます。 |
batch/jobs/execution/step/checkpoint | トピック・ツリーのノード。チェックポイントが取られるとメッセージが公開されます。 |
batch/jobs/execution/partition/started | トピック・ツリーのノード。パーティションが開始するとメッセージが公開されます。 |
batch/jobs/execution/partition/completed | トピック・ツリーのノード。パーティションが正常に完了するとメッセージが公開されます。 |
batch/jobs/execution/partition/failed | トピック・ツリーのノード。パーティションが失敗するとメッセージが公開されます。 |
batch/jobs/execution/partition/stopped | トピック・ツリーのノード。パーティションが停止するとメッセージが公開されます。 |
batch/jobs/execution/split-flow/started | トピック・ツリーのノード。分割フローが開始するとメッセージが公開されます。 |
batch/jobs/execution/split-flow/ended | トピック・ツリーのノード。分割フローが完了するとメッセージが公開されます。 |
各トピックの公開されるメッセージは JMS TextMessage です。このメッセージの内容は、トピックの対象 (例えば、ジョブ・インスタンス、ジョブ実行、ステップ実行、パーティションなど) を表す、JSON 形式のストリングです。それに加えて、このメッセージは次の JMS メッセージ・プロパティー・セットも含みます。
- com_ibm_ws_batch_internal_jobInstanceId: ジョブ・インスタンス ID (入手可能な場合)。
- com_ibm_ws_batch_internal_jobExecutionId: ジョブ実行 ID (入手可能な場合)。
- com_ibm_ws_batch_internal_stepExecutionId: ジョブ・ステップ実行 ID (入手可能な場合)。
ジョブ関連イベントの公開を有効にするには、バッチ・サーバーを構成する必要があります。 バッチ・ディスパッチャーとバッチ executor の構成は同じです。バッチ・サーバーでジョブ関連イベントの公開を有効にする手順は次のとおりです。
手順
例
次の例は、基本的な実行フローでのイベントのシーケンスを示します。
- チェックポイントがある単一ステップのジョブをサブミットして実行する。
batch/jobs/instance/submitted batch/jobs/instance/jms_queued batch/jobs/instance/jms_consumed batch/jobs/execution/starting batch/jobs/instance/dispatched batch/jobs/execution/started batch/jobs/execution/step/started batch/jobs/execution/step/checkpoint batch/jobs/execution/step/checkpoint ... batch/jobs/execution/step/checkpoint batch/jobs/execution/step/completed batch/jobs/execution/completed batch/jobs/instance/completed
- パーティションがある単一ステップのジョブをサブミットして実行する。
batch/jobs/instance/submitted batch/jobs/instance/jms_queued batch/jobs/instance/jms_consumed batch/jobs/execution/starting batch/jobs/instance/dispatched batch/jobs/execution/started batch/jobs/execution/step/started batch/jobs/execution/partition/started batch/jobs/execution/partition/started batch/jobs/execution/partition/started batch/jobs/execution/partition/completed batch/jobs/execution/partition/completed batch/jobs/execution/partition/completed batch/jobs/execution/step/completed batch/jobs/execution/completed batch/jobs/instance/completed