Tomcatコネクタには、ステータスワーカーと呼ばれる特別なタイプのワーカーがあります。ステータスワーカーは、Tomcatインスタンスにリクエストを転送しません。代わりに、実行時にステータス情報と構成情報を取得し、さらに多くの構成項目を動的に変更することができます。これは、シンプルな組み込みWebインターフェースを介して行うことができます。
ステータスワーカーは、負荷分散ワーカーと一緒に使用すると特に強力です。
このドキュメントでは、ステータスワーカーのHTMLユーザーインターフェースについては説明しません。今のところ非常にシンプルなので、そのまま使用してください。このドキュメントでは、ステータスワーカーのあまり明確ではない機能について説明します。また、さまざまなリクエストパラメータとその意味について網羅的に説明することで、ステータスワーカーを自動化スクリプトに組み込むことができます。
ステータスワーカーのドキュメントは、jk 1.2.20から始まります。
ステータスワーカーは、以下のアクションを認識します。
ほとんどのアクションでは、4つの出力フォーマットから選択できます。
HTMLビューには、HTMLのメタリフレッシュオプションを介して実装された自動リフレッシュ機能があります。自動リフレッシュを開始すると、UIは編集、更新、メンテナンスを除くすべてのアクションでそれを尊重します。これらのいずれかをナビゲートした場合でも、他のアクションのいずれかに戻るとすぐに自動リフレッシュが再開されます。
HTMLページの多くの部分は、必要がない場合は最小化できます。情報を折りたたむための「非表示」リンクがいくつかあります。この機能は、以下の情報ブロックに対して存在します。
注：バージョン1.2.26以降、以下の制限は削除されました.
Apacheモジュールmod_jkは、バーチャルホストに関する内部Apache HTTP Serverインフラストラクチャを利用します。この欠点は、ステータスワーカーが定義されているバーチャルホストのURLマップのみを表示できることです。他のバーチャルホストの構成オブジェクトにアクセスすることはできません。もちろん、使用している任意のバーチャルホストにステータスワーカーを定義できます。URLマップ以外に表示されるすべての情報は、ステータスワーカーが呼び出されたバーチャルホストに関係なく同じです.
ステータスワーカーは、構成に加えられた変更をログレベル「info」で通常のJKログファイルに記録します。無効なリクエストはログレベル「warn」で記録されます。壊れた動作を報告したい場合は、ログファイルのレベル「debug」または「trace」のコンテンツが役立ちます.
ステータスワーカーの基本構成は、通常のajpワーカーの構成と非常によく似ています。ワーカーの名前と、それにマップするURLを指定する必要があります。構成の最初の部分は、workers.propertiesファイルで行われます。タイプステータスのmystatusという名前のワーカーを定義します.
worker.list=mystatus
worker.mystatus.type=status
/private/admin/mystatus=mystatus
以下のセクションで説明するように、ステータスワーカーは非常に強力です。Webサーバーの通常の認証および承認方法を使用して、このURLを保護する必要があります.
異なる名前と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」は、他のワーカーの構成または実行時ステータスを変更するために使用できるステータスワーカーのすべての機能を無効にします。読み取り専用のステータスワーカーは、編集、更新、リセット、またはリカバリのアクションへのアクセスを許可しません.デフォルト値はfalse、つまり読み取り/書き込みです。読み取り専用を有効にするには、trueに設定する必要があります.
2つのステータスワーカーを構成できます。1つは読み取り専用で、より大きな管理者グループが利用でき、もう1つはすべての機能を使用できますが、より少ない人数でのみ使用できます.
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に設定できます.その後、比較は大文字と小文字を区別せずに実行されます.
負荷分散ワーカーの場合、ステータスワーカーは興味深い概要情報を示します.ロードバランサーのメンバーを「良好」、「不良」、「劣化」のクラスに分類します.この機能は、外部エスカレーション手順と組み合わせることができます.グローバルシステム設計と運用方法によっては、好ましい分類が異なる場合があります.
分類は、ワーカーのアクティベーション状態（アクティブ、無効、または停止）に基づいています。これは純粋な構成状態であり、実行時状態（OKまたはERR。可能なサブ状態はアイドル、ビジー、リカバリ中、プローブ中、および強制リカバリ）は実行時の状況のみに依存します.
ランタイムサブ状態は、次の意味を持ちます.
デフォルトでは、ステータスワーカーは、アクティベーションが「アクティブ」で、ランタイム状態が「エラー」ではなく、サブステートが空であるすべてのメンバーを「良好」にグループ化します。「不良」グループは、アクティベーションが「停止」されているか、ランタイム状態が「エラー」でサブステートが空のメンバーで構成されます。
2つのグループのいずれにも該当しないワーカーは、「劣化」していると見なされます。
良好、不良、劣化へのグループ化について、他のルールを定義できます。2つの属性「good」と「bad」には、単一の文字またはドット区切りのペアのコンマ区切りリストを入力できます。各文字は、「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リファレンスを参照してください。
編集アクションを使用して、ロードバランサーまたはロードバランサーのメンバーのすべての設定を1つのページで編集できます。ロードバランサーのすべてのメンバーの1つの設定アスペクトを同時に編集する場合、これはパラメータattによってトリガーされます。パラメータの値は、編集するアスペクトを示します。リストは、「vahst」と「vaprt」を除いて、前のセクションと同じです。「vwa」、「vwf」、「vwn」、「vwr」、「vwc」、「vwd」、「vacpt」、「vact」、「vapt」、「vart」、「var」、「varo」、「vabl」、「vamps」。ただし、ここでは、リクエストパラメータ名として使用する代わりに、名前をパラメータattに入れる必要があります。
すべてのロードバランサーメンバーの共通アスペクトの値は、「val0」、「val1」、...という名前のパラメータで指定されます。