このフィルターは、とても強力な機能で、何もコーディングを必要とせず、 アプリケーションの終了に対する新しい動作を追加するなどが可能になります。 JVMのコンソール出力の文字列をモニタリング（監視）することで動作し、 該当する文字列が見つかると、いくつでもアクションを実行することができます。

例えば、エラーが発生するとJVMを再起動させます。 あるアプリケーションに「ある状況になると動作を停止する」というバグがあるとします。 このフィルター機能を活用すると、 アプリケーションの問題を解決するまで「停止する」という問題を即に回避することが可能になります。

フィルター定義に利用するプロパティ：

• ［wrapper.filter.trigger.<n>］プロパティ（必須）
• ［wrapper.filter.action.<n>］プロパティ（必須）
• ［wrapper.filter.allow_wildcards.<n>］プロパティ（任意）
• ［wrapper.filter.message.<n>］プロパティ（任意）

フィルター定義として、最低でも、 ［wrapper.filter.trigger.<n>］プロパティや ［wrapper.filter.action.<n>］プロパティを 設定しなければなりません。その他のプロパティは任意に応じて設定します。

各フィルターで、 プロパティ名の「<n>」コンポーネント部には、 「1」からカウントアップしていくインテージャー（整数値）のナンバリング数値を入れて指定します。 デフォルトでは、連番であり欠番で飛ぶことはないはずです。 ［wrapper.ignore_sequence_gaps］ プロパティで、シーケンス内でギャップ（途切れ）検索を「許可する／許可しない」を任意に設定にすることができます。

「<n>」番号の昇順で、定義されたフィルターをスキャンします。 一つのフィルター条件が一致すると、その出力ラインで処理を停止します。

下記に、いろいろなプロパティの使用例をご紹介していますので参照ください:

• シンプル一致
• ワイルドカードの利用
• 複数のアクションを指定する
• 例外に一致させる方法
• 「OutOfMemoryError」検知

対応バージョン :	3.0.0
対応エディション :
対応プラットフォーム :

このプロパティには、トリガー（キッカケになるもの）の文字列を設定します。どんな文字でも可能です。 このプロパティは必須です。

wrapper.filter.trigger.1=Error
wrapper.filter.action.1=RESTART

トリガーにスペースを含む：

フィルタリングされる文字列にはスペース（空白）を含めることができます。 しかし、一般的にコンフィギュレーション・プロパティがロード（読み込み）される処理において、 先頭や末尾にあるスペース（空白）はトリム（切り落とし）されます。

wrapper.filter.trigger.1=  Restart me now.
wrapper.filter.action.1=RESTART

ワイルドカード：

Wrapperバージョン3.5.5から、 ［wrapper.filter.allow_wildcards.<n>］プロパティにTRUEを設定した場合、 トリガー文字にワイルドカード（「*」や「?」）を含めることが可能です。

• 「*」文字は、「0 （ゼロ）」か任意の文字列に相当します。
• 「?」文字は、キッチリ１文字に相当します。

トリガー値は、出力の一行内のどこかに配置されている文字列として検索されますので、 トリガー値の前後に「*」ワイルドカードをつける必要はありません。 もし、そうすると、パターン一致の処理が複雑化し、 「ログ出力の一行の中に指定されたトリガーが見つからない」と判定するまでに時間がかかり、 ログ化パフォーマンスに若干の影響を与えることがあるのでご了解ください。

対応バージョン :	3.0.0
対応エディション :
対応プラットフォーム :

このプロパティには、実行するアクションを指定します。 このプロパティは必須です。

もしアクションが省略されていた場合、デフォルトの ［RESTART］のアクションが実行されます。

wrapper.filter.trigger.1=Error
wrapper.filter.action.1=RESTART

複数のアクションを指定するには、実行値をカンマ区切りで並べて記述します。指定した順番で実行されます。

wrapper.filter.trigger.1=Error
wrapper.filter.action.1=DUMP,RESTART

有効なアクションは次のとおり：

• ［DEBUG］（ver. 3.5.0から） -

  デバッグ・メッセージをログ化します。 これは、アクションの発生を把握できるので、とても役立ちます。

• ［DUMP］（ver. 3.3.6から） -

  スレッド・ダンプを生成します。

• ［GC］（ver. 3.5.7から） - JVMで完全なガベージコレクション掃除を実行します。 完全な掃除をすると、ガベージコレクション中、しばしば全てのスレッドが凍結したりなど引き起こすため、 これを頻繁にするとJVMのパフォーマンスに影響しますのでご理解ください。

• ［RESTART］ -

  現在のJVMを停止して、新しい「起動の試み（invocation）」として再起動します。

• ［SHUTDOWN］ -

  Wrapper同様に、JVMを終了します。

• ［USER_<n>］（ver. 3.5.0から）（プロフェッショナル版） -

  ユーザー定義イベントを発生します。 イベントには、「メール送信」か、 「外部システム・コマンドの実行」か、 どちらかのアクションが可能です。 そのコマンド指定には、クリーンアップ作業から、SNMPトラップ引き上げまで、何でも可能です。

• ［PAUSE］（ver. 3.5.0から） -

  ポーズ（一時停止）が可能でJVMが動作している場合、Javaアプリケーションをポーズ（一時停止）します。 詳しくは［wrapper.pausable］プロパティをご覧ください。

• ［RESUME］（ver. 3.5.0から） -

  ポーズ（一時停止）状態にあるとき、Javaアプリケーションをレジューム（再開）します。 これは、JVMが停止ではなくポーズ（一時停止）している場合に利用可能です。 詳しくは［wrapper.pausable］プロパティをご覧ください。

• ［SUCCESS］ (ver. 3.5.5から) -

  失敗した「起動の試み（invocation）」の内部カウントをリセットして、 現在のJVMの「起動の試み（invocation）」を「成功」とカウントします。 これは、比較的、短い頻度で再起動するように設計されたアプリケーションに便利です。

• ［NONE］ -

  何もアクションを起こしません。 これ以降の高いナンバリング数値で設定されているトリガーを、フィルター検索の対象から除外することができるので、便利です。

対応バージョン :	3.5.5
対応エディション :
対応プラットフォーム :

このプロパティには、［wrapper.filter.trigger.<n>］ プロパティに設定するトリガー文字にワイルドカードを「利用する (TRUE)／利用しない (FALSE)」を設定します。 もしTUREに設定すると、 ［wrapper.filter.trigger.<n>］ フィルターに含まれているワイルドカードを処理します。

wrapper.filter.allow_wildcards.1=TRUE

利用することは構わないのですが、ワイルドカードを含むトリガー文字を検索することは、CPUに負荷を強いることになります。 これは特に長い出力行を伴う場合に、トリガーのワイルドカードがトリガーの冒頭に設定されているとき、顕著に表れます。 同じトリガーの中に複数のワイルドカードを利用すると、 全ての組み合わせでパターン一致を検索することになるため、動作がスローダウンします。

対応バージョン :	3.5.0
対応エディション :
対応プラットフォーム :

このプロパティには、トリガーが発生したとき、ユーザーに表示するメッセージを設定します。 何が起きているのか、ユーザーに説明するのに、とても便利です。 デフォルト値は「Filter trigger matched.」です。

wrapper.filter.trigger.1=java.lang.OutOfMemoryError
wrapper.filter.action.1=RESTART
wrapper.filter.message.1=The JVM has run out of memory.

このセクションでは、トリガーを最大に活かす様々な使用例ご紹介します。

フィルターは、JVMのコンソール出力をモニタリング（監視）することで動作します。 トリガーが例外で発動されるようにするために、 Javaアプリケーションが、コンソールへフィルタリングされたメッセージを表示しなければなりません。

wrapper.filter.trigger.1=Error
wrapper.filter.action.1=RESTART

jvm 1    | The next line should cause the Wrapper to restart the JVM:
jvm 1    |   Error
wrapper  | Filter trigger matched.  Restarting JVM.
wrapper  | Launching a JVM...
jvm 2    | WrapperManager: Initializing...

wrapper.filter.trigger.1=Head*Tail-?
wrapper.filter.allow_wildcards.1=TRUE
wrapper.filter.action.1=RESTART

jvm 1    | The next line should cause the Wrapper to restart the JVM:
jvm 1    |   Head a bunch of stuff, then Tail-1 and some more stuff.
wrapper  | Filter trigger matched.  Restarting JVM.
wrapper  | Launching a JVM...
jvm 2    | WrapperManager: Initializing...

wrapper.filter.trigger.1=User Error
wrapper.filter.action.1=DUMP,RESTART

jvm 1    | The next line should cause the Wrapper to restart the JVM:
jvm 1    |   User Error
wrapper  | Filter trigger matched.  Requesting thread dump.
wrapper  | Dumping JVM state.
wrapper  | Filter trigger matched.  Restarting JVM.
jvm 1    | Full thread dump Java HotSpot(TM) Client VM (1.5.0_24-149 mixed mode, sharing):
jvm 1    | 
jvm 1    | "WrapperSimpleAppMain" prio=5 tid=0x0100f400 nid=0x86c600 waiting on condition [0xb0e8e000..0xb0e8ed90]
jvm 1    | 	at java.lang.Thread.sleep(Native Method)
jvm 1    | ...
jvm 1    | "Exception Catcher Thread" prio=10 tid=0x01001910 nid=0x80ac00 runnable 
wrapper  | Launching a JVM...
jvm 2    | WrapperManager: Initializing...

wrapper.filter.trigger.1=IgnoreError
wrapper.filter.action.1=NONE
wrapper.filter.trigger.2=Error
wrapper.filter.action.2=RESTART

jvm 1    | The next line should be ignored:
jvm 1    |   IgnoreError
jvm 1    | 
jvm 1    | The next line should cause the Wrapper to restart the JVM:
jvm 1    |   Error
wrapper  | Filter trigger matched.  Restarting JVM.
wrapper  | Launching a JVM...
jvm 2    | WrapperManager: Initializing...

wrapper.filter.trigger.1=java.lang.OutOfMemoryError
wrapper.filter.action.1=RESTART

jvm 1    |  186:             6            384  sun.reflect.generics.repository.MethodRepository
jvm 1    |  187:             8            384  java.lang.OutOfMemoryError
wrapper  | The JVM has run out of memory.  Restarting JVM.
jvm 1    |  188:             8            384  java.io.OutputStreamWriter
jvm 1    |  189:             1            376  java.awt.Checkbox

wrapper.filter.trigger.1=Exception in thread "*" java.lang.OutOfMemoryError
wrapper.filter.allow_wildcards.1=TRUE
wrapper.filter.action.1=RESTART
wrapper.filter.message.1=The JVM has run out of memory.

jvm 1    | Mention the java.lang.OutOfMemoryError exception (Not triggered)
jvm 1    | 
jvm 1    | Now thow a new java.lang.OutOfMemoryError to invoke a stack trace:
jvm 1    | Exception in thread "MyApp-Main" java.lang.OutOfMemoryError
wrapper  | The JVM has run out of memory.  Restarting JVM.
jvm 1    |      at com.myapp.Main.doSomething(Main.java:321)
jvm 1    |      at com.myapp.Main.main(Main.java:654)
wrapper  | Launching a JVM...
jvm 2    | WrapperManager: Initializing...

jvm 1    |   wrapper.filter.trigger.1=Exception in thread "*" java.lang.OutOfMemoryError
wrapper  | The JVM has run out of memory.  Restarting JVM.

wrapper.filter.trigger.1=Exception in thread "*" java.lang.OutOfMemoryError
wrapper.filter.action.1=NONE

wrapper.filter.trigger.2=Exception in thread "*" java.lang.OutOfMemoryError
wrapper.filter.allow_wildcards.2=TRUE
wrapper.filter.action.2=RESTART
wrapper.filter.message.2=The JVM has run out of memory.