13.2.4 workers.properties（ワーカ定義ファイル）
- 〈この項の構成〉
(1) 形式
次のようにキーを指定します。
<キー名称> = <値>
- 指定方法
-
-
改行までが値になります。
-
#で始まる行はコメントとみなされます。
-
値が存在しない行を定義した場合，その行は無視されます。キー名称として定義されていないパラメタを定義しても無視されます。
-
「キー名称=値」として1023文字までが有効となります。超えた部分は切り捨てられます。
-
ワーカ名に使用できる文字は半角英数字，アンダースコア「_」，およびハイフン「-」です。これら以外の文字を指定した場合の動作は保証しません。
-
(2) ファイルの格納先
-
Windowsの場合
<Application Serverのインストールディレクトリ>\CC\web\redirector\workers.properties
-
UNIXの場合
/opt/Cosminexus/CC/web/redirector/workers.properties
(3) 機能
ワーカを定義し，ワーカごとにパラメタを設定して，リダイレクタの動作を定義します。
(4) 指定できるキー
ワーカ定義ファイルに指定できるキーと，ワーカごとの定義パラメタについて説明します。
(a) ワーカ定義ファイルに指定できるキー
ワーカ，およびワーカごとの各パラメタを定義します。このキーに不正な値を設定した場合，動作は保証されません。
|
キー名称 |
内容 |
デフォルト値 |
|---|---|---|
|
ワーカ名のリストを指定します。複数ある場合は，コンマ（,）で区切ります。一つ以上のワーカ名を必ず指定する必要があります。 mod_jk.conf（HTTP Server用リダイレクタ動作定義ファイル），またはuriworkermap.properties（Microsoft IIS用マッピング定義ファイル）で指定するワーカ名を指定します。 |
なし |
|
|
ワーカごとの定義パラメタを指定します。worker.listに記述されたワーカごとに設定します。 定義パラメタについては，「13.2.4(4)(b) ワーカごとの定義パラメタ」を参照してください。 |
なし |
(b) ワーカごとの定義パラメタ
|
定義できるパラメタ |
内容 |
デフォルト値 |
関連情報 |
|---|---|---|---|
|
負荷分散の対象となるワーカのリストを指定します。複数ある場合は，コンマ（,）で区切ります。 |
なし |
||
|
リダイレクタで再利用するワーカとのコネクション数を，1〜2147483647の整数で指定します。なお，このパラメタはWindows用です。 ワーカとのコネクションは，この設定値以内の場合はリダイレクタ内に保持し，該当ワーカへの通信に再利用され，接続先のJ2EEサーバが終了するまで解放しません。リクエストの多重度が設定値を超えた場合は，設定値を超えたリクエストだけをリクエスト単位にワーカとのコネクションの確立，解放を行います。 この値は次に示す式に従ってメモリを消費します。 （式） メモリ消費量=（worker.<ワーカ名>.cachesizeの値）×10KB |
64 |
||
|
デフォルトワーカのワーカ名を指定します。POSTリクエスト転送先ワーカに指定したワーカと同じワーカを指定した場合，指定したワーカには，POSTデータサイズによる振り分け条件を満たすリクエスト，およびデフォルトワーカとして条件を満たすリクエストが転送されます。 なお，このパラメタにPOSTリクエスト転送先ワーカに指定していないワーカを指定し，そのワーカにworker.<ワーカ名>.post_dataが指定されている場合，worker.<ワーカ名>.post_data定義は無視されます。 ワーカ名の前後の空白文字（スペース，タブ，およびフォームフィード）は無視されます。 このパラメタの指定を省略した場合や空文字列を指定した場合など，転送条件を満たすワーカが存在しないリクエストに対してエラーが返されます。 |
なし |
||
|
エラーページの委任機能を利用するエラーステータスコードを指定します※1。複数指定する場合はコンマ（,）で区切って指定します。 |
なし |
||
|
ワーカのホスト名，またはIPアドレスを指定します。 |
なし |
||
|
リクエストの負荷分散値を指定します。設定する値は0よりも大きくしてください。なお，値として小数値を指定することもできます。 |
1 |
||
|
ワーカのポート番号を，1〜65535の整数で指定します。 すでにほかのアプリケーションで使用，または確保されているポート番号は指定できません。 |
なし |
||
|
<ワーカ名>に指定したワーカに転送するリクエストのContent-Lengthヘッダの値の上限値に1を加えた値を次のように指定します。
Content-Lengthヘッダの値が指定値未満のリクエストを，<ワーカ名>に指定したワーカに転送します。 worker.<ワーカ名>.post_size_workersパラメタに複数のワーカを設定している場合，リクエストのContent-Lengthヘッダの値が指定値未満，かつ指定値が最も小さいワーカにリクエストは転送されます。 worker.<POSTリクエスト振り分けワーカのワーカ名>.post_size_workersパラメタで指定した，ほかのワーカと同じ値は設定しないでください。 値の前後の空白文字（スペース，タブ，フォームフィード）は無視されます。 |
なし |
||
|
POSTリクエスト転送先ワーカのワーカ名のリストを指定します。複数指定する場合は，コンマ（,）で区切って指定します。ただし，同じワーカ名は指定できません。 ワーカ名の前後の空白文字（スペース，タブ，フォームフィード）は無視されます。 |
なし |
||
|
通信タイムアウト値を指定します。レスポンスデータを待つ時間を0〜3600の整数値（単位：秒）で指定します。0を指定した場合，レスポンスを受け取るまで待ち続け，通信タイムアウトにはしません。 |
3600 |
||
|
ワーカのタイプを次に示すタイプから指定します。タイプごとの設定できるパラメタについては，「13.2.4(4)(c) worker.<ワーカ名>.typeごとの定義パラメタ」を参照してください。なお，このパラメタはワーカごとに必ず指定する必要があります。
|
なし |
- 注※1
-
指定できるコードがコメント文で記載されています。必要に応じてコメントを外してください。
- 注※2
-
複数のワーカで同一のWebコンテナのホスト名およびポート番号を指定することもできます。
(c) worker.<ワーカ名>.typeごとの定義パラメタ
|
定義できるパラメタ |
ワーカのタイプ |
||
|---|---|---|---|
|
ajp13 |
lb |
post_size_lb |
|
|
worker.<ワーカ名>.balanced_workers |
× |
○ |
× |
|
worker.<ワーカ名>.cachesize※1 |
△ |
× |
× |
|
worker.<ワーカ名>.default_worker |
× |
× |
△ |
|
worker.<ワーカ名>.delegate_error_code |
△ |
× |
× |
|
worker.<ワーカ名>.host |
○ |
× |
× |
|
worker.<ワーカ名>.lbfactor |
△ |
× |
× |
|
worker.<ワーカ名>.port |
○ |
× |
× |
|
worker.<ワーカ名>.post_data |
×/○※2 |
× |
× |
|
worker.<ワーカ名>.post_size_workers |
× |
× |
○ |
|
worker.<ワーカ名>.receive_timeout |
△ |
× |
× |
- （凡例）
-
○：必ず指定します。
△：任意に指定します。
×：指定できません。
- 注1
-
ajp12で指定できるパラメタは，ajp13と同じです。
- 注2
-
UNIXの場合，必ず指定する項目に値を指定しなかったとき，または指定した値が不正のとき，HTTP Serverは起動しません。
- 注※1
-
Windowsの場合だけ有効です。UNIXの場合，パラメタは無視されます。
- 注※2
-
POSTリクエスト転送先ワーカでは必須です。
(5) 記述例
worker.list=worker1 worker.worker1.port=8007 worker.worker1.host=localhost worker.worker1.type=ajp13 #worker.worker1.cachesize=64 #worker.worker1.receive_timeout=3600 #worker.worker1.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510 #---------------------------------------------------------------- # Example setting for Loadbalancer. #---------------------------------------------------------------- #worker.list=loadbalancer1 # #worker.loadbalancer1.type=lb #worker.loadbalancer1.balanced_workers=worker1,worker2 # #worker.worker1.port=8007 #worker.worker1.host=host1 #worker.worker1.type=ajp13 #worker.worker1.cachesize=64 #worker.worker1.lbfactor=1 #worker.worker1.receive_timeout=3600 #worker.worker1.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510 # #worker.worker2.port=8007 #worker.worker2.host=host2 #worker.worker2.type=ajp13 #worker.worker2.cachesize=64 #worker.worker2.lbfactor=1 #worker.worker2.receive_timeout=3600 #worker.worker2.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510 #---------------------------------------------------------------- # Example setting for post data size based worker. #---------------------------------------------------------------- #worker.list=postsizelb1#worker.postsizelb1.type=post_size_lb #worker.postsizelb1.post_size_workers=worker1,worker2 #worker.postsizelb1.default_worker=worker1 # #worker.worker1.port=8007 #worker.worker1.host=host1 #worker.worker1.type=ajp13 #worker.worker1.post_data=100m #worker.worker1.receive_timeout=3600 #worker.worker1.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510 # #worker.worker2.port=8007 #worker.worker2.host=host2 #worker.worker2.type=ajp13 #worker.worker2.post_data=2048m #worker.worker2.receive_timeout=3600 #worker.worker2.delegate_error_code=400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,422,423,424,500,501,502,503,504,505,507,510
(6) 注意事項
このファイルを編集してリダイレクタのユーザ定義を変更した場合，Webサーバを再起動する必要があります。変更した定義は，Webサーバを再起動したあとに反映されます。