サイト内の現在位置を表示しています。

起動トリガ(テキストログ監視)を使ってみよう

JobCenter Lab vol.15

こんにちは。
WebSAM JobCenter ブログ担当の坂本です。

今回はテキストログに特定の文字列が出力されたらジョブネットワーク(JNW)を実行する機能である「起動トリガ(テキストログ監視)」の利用例を2つご紹介します。

<利用例>

  • 業務アプリケーション異常時に特定のJNWを実行する
  • JNWの実行が遅延したらメール通報する
まずは起動トリガの概要から説明します。

  • 「起動トリガ(テキストログ監視)」はWebSAM JobCenter R15.1以降で実装されている機能です
  • 利用例はWebSAM JobCenter MGがWindows版の例となります

起動トリガ(テキストログ監視)とは

起動トリガ(テキストログ監視)とはテキストログを10秒間隔で監視し、特定の文字列が出力された場合に設定したJNWを実行する機能です。

起動トリガ(テキストログ監視)の概要

画面イメージ
  1. マネージャ上のテキストログを定期的に監視し、特定の文字列が出力されていないか監視します。
  2. テキストログに特定の文字列が出力されたら予め設定したJNWを実行します。

業務アプリケーション異常時に特定のJNWを実行する

それでは実際の設定例を見ていきましょう。
業務アプリケーションのエラーログを監視して「…error…月次…」という文字列がテキストログに含まれていた場合に特定のJNW(業務アプリケーションの再実行や情報採取等)を実行する起動トリガを作成してみましょう。業務アプリケーションのログファイル名は「C:\log\業務ログ.log」、ローテーションしたログファイル名を「業務ログn.log」(nは数値)とします。

  • 1.
    WebSAM JobCenter CL/Winを起動し、ユーザフレームの「起動トリガ一覧」を 選択します。
  • 2.
    右クリックし「新規作成」を選択します。
  • 3.
    「起動トリガの作成」画面で名前を入力しOKボタンを押します。

画面イメージ

  • 4.
    作成した起動トリガをダブルクリックし、「起動トリガ(テキストログ監視)の設定」画面を開きます。
  • 5.
    「監視対象テキストログの設定」をクリックします。
  • 6.
    「新規」をクリックします。
  • 7.
    監視対象テキストログの定義を行います。

画面イメージ

  • ローテーションルールには正規表現が指定可能です
    「^業務ログ(¥d+)?¥.log$」と入力してください
  • ローテーションルールを設定しない場合、ログファイルが切り替わる際に発生するログを検知できない場合があります

  • 8.
    「起動トリガ(テキストログ監視)の設定」画面で監視するメッセージの設定を行います。

画面イメージ

  • 監視キーワードにも正規表現が指定可能です
  • 「.*error.*月次.*」と入力してください

  • 9.
    「関連JNW」タブで実行するJNWを追加します。下記の例では実行するJNWをあらかじめ準備していた「リカバリジョブ」としています。

イメージ図

  • 10.
    監視対象のログにテストログを追記してJNWが実行するか確認してみましょう。下記は2行ログを追記した例となります。

画面イメージ

  • 11.
    JNW実行の確認はユーザフレームの「トラッカ一覧」から確認します。テストログを2行記載したので2回JNWが実行していることが分かります。

画面イメージ

JNWの実行が遅延したらメール通報を行う

次に起動トリガ(テキストログ監視)を応用した使い方をご紹介します。

JNW実行の遅延が発生したらログを出力し、そのログを起動トリガ(テキストログ監視)で監視してメール送信を行います。

画面イメージ

① 超過警告をONにしたJNWを実行します
② ①で実行したJNWが遅延した場合にログが出力されます
③ 起動トリガ(テキストログ監視)でログを監視します
④ 超過警告のログを検知した場合にメール送信JNWを実行します


手順は以下の通りです。

<ログの出力設定>
  • 1.
    WindowsのスタートメニューからWebSAM JobCenterの「サーバの環境設定」を起動し、サーバ環境設定画面を開きます。
  • 2.
    サーバ環境設定画面の左ペイン「サイト」を選択し、右ペインのサイト「(Local)」を右クリックし、「プロパティ」をクリックします。
  • 3.
    タブ「ログ」にて、テキストログの出力設定を行います。

画面イメージ

  • [ログファイルを出力する]にチェックを入れます
  • [ファイル名]に出力するログファイル名をフルパスで入力します
    ここでは「C:¥log¥jobcenter.log」を指定します
  • [イベント名]の[JNW_OVT]( JNWの予定時間超過)にチェックを入れます
  • 設定が完了したら[OK]をクリックします。

  • 4.
    サーバ環境設定画面の左ペイン「サイト」を選択し、右ペインのサイト名「(Local)」を右クリックし「停止」した後、「起動(サービス)」してください。

<超過警告の設定>
  • 5.
    WebSAM JobCenter CL/Winを起動し、ユーザフレームの「ジョブネットワーク一覧」で超過警告を行う該当のJNWを右クリックして「パラメータ」を選択します。
  • 6.
    「予想実行時間」を選択し、「超過警告」を「ON」に設定してください。「指定方法」は「直接指定」、「前回実績」、「下位累積」の中から選択してください。

画面イメージ

<起動トリガ(テキストログ監視)の設定>

  • 7.
    次に起動トリガ(テキストログ監視)の設定を行います。ユーザフレームの「起動トリガ一覧」を選択します。
  • 8.
    右クリックし「新規作成」を選択します。
  • 9.
    起動トリガの作成で名前(「予定時間超過」とします)を入力しOKボタンを押します。
  • 10.
    作成した起動トリガをダブルクリックし、「起動トリガ(テキストログ監視)の設定」画面を開きます。
  • 11.
    「監視対象テキストログの設定」をクリックします。
  • 12.
    「新規」をクリックします。
  • 13.
    監視対象テキストログの定義を行います。「3」で設定したログファイルをファイルパスに指定します。

画面イメージ

  • ローテーションルールには「^ログファイル名(¥.bak¥d+)?$」 と入力してください

  • 14.
    起動トリガ(テキストログ監視)の設定画面で監視するメッセージを正規表現で指定します。監視キーワードには「.*JNW_TOTAL_TIME_EXCEEDED.*」と入力してください。また「部分一致した文字列を環境変数に設定する」にチェックを入れてください。

画面イメージ

<メール送信JNWの設定>

  • 15.
    メール送信を行うJNWを作成します。メール送信JNWを作成するためにはカスタムジョブのアップロードを行う必要があります。WebSAM JobCenter CL/Winへ ログインし、[ファイル]-[Helper機能]-[アップロード]を選択します。
  • 16.
    WebSAM JobCenterメディア内の
    「TEMPLATE\JAPANESE\EXTENDED_CUSTOM_JOB\customjob_templates_mail_ja.jpf」を選択しアップロードします。
  • 17.
    マネージャフレームの「カスタムジョブ定義一覧」にメール送信部品が表示されます。

画面イメージ

  • 18.
    ユーザフレームでJNWを作成し、メール送信部品を配置します。オブジェクトか ら「カスタムジョブ」を選択し、「sendmail」を選択します。

画面イメージ

  • 19.
    メール送信部品を右クリックして「パラメータ」の「カスタムパラメータ設定」タブを選択し、必要なパラメータを入力してください。

画面イメージ

  • 20.
    メール送信部品のスクリプトにメール本文を記載してください。環境変数” NSJNW_TRG_LOG_MATCH_LINE”を利用することでログの内容をメール内容に記載することができます。メール送信部品で環境変数を利用する場合は{{#getenv}}環境変数名{{/getenv}}と記述してください。

<スクリプト例>

画面イメージ

  • 21.
    次にメール送信部品用のキューを作成します。NQSフレーム画面からバッチキューを作成し、キューパラメータでCustomを「ON」に設定してください。

画面イメージ

  • 22.
    「21」で作成したキューをメール送信JNWに設定します。カスタムジョブを右クリックしてパラメータを選択し、投入キューを設定します。下記はキュー名が「mail」の場合の例です。

画面イメージ

  • 23.
    起動トリガ(テキストログ監視)の「関連JNW」タブをクリックし、作成したメール送信JNWを追加します。下記はJNW名が「メール送信」の場合の例です。

画面イメージ

<動作確認>

  • 24.
    それでは動作確認をしてみましょう。実行遅延を発生させるため一時的にパラメータ設定を変更します。実行遅延監視を行う該当のJNWを右クリックして「パラメータ」を選択します。
  • 25.
    「予想実行時間」項目を「直接指定」、「1秒」に設定してください。

画面イメージ

  • 26.
    実行遅延監視を行う該当のJNWを即時実行し、「トラッカ一覧」でメール送信JNWが実行され、メール送信が行われるか確認してください。

画面イメージ

おわりに

今回のブログはいかがでしたでしょうか?
起動トリガ(テキストログ監視)を利用することで出力されたログ内容に応じたJNWの実行が可能ですのでお試しください。

本ブログは皆様から頂いた様々なお問合せを参考にして更新しております。今後も皆様のお役に立つ情報を発信して行きたいと考えておりますのでWebSAM JobCenterブログをよろしくお願いいたします。

[参考情報]
https://jpn.nec.com/websam/jobcenter/download.html
 ⇒WebSAM JobCenter 基本操作ガイド
 ⇒WebSAM JobCenter 環境構築ガイド
 ⇒WebSAM JobCenter 拡張カスタムジョブ部品利用の手引き

お問い合わせ

当ブログに関するお問い合わせは、WebSAM JobCenterお問い合わせ窓口までお問い合わせください。