Apache MPM 共通ディレクティブ

AcceptMutex ディレクティブ

AcceptMutex ディレクティブは、 ネットワークソケットのリクエストを accept しようとしている複数の子プロセスを Apache が直列化するために使う方法を設定します。 Apache 2.0 以前は、このメソッドはコンパイル時にのみ選択できました。 最適な方法は、アーキテクチャやプラットホームに大きく依存します。 詳細に関しては、性能のチューニング ドキュメントをご覧下さい。

このディレクティブが Default に設定されていれば、コンパイル時に選択されたデフォルト値が使われます。 他の使用可能なメソッドの一覧は下にあります。 全てのメソッドが全てのプラットホームで使用可能であるわけではない、 ということに注意してください。 使用可能でないメソッドが指定された場合は、 使用可能なメソッドの一覧を含んだメッセージが エラーログに出力されます。

flock

LockFile ディレクティブで定義したファイルのロックに、 flock(2) システムコールを使います。

fcntl

LockFile ディレクティブで定義したファイルのロックに、 fcntl(2) システムコールを使います。

posixsem

排他処理の実装に POSIX 互換セマフォを使用します

pthread

POSIX Threads (PThreads) 規格で実装されている POSIX 排他処理を使います。

sysvsem

排他処理の実装に SySV 形式のセマフォを使います。

コンパイル時にシステムのデフォルトに選ばれたものが何かを見たい場合は、 LogLevel を debug に設定するとよいでしょう。デフォルトの AcceptMutex が ErrorLog に書き込まれます。

ChrootDir ディレクティブ

このディレクティブの解説文書は まだ翻訳されていません。英語版をご覧ください。

CoreDumpDirectory ディレクティブ

Apache がコアダンプする前に移動を試みるディレクトリを制御します。 デフォルト値は ServerRoot ディレクトリですが、このディレクトリはサーバの実行されているユーザ権限で 書き込み可能であるべきではないので、通常はコアダンプは書き込まれません。 デバッグのためにコアダンプが必要であれば、 このディレクティブを使って他の位置にコアダンプを書き出すようにできます。

EnableExceptionHook ディレクティブ

安全上の理由から、--enable-exception-hook configure オプションを有効にした場合にのみ、このディレクティブを利用できます。 外部モジュールをプラグインして、子がクラッシュした後に何か実行できるような フックを有効にします。

このような外部モジュールは、既に二つ存在していて、 mod_whatkilledus と mod_backtrace がこのフックを活用します。これらの詳細については Jeff Trawick さんの EnableExceptionHook site を参照してください。

GracefulShutdownTimeout ディレクティブ

GracefulShutdownTimeout には サーバーが "graceful-stop" シグナルを受け取ってから現在の リクエストの処理を最大で何秒間続けるかを指定します。

この値をゼロに設定すると、処理中として残っているリクエストが 全て完了するまでサーバーは終了しません。

Group ディレクティブ

Group ディレクティブで、 リクエストに応答する際に所属しておくグループを設定します。 このディレクティブを使用するためには、 サーバは最初に root 権限で起動されている必要があります。 非 root ユーザでサーバを起動した場合は、指定したグループに変化できずに、 結果的に起動したユーザの属するグループで実行されることになります。 unix-group は次のうちのいずれかです:

グループ名

グループを名前で参照します

# に続いてグループ番号

グループを番号で参照します。

サーバを実行するために特定の新しいグループを設定することを お薦めします。nobody を使用する管理者もいますが、 可能であったり望ましい訳では必ずしもありません。

特記事項: このディレクティブを <VirtualHost> で使用することはサポートされなくなりました。Apache 2.0 で suexec を設定したい場合は、 SuexecUserGroup を使用してください。

Listen ディレクティブ

Listen ディレクティブは Apache が特定の IP アドレスやポート番号だけを listen するように指定します。 デフォルトでは全ての IP インターフェースのリクエストに応答します。 Listen ディレクティブは 現在は必須のディレクティブとなりました。 もし設定ファイルになければ、サーバは起動に失敗します。 これは以前のバージョンの Apache から変更のあった部分です。

Listen ディレクティブでは、特定のポートあるいは アドレスとポートの組み合わせから入ってくるリクエストに対して 応答するように指定します。 もしポート番号だけが指定された場合は、サーバは全インターフェースの 指定されたポート番号に対して listen します。 IP アドレスがポートとともに指定された場合は、 サーバは指定されたポートとインターフェースに対して listen します。

複数のアドレスとポートに対して listen するように、 複数の Listen ディレクティブを使うこともできます。 サーバは列挙されたアドレスとポート全てからのリクエストに対して 応答します。

例えば、サーバが 80 番ポートと 8000 番ポートの両方の コネクションを受け入れる場合は、次のようにします。

二つの特定のインターフェースとポート番号からのコネクションを 受け入れるようにするには、次のようにします。

IPv6 アドレスは角括弧で囲まなければなりません。 例えば次の例のようにです。

protocol オプション引数は通常の設定では必要ありません。 無指定の場合、443 番ポートには https が、他のポートには http がデフォルト値として使用されます。 protocol 指定は、どのモジュールがリクエストを処理するかを決定し、 AcceptFilter によるプロトコル特有の最適化を行うようにします。

非標準なポートで運用している際にのみ protocol 指定が必要になります。 たとえば https なサイトを 8443 番ポートで運用している場合 :

参照

• DNS の問題
• Apache が使用するアドレスとポートの設定

ListenBackLog ディレクティブ

保留状態のコネクションのキューの最大長です。 一般的には調整する必要はありませんし、調整は望ましくありません。 しかし、TCP SYN フラッドアタックの状況下におかれる場合に、 増やした方が望ましいシステムもあります。 listen(2) システムコールのバックログパラメータを ご覧下さい。

この値は OS により、小さな数に抑えられます。 値は OS 毎に異なっています。また多くの OS では、 バックログとして指定されている値ちょうどまで使っているわけではなく、 設定されている値に基づいて (通常は設定値よりも大きな値を) 使っていることに注意してください。

LockFile ディレクティブ

AcceptMutex が fcntl や flock に設定されて使用されている場合に、使用されるロックファイルへのパスを LockFile ディレクティブで設定します。 このディレクティブは通常はそのままにしておきます。 主に logs ディレクトリが NFS でマウントされている場合などに値を変えます。 なぜならロックファイルはローカルディスクに 保存されなければならないからです。 メインサーバプロセスの PID がファイル名に自動的に付加されます。

参照

• AcceptMutex

MaxClients ディレクティブ

MaxClients ディレクティブは、 応答することのできる同時リクエスト数を設定します。 MaxClients 制限数を越えるコネクションは通常、 ListenBacklog ディレクティブで設定した数までキューに入ります。 他のリクエストの最後まで達して子プロセスが空くと、 次のコネクションに応答します。

スレッドを用いないサーバ (すなわち prefork) では、MaxClients は、リクエストに応答するために起動される 子プロセスの最大数となります。 デフォルト値は 256 で、これを増加させたい場合は、 ServerLimit の値も増加させる必要があります。

スレッドを用いるサーバや、ハイブリッドサーバ (すなわち beos worker) では、MaxClients は、クライアントに応答できるスレッドの総数を制限します。 beos でのデフォルト値は 50 です。 ハイブリッド MPM でのデフォルト値は 16 ServerLimit の 25 倍 (ThreadsPerChild) です。 MaxClients を 16 プロセス以上必要な値まで増加させたい場合は、 ServerLimit も増加させる必要があります。

MaxMemFree ディレクティブ

MaxMemFree ディレクティブは free() が呼ばれない限り、 主アロケータが保持できる空のメモリの最大値をキロバイト単位で設定します。 設定されていないか、零に設定されているときは、無制限になります。

MaxRequestsPerChild ディレクティブ

MaxRequestsPerChild ディレクティブは、 個々の子サーバプロセスが扱うことのできるリクエストの制限数を 設定します。MaxRequestsPerChild 個のリクエストの後に、子プロセスは終了します。 MaxRequestsPerChild が 0 に設定されている場合は、プロセスは期限切れにより終了することはありません。

MaxRequestsPerChild を非ゼロに制限することには、二つの利点があります:

• (偶発的な) メモリーリークが起こった場合に プロセスが消費するメモリの総量を制限できる
• プロセスに有限のライフタイムを設定することで、 サーバ負荷が下がった時にプロセス数を少なくすることができる

MaxSpareThreads ディレクティブ

アイドルなスレッドの最大数です。異なる MPM ではそれぞれ、 このディレクティブは異なる取り扱われ方をされます。

worker では、 デフォルトは MaxSpareThreads 250 です。 この MPM はアイドルスレッド数をサーバ全体で監視します。 サーバでアイドルスレッド数が多すぎる場合は、 この数字よりも少ない数になるまで子プロセスを終了します。

mpm_netware では、 デフォルトは MaxSpareThreads 100 です。 この MPM はシングルプロセスで実行されますので、 スペアスレッド数もサーバ全体で勘定します。

beos と mpmt_os2 は mpm_netware と似た挙動をします。 beos でのデフォルト値は MaxSpareThreads 50 です。mpmt_os2 でのデフォルト値は 10 です。

参照

• MinSpareThreads
• StartServers

MinSpareThreads ディレクティブ

リクエストに応答するスレッド数の最小値です。 異なる MPM ではそれぞれ、 このディレクティブは異なる取り扱われ方をします。

worker では、 デフォルトは MinSpareThreads 75 で、 アイドルスレッド数をサーバ全体で監視します。 もしサーバに十分な数のアイドルスレッドがなければ、 アイドルスレッド数がこの数よりも大きくなるまで 新しい子プロセスが生成されます。

mpm_netware では、 デフォルトは MinSpareThreads 10 で、 シングルプロセス MPM ですので、サーバ全体で管理されます。

beos と mpmt_os2 は、 mpm_netwareによく似ています。 beos でのデフォルトは MinSpareThreads 1 です。mpmt_os2 でのデフォルトは 5 です。

参照

• MaxSpareThreads
• StartServers

PidFile ディレクティブ

PidFile ディレクティブで、 デーモンのプロセス ID をサーバが記録するファイルを設定します。 ファイル名が絶対パスでない場合は、 ServerRoot からの相対的なものとして扱われます。

サーバが ErrorLog や TransferLog を閉じて開き直したり、設定ファイルを 再読込したりさせるために、サーバにシグナルを送ることができると 便利なことがあります。 これは SIGHUP (kill -1) シグナルを PidFile に書かれているプロセス ID に送ることでできます。

PidFile には、ログファイルの設置位置や セキュリティ と全く同じ注意点があります。

ReceiveBufferSize ディレクティブ

サーバは TCP 受信バッファサイズを指定されたバイト数に設定します。

0にした場合、OS のデフォルト値が使用されます。

ScoreBoardFile ディレクティブ

Apache は親プロセスと子プロセス間の通信にスコアボードを用います。 この通信機能にファイルを必要とするアーキテクチャもあります。 ファイルが指定されていなければ、Apache はまずメモリ上 (匿名共有メモリ) にスコアボードを作ろうとし、それが失敗すると ディスク上にファイル (ファイルベースの共有メモリ) を作ろうとします。 このディレクティブを指定すると、Apache は必ずディスクにファイルを生成します。

ファイルベースの共有メモリは、サードパーティー製のアプリケーションで スコアボードに直接アクセスする必要がある場合に役に立ちます。

ScoreBoardFile を使う場合、 RAM ディスク上に置くとスピードが向上するでしょう。 しかし、ログファイルの設置位置や セキュリティ と同様の注意点があるので、注意してください。

参照

• Apache の停止と再起動

SendBufferSize ディレクティブ

サーバは TCP 送信バッファサイズを指定されたバイト数に設定します。 高速で高レイテンシな環境で (例 100ms 程度、大陸横断高速通信路など) 古い一般的な OS のデフォルト値を増やすのに非常に便利です。

0にした場合、OS のデフォルト値が使用されます。

ServerLimit ディレクティブ

prefork MPM の場合は、このディレクティブは Apache プロセス稼働中における MaxClients に設定可能な上限値を設定することになります (訳注: prefork の場合は同時クライアント数 = サーバプロセス数なので) 。 worker MPM の場合には、このディレクティブは ThreadLimit ディレクティブと組み合わせて、 Apache プロセス稼働中における MaxClients に設定可能な上限値を設定することになります。 再起動中にこのディレクティブを変更しても無視されますが、 MaxClients は再起動中に修正することができます。

このディレクティブを使用する際は特に注意してください。 ServerLimit が必要以上に大きな値に 設定された場合は、余計な未使用共有メモリが割り当てられます。 ServerLimit と MaxClients がシステムの扱える範囲を越えた設定値になっていると、 Apache は起動しないか、起動しても不安定になるでしょう。

prefork MPM では、 MaxClients を 256 (デフォルト) よりも大きな値に設定する必要がある時にだけ使用してください。 希望の MaxClients 数とくらべて、必要以上に大きな値を指定することは避けてください。

worker MPM では、 MaxClients と ThreadsPerChild の設定で 16 サーバプロセス (デフォルト) 以上必要になる場合にのみ使用してください。希望の MaxClients と ThreadsPerChild とくらべて、必要となるサーバプロセス数以上に大きな値を 設定することは避けてください。

参照

• Apache の停止と再起動

StartServers ディレクティブ

StartServers ディレクティブは、 起動時に生成される子サーバプロセスの数を設定します。 プロセス数は負荷に応じて動的に制御されますので、 通常はこの値を調整する理由はあまりないでしょう。

デフォルト値は MPM ごとに異なります。 worker は StartServers 3 です。 prefork は 5 で、 mpmt_os2 は 2 です。

StartThreads ディレクティブ

起動時に生成されるスレッドの数です。 スレッド数は負荷に応じて動的に制御されますので、 通常はこの値を調整する理由はあまりないでしょう。

mpm_netware でのデフォルトは StartThreads 50 で、 この場合プロセスは一つしかないので、 起動時にリクエストに応答するスレッドの総数となります。

beos でのデフォルトは StartThreads 10 です。 また、起動時に生成されるスレッドの総数にも反映されます。

ThreadLimit ディレクティブ

このディレクティブは Apache プロセス稼働中における ThreadsPerChild に設定可能な上限値を設定します。再起動時にこのディレクティブの値を 変更しても無視されますが、 ThreadsPerChild は再起動中に、このディレクティブで指定された上限値まで 変更することができます。

このディレクティブを使用する際は特に注意してください。 ThreadLimit が ThreadsPerChild よりもずっと大きな値に設定された場合は、 余計な未使用共有メモリが割り当てられてしまいます。 ThreadLimit が ThreadsPerChild の両方がシステムの扱える範囲を超えている場合は、 Apache は起動しないか、起動したとしても不安定になるでしょう。 このディレクティブの値は今使用している Apache の ThreadsPerChild の予想上限値を 超えた値には設定しないでください。

ThreadLimit のデフォルト値は mpm_winnt のときは 1920 で、 他の場合は 64 です。

ThreadsPerChild ディレクティブ

このディレクティブは、それぞれの子プロセスで生成される スレッド数を設定します。 子プロセスは開始時にこれらのスレッドを生成して、 その後は生成しません。mpm_winnt のような、 子プロセスが一つしかないような MPM を利用しているのであれば、 この値はサーバの負荷全体を十分取り扱える程度に、 大きくなければなりません。worker のような、 子プロセスが複数あるような MPM を利用しているのであれば、 サーバの通常負荷を十分扱える程度に、 スレッド総数が多くなければなりません。

mpm_winntでの ThreadsPerChild のデフォルト値は 64 で、他の場合は 25 です。

ThreadStackSize ディレクティブ

クライアントコネクションを受け持ち、コネクション処理に必要なモジュールの 呼び出しを行なっているスレッドの、(自動変数用の) スタックサイズは ThreadStackSize ディレクティブで指定します。 大抵の場合 OS の指定しているスタックサイズのデフォルト値は 適切なものですが、調整が必要になる場合もあります:

• スレッドスタックサイズのデフォルト値が比較的小さく設定されている プラットホーム (例えば HP-UX) では、自動変数用の領域で大きな容量を 使用するサードパーティ製モジュールのために Apache がクラッシュする 場合もあります。そのモジュールは他のプラットホームでは スタックサイズが大きいために、快調に動作するかもしれません。 このタイプのクラッシュは、ThreadStackSize で OS のデフォルト値より大きな値を指定することで解決します。 サードパーティ製モジュールでこの処置が必要であると記載されている 場合か、Apache の出力するメッセージでスレッドスタックサイズが 小さすぎると指摘されている場合にのみ、この調整をしてください。
• デフォルトスレッドスタックサイズが、Web サーバ用途に必要な量よりも 明らかに大きすぎる場合、ThreadStackSize を OS のデフォルト値よりも小さな値にすることで、子プロセスあたりの スレッド数をより多く持たせられるようになります。 このタイプの調整は、テスト環境でウェブサーバを完全に テストできる場合に限って行なうべきです。 まれに多数のスタックが要求されるリクエストを受けることがあるかも しれないからです。 Web サーバの設定を変更すると、現在の ThreadStackSize の設定が取り消される場合があります。

User ディレクティブ

User ディレクティブは サーバがリクエストに応答する際に用いるユーザ ID を設定します。 このディレクティブを使用するためには、スタンドアロン型の サーバは最初に root 権限で起動されている必要があります。 非 root ユーザでサーバを起動した場合は、 権限の低いユーザへと変わることができず、 結局元のユーザのプロセスとして実行され続けます。 root で起動した場合に親プロセスが root として実行されているのは正常な動作です。 Unix-userid は次のどれかです。

ユーザ名

ユーザを名前で参照します。

# に続いてユーザ番号

ユーザを番号で参照します。

このユーザは、外部に見せるように意図していないファイルに、 アクセス可能になってしまうような権限を持つべきではないですし、 同様に HTTP リクエストに対して応答するように意図していない 実行コードを、実行できるような権限を持つべきではないです。 サーバを実行するために特定の新しいユーザとグループを 設定することをお薦めいたします。 nobody ユーザを使用する管理者もいますが、 これが常に望ましいわけではありません。 なぜなら nobody ユーザは、システムで 他の役割を担っているかも知れないからです。

特記事項: このディレクティブを <VirtualHost> で使用することはサポートされなくなりました。 suexec 向けにサーバを設定するのであれば、 SuexecUserGroup を使用してください。