Tomcatコネクタには、ステータスワーカーと呼ばれる特別な種類のワーカーがあります。ステータスワーカーは、リクエストをTomcatインスタンスに転送しません。代わりに、実行時にステータスと構成情報を取得し、さらに多くの構成項目を動的に変更することを可能にします。これは、シンプルな組み込みWebインターフェースを介して行うことができます。
ステータスワーカーは、ロードバランシングワーカーと組み合わせて使用すると特に強力です。
このドキュメントでは、ステータスワーカーのHTMLユーザーインターフェースについては説明しません。これまでは非常にシンプルなので、そのまま使用してください。このドキュメントでは、ステータスワーカーのあまり明らかでない機能について説明します。また、さまざまなリクエストパラメータとその意味についても完全に網羅し、自動化スクリプトにステータスワーカーを組み込めるようにします。
ステータスワーカーのドキュメントはjk 1.2.20から始まります。
ステータスワーカーは次のアクションを認識しています
ほとんどのアクションで、4つの出力フォーマットから選択できます。
HTMLビューには、HTMLのmeta refreshオプションを介して実装された自動更新機能があります。自動更新を開始すると、UIはedit、update、maintainを除くすべてのアクションでそれを尊重します。これらのいずれかを介してナビゲートしても、他のアクションに戻るとすぐに自動更新が再び開始されます。
HTMLページには、興味のない部分を最小化できる箇所が多数あります。「Hide」リンクがいくつかあり、情報の一部を折りたたむことができます。この機能は、以下の情報ブロックに存在します。
注意: 以下の制限はバージョン1.2.26以降で削除されました。
Apacheモジュールmod_jkは、仮想ホストに関するApache HTTP Serverの内部インフラストラクチャを利用しています。この欠点は、ステータスワーカーが定義されている仮想ホストのURLマップしか表示できないことです。他の仮想ホストの構成オブジェクトに到達することはできません。もちろん、使用している任意の仮想ホストでステータスワーカーを定義できます。URLマップ以外の表示されるすべての情報は、ステータスワーカーが呼び出された仮想ホストに関係なく同じになります。
ステータスワーカーは、構成への変更をログレベル「info」で通常のJKログファイルに記録します。無効なリクエストはログレベル「warn」で記録されます。何か問題のある動作を報告したい場合は、ログファイルの内容を「debug」レベル、または「trace」レベルで取得すると役立ちます。
ステータスワーカーの基本構成は、通常のAJPワーカーの構成と非常によく似ています。ワーカーの名前と、それにマップしたいURLを指定する必要があります。構成の最初の部分はworkers.propertiesファイルで行われます。ここでは、タイプstatusのmystatusという名前のワーカーを定義します。
worker.list=mystatus
worker.mystatus.type=status
/private/admin/mystatus=mystatus
以下のセクションで学習するように、ステータスワーカーは非常に強力です。このURLを保護するために、Webサーバーの通常の認証および認可メソッドを使用する必要があります。
異なる名前とURLマッピングを使用して、ステータスワーカーの複数のインスタンスを定義することもできます。たとえば、それらを個別に構成し、特定のグループの人々に使用を許可したい場合があります。
workers.propertiesエントリには、ステータスワーカーの出力のさまざまな側面をカスタマイズできるいくつかの属性があります。
属性cssは、スタイルシートのURLに設定できます。
worker.mystatus.css=/private/admin/static/mystatus.css
<link rel="stylesheet" type="text/css" href="/private/admin/static/mystatus.css" />
プロパティ出力フォーマットは、属性prefixを介してカスタマイズできます。ステータスワーカーが出力するすべてのプロパティの名前は、このプレフィックスで始まります。デフォルトは「worker」です。
XML出力時にフォーマットに影響を与える属性がいくつかあります。属性nsを使用すると、すべてのステータスワーカー要素に使用される名前空間プレフィックスを設定できます。デフォルトは「jk:」です。「-」に設定すると、名前空間プレフィックスが無効になります。
xmlns属性を使用すると、プレフィックスを名前空間URLにマッピングできます。デフォルト値はxmlns:jk="https://tomcat.dokyumento.jp"です。「-」に設定すると、URLの出力が無効になります。
最後に、doctype属性を介してXMLドキュメントタイプを指定できます。指定された文字列は、XMLヘッダーの直後のドキュメントの冒頭に挿入されます。デフォルトは空です。
選択したステータスワーカーのURLへのアクセスを制御するために、Webサーバーに組み込まれているアクセス制御機能を使用することを強くお勧めします。ただし、ステータスワーカーの2つの構成属性が役立ちます。「read_only」属性は、他のワーカーの構成や実行時ステータスを変更するために使用できるステータスワーカーのすべての機能を無効にします。read_onlyステータスワーカーは、edit、update、reset、またはrecoverアクションへのアクセスを許可しません。デフォルト値はfalse、つまり読み書き可能です。read_onlyを有効にするには、trueに設定する必要があります。
2つのステータスワーカーを構成できます。一方はread_onlyで、より大きな管理者グループに利用できるようにし、もう一方は全機能を利用できますが、少数の人々にのみ使用させることができます。
worker.list=jk-watch
worker.jk-watch.type=status
worker.jk-watch.read_only=true
worker.jk-watch.mount=/user/status/jk
worker.list=jk-manage
worker.jk-manage.type=status
worker.jk-manage.mount=/admin/status/jk
使用できるもう1つの属性はuserです。デフォルトではこのリストは空であり、ユーザーに制限がないことを意味します。userをカンマ区切りのユーザー名リストに設定できます。Webサーバーがリクエストとともにユーザー名を送信するように構成されている場合、ステータスワーカーは、リクエストに添付された名前がそのuserリストに含まれているかどうかをチェックします。
ユーザーリストは、「user」属性の複数の出現に分割することができます。
デフォルトでは、ユーザー名は大文字と小文字を区別して一致します。バージョン1.2.21以降、属性user_case_insensitiveをtrueに設定できます。そうすると、比較は大文字と小文字を区別しなくなります。
ロードバランシングワーカーの場合、ステータスワーカーは興味深い概要情報を表示します。ロードバランサーのメンバーを「good」、「bad」、「degraded」のクラスに分類します。この機能は、外部エスカレーション手順と組み合わせることができます。グローバルなシステム設計と運用慣行によっては、好みの分類が異なる場合があります。
この分類は、ワーカーのアクティベーション状態（active、disabled、stopped）という純粋な構成状態と、実行時状況のみに依存する実行時状態（OKまたはERR、およびサブステートとしてのidle、busy、recovering、probing、forced recovery）に基づいています。
ランタイムのサブステータスは以下の意味を持ちます
デフォルトでは、ステータスワーカーは、「active」のアクティベーションを持ち、サブステートが空の「error」ではないランタイム状態を持つすべてのメンバーを「good」にグループ化します。「bad」グループは、「stopped」のアクティベーションを持つか、サブステートが空の「error」のランタイム状態にあるメンバーで構成されます。
どちらのグループにも当てはまらないワーカーは「degraded」（劣化）と見なされます。
good、bad、degradedへのグループ化に対して、他のルールを定義できます。「good」と「bad」の2つの属性は、単一文字またはドット区切りのペアのカンマ区切りリストで設定できます。各文字は、「active」、「disabled」、「stopped」、「ok」、「idle」、「busy」、「recovering」、「error」のいずれかの可能な状態の最初の文字を表します。追加の状態「probing」と「forced recovery」は常に「recovering」と同等と評価されます。構成状態とランタイム状態をドットで結合する場合、カンマ区切りのエントリは論理「or」で結合されます。それらは論理「and」で結合されます。したがって、「good」のデフォルト値は「a.o,a.i,a.b,a.r」であり、「bad」のデフォルト値は「e,s」です。
ステータスワーカーは最初に「bad」定義との一致を試み、成功しない場合は「good」との一致を試み、最終的に「bad」または「good」のいずれも一致が見つからない場合は「degraded」を選択します。
このセクションは、JKステータス管理インターフェースに基づいた自動化スクリプトの構築に役立つはずです。このインターフェースは、将来的にさらにパラメータを追加することのみを想定しているという意味で安定しています。以前のバージョンからの既存のパラメータは、元のセマンティクスを維持します。また、出力フォーマットであるXML、Properties、およびTextも安定して保持されると予想しています。したがって、自動化スクリプトでステータスワーカーの出力を解析したい場合は、これらを使用してください。
アクションはパラメータcmdによって決定されます。値は「list」、「show」、「edit」、「update」、「reset」、「recover」、「version」、「dump」を取ることができます。cmdパラメータを省略した場合、デフォルトの「list」が使用されます。「list」、「refresh」、「version」、「dump」を除くすべてのアクションには、追加のパラメータが必要です。
アクション「dump」はバージョン1.2.27で追加されました。
フォーマットはパラメータmimeによって決定されます。値は「html」、「xml」、「txt」、「prop」を取ることができます。mimeパラメータを省略した場合、デフォルトの「html」が使用されます。アクション「edit」（編集フォーム）は「mime=html」の場合にのみ意味があります。
単一のワーカーに対して操作するアクションは、そのワーカーを選択するために1つまたは2つの追加パラメータを必要とします。パラメータwには、ワーカーリストからのワーカー名が含まれます。アクションがロードバランサーのメンバー（サブワーカー）に対して操作する場合、パラメータwにはロードバランサーワーカーの名前が含まれ、追加パラメータswにはサブワーカーの名前が含まれます。
自動更新中、パラメータreには更新間隔が秒単位で含まれます。このパラメータを省略すると、自動更新はオフになります。
パラメータoptには、有効なオプションのビットマスクが含まれます。デフォルトは0であり、デフォルトではオプションは有効になっていません。以下のオプションが存在します
ワーカーの設定を変更するには、更新ボタンをクリックして編集アクションを使用できます。しかし、更新アクションに直接呼び出しを行うこともできます。以下のリクエストパラメータには、変更したい構成情報が含まれています。まず、ロードバランサーワーカーのリストです。
先頭の文字「v」はバージョン1.2.27でパラメータに追加されました。AJPワーカーの設定変更もバージョン1.2.27で導入されました。
すべてのパラメータの詳細については、workers.propertiesリファレンスを参照してください。
editアクションを使用すると、ロードバランサーまたはロードバランサーのメンバーのすべての設定をそれぞれ1ページで編集できます。ロードバランサーのすべてのメンバーに対して1つの構成側面を同時に編集したい場合は、パラメータattによってトリガーされます。パラメータの値は、編集したい側面を示します。リストは、前のセクションと同じですが、「vahst」と「vaprt」は除きます: 「vwa」、「vwf」、「vwn」、「vwr」、「vwc」、「vwd」、「vacpt」、「vact」、「vapt」、「vart」、「var」、「varo」、「vabl」、「vamps」。ただし、ここでは、リクエストパラメータ名として使用する代わりに、名前をパラメータattに入れる必要があります。
すべてのロードバランサーメンバーの共通アスペクトの値は、「val0」、「val1」、...という名前のパラメータで指定されます。