Ubuntu22.04 ApacheでHTTP/2

設定の概要

ホームラボにはいくつかサーバーがあるが、PHPが入っている・入っていないの違いでちょっと動きが違ったので、その観点で書いてみる。
※Rubyの場合にはまた違った設定が必要かもしれないが、必要になったときに頑張る方向。

やろうとすることを整理してみると、

• ApacheがHTTP/2を取り扱えるようにする。(mod_http2.so)
• Apacheのマルチプロセッシングモジュール(MPM)を、マルチプロセス・マルチスレッドのものに切り替える。(mod_mpm_event.so)
• ApacheのMPMが作業を渡せるようにする。(mod_proxy_fcgi.so, mod_proxy.so)
• ApacheのMPMに具体的な作業の渡し方を知らせる。(php8.1-fpm.conf)
• Apacheから作業を受け取って処理するリスナーを設置する。(PHP 8.1 FastCGI Process Manager)
• チューニング。ここでいうチューニングは最低限のもので、大量アクセスに対応するチューニングを指してはいない。

ということで、考えていたよりも多かった。

まず、HTTP/2はHTTP/1.1と違って、リクエストを並行して扱うことができるプロトコルになった。
mdn web docs / HTTP の進化 HTTP/2 - 高パフォーマンスなプロトコル 参照

一方、ApacheはリクエストをMPMで受け付けて処理する。
MPMはOSに最適なものが提供されており、UNIXではprefork、worker、eventの3つがある。このうちのどれか1つをロードする必要がある。

MPMは、ネットワークポートのバインド、リクエストの受け付け、子プロセスの割り当てを行う主役と言っても良い機能で、このような特徴がある。

並行したリクエストはスレッドで処理するようなので、HTTP/2が並列で多くのリクエストを送信するプロトコルであることから、preforkは向いていないので(できるけれども厳しい制限)、eventを設定するのがベスト。

そして、MPMにeventを使用するならば、作業を渡すリスナーを設置する必要がある。

以上のように大掛かりな仕掛けになってしまうが、並列で要求を処理できるとページの読み込みスピードは上がるので、設定する価値はあるかもしれない。

なお、ブラウザはHTTPSでないとHTTP/2の通信をしない。
今回の記事ではSSLの設定をサボっているので、curlコマンドを使ってHTTP/2の通信ができるようになるところまで確認しているが、サービスを公開するならSSLの設定が必要。

PHPを使用していない環境

ほぼまっさらな環境で試したが、この場合はMPMがデフォルトでeventになっており、HTTP/2を有効にすれば良かった。

まず、Apacheをインストール。

$ sudo apt -y install apache2
$ apache2 -v
Server version: Apache/2.4.52 (Ubuntu)
Server built:   2023-03-01T22:43:55

http2モジュールを有効化する。

$ sudo a2enmod http2
$ sudo systemctl restart apache2

ヘッダーを確認してみる。

$ curl --http2 --head http://localhost
HTTP/1.1 101 Switching Protocols
Upgrade: h2c
Connection: Upgrade

HTTP/2 200 
last-modified: Sat, 27 May 2023 05:34:11 GMT
etag: W/"29af-5fca6340f6d01"
accept-ranges: bytes
content-length: 10671
vary: Accept-Encoding
content-type: text/html
date: Sun, 00 Jan 1900 00:00:00 GMT
server: Apache/2.4.52 (Ubuntu)

HTTP/2で通信ができるようになっている。

状態の確認

テスト環境として、後述の手順でWordPressをインストールした。
この場合は、MPMがpreforkになっている。

$ apachectl -M
 ...
 mpm_prefork_module (shared)
 ...

レスポンスを確認すると、HTTP/1.1での通信になっている。
誰かに教えてもらった手順で普通にWordPressをインストールすると、大体こんな状態になっているのではなかろうか。

$ curl --http2 --head http://localhost
HTTP/1.1 200 OK
Date: Sat, 27 May 2023 09:35:13 GMT
Server: Apache/2.4.52 (Ubuntu)
Link: <http://script.hogeserver.hogeddns.jp/wp-json/>; rel="https://api.w.org/"
Content-Type: text/html; charset=UTF-8

HTTP/2を有効にする

作業を受け取るリスナーを設置する。

$ sudo apt install php-fpm

php-fpm(実態はphp8.1-fpm)はサービスで、設定ファイルが/etc/php/8.1/fpm/php-fpm.confに見える。
また、pool wwwというのが2つあること、ドメインソケットが開いていることがわかる。

$ systemctl status php8.1-fpm.service
● php8.1-fpm.service - The PHP 8.1 FastCGI Process Manager
     Loaded: loaded (/lib/systemd/system/php8.1-fpm.service; enabled; vendor preset: enabled)
     Active: active (running) since Sat 2023-05-27 09:50:20 UTC; 14h ago
       Docs: man:php-fpm8.1(8)
    Process: 97480 ExecStartPost=/usr/lib/php/php-fpm-socket-helper install /run/php/php-fpm.sock /etc/php/8.1/fpm/pool.d/www.conf 81 (code=exited, status=0/SUCCESS)
   Main PID: 97477 (php-fpm8.1)
     Status: "Processes active: 0, idle: 2, Requests: 60, slow: 0, Traffic: 0req/sec"
      Tasks: 3 (limit: 4530)
     Memory: 52.2M
        CPU: 3.493s
     CGroup: /system.slice/php8.1-fpm.service
             ├─97477 "php-fpm: master process (/etc/php/8.1/fpm/php-fpm.conf)" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" ""
             ├─97478 "php-fpm: pool www" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" ""
             └─97479 "php-fpm: pool www" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" ""
...

$ sudo ss -axp
...
Netid State  Recv-Q Send-Q            Local Address:Port   Peer Address:Port   Process                                                                                                                                                                                                            
u_str LISTEN 0      511    /run/php/php8.1-fpm.sock 194938            * 0      users:(("php-fpm8.1",pid=97479,fd=9),("php-fpm8.1",pid=97478,fd=9),("php-fpm8.1",pid=97477,fd=7))              
u_str ESTAB  0      0                             * 194937            * 194936 users:(("php-fpm8.1",pid=97477,fd=6))                                                                          
u_str ESTAB  0      0                             * 194936            * 194937 users:(("php-fpm8.1",pid=97477,fd=5))                                                           
...

※ssコマンドでは、何故かcgroupを使用したフィルターが使用できなかったので、適当に表示を詰めて表示している。

続いて、いま有効になっているpreforkを無効にする。
php8.1がmpm_preforkに依存しているので、この順番で実行しないと無効にできない。

$ sudo a2dismod php8.1
$ sudo a2dismod mpm_prefork

eventとhttp2、proxy_fcgiを有効にする。
また、php8.1-fpmという設定を有効にして、php-fpmに作業を渡す方法を具体的に伝える。

$ sudo a2enmod mpm_event http2 proxy_fcgi
$ sudo a2enconf php8.1-fpm
$ sudo systemctl restart apache2

レスポンスを確認すると、HTTP/2になっていた。

$ curl --http2 --head http://localhost
HTTP/1.1 101 Switching Protocols
Upgrade: h2c
Connection: Upgrade

HTTP/2 200 
link: <http://script.hogeserver.hogeddns.jp/wp-json/>; rel="https://api.w.org/"
content-type: text/html; charset=UTF-8
date: Sun, 00 Jan 1900 00:00:00 GMT
server: Apache/2.4.52 (Ubuntu)

以降、チューニングをしていく。

php.ini

php.iniは3つあった。

$ find /etc/php/8.1/ -name 'php.ini'
/etc/php/8.1/fpm/php.ini
/etc/php/8.1/cli/php.ini
/etc/php/8.1/apache2/php.ini

コマンドラインから実行したときと、apacheから実行したときで、使うphp.iniが違うようだ。
stack overflow / 2 php.ini files

今回、apacheで直接作業をするのではなく、php-fpmに作業を渡すことにしたのだから、使われるのは/etc/php/8.1/fpm/php.iniということになる。

具体的には、apache2/php.iniとfpm/php.iniの差分を調べて、fpm/php.iniに変更点を反映させた。

変更した結果を反映させるため、必要かどうかはっきりとはわからないが、サービスを再起動しておいた。

$ sudo systemctl restart php8.1-fpm

mpm_event.conf

ApacheのMPM eventについて、/etc/apache2/mods-available/mpm_event.confで設定されている。
Apache / Apache MPM Common Directives

この他にもeventで使える設定項目はあるが、ファイルにある項目だけを整理した。

自分のサイトがどの程度アクセスされているのか、1度のアクセスでどの程度の並列のリクエストがあるのか、という観点で最適値を考えることになるのだろう。

当サイトの場合、同時アクセスは殆どないに等しいので、ワーカースレッドが150もできれば十分ということで、このままで進めることにした。
仮にこれを超えた場合でも、ListenBacklog(デフォルト511)まではキューに入って順番に処理されるので、まず問題はないだろう。

php-fpm.conf

PHP FastCGI Process Managerのグローバル設定は、/etc/php/8.1/fpm/php-fpm.confにある。
ファイルの中では、設定項目についてコメントで詳しく説明がなされている。

コメントをDeepL先生に翻訳してもらった後に、公式に日本語ページがあることに気が付いたりする不思議…
PHPマニュアル / インストールと設定 / FastCGI Process Manager (FPM)

当サイトに必要な変更はないと思われた。

www.conf

PHP FastCGI Process Managerのプール設定は、/etc/php/8.1/fpm/pool.d/ディレクトリにwww.confが1つだけ設置されていた。
設定項目はたくさんあるのだけれど、今の段階で重要なのはプロセスの管理かと思ったので、それだけを抜粋した。

インストール直後は、プロセスマネージャーがdynamicに設定されており、かつ、pm.max_childrenに5が設定されている。
このpm.max_childrenの値は小さすぎて、当サイトでも足らないくらいなので、引き上げておく必要があると思われる。

実際、数値を引き上げておかないと、並列のリクエストが5つになった時点で、ログに警告が出力されたりする。
とはいえ、単純に100とか200とかにすると、プロセスが増えちゃって大変なんじゃないかと思う。

/var/log/php7.4-fpm.log

WARNING: [pool www] server reached pm.max_children setting (5), consider raising it

さて、今回、プロセスマネージャーをstaticに変更し、あわせて、pm.max_childrenはコア数と同じ2にしみた。
[再掲]Hacker's High / php-fpm の設定を理解してサイトのパフォーマンスを向上させる

これによって並行で取り扱えるリクエストは2つになるが、プロセスを起こすオーバーヘットがないので、CPUをよりリクエストへの対応に働かせることができる。
Apacheの設定では最大150スレッドを起こすことになっているが、Apacheからの要求があふれてもlisten.backlog(デフォルト511)の分だけキューに入り、順番に処理される理屈なので問題はないだろう。

2023/06/02 追記
pmをstatic、pm.max_childrenを2にして運用をしていたら、時々ApacheもPHP-FPMもログを出さずに停止(？)していることがあった。
停止というか、アクセスするとずーっと待たされて何も表示されない、PHP-FPMを再起動すると処理が再開する、という症状だった。
Z-Pushを運用している環境で、そこからアクセスすると一発でこの状態に陥る。

想像だけれども、
　PHPのプログラムから自分のサイトにWebアクセスする
　ApacheがPHPの処理を要求する
　PHP-FPMは処理中のために要求がキューに入る
となって、最初のPHPのプログラムはWebアクセスの応答がないので、いつまでも待っているのではないか。

PHPが自分のサイトにWebアクセスするような流れになっている場合には、それを考慮したプロセス数を設定するのだろう。
同時アクセスが多ければ多いほど、デッドロックみたいになってしまう可能性が高まるだろうから、どこかで隙間ができる程度にプロセス数を設定しておかなければ。
まっすぐ走るだけのプログラムなら、こんなことは考えなくても良いのだろうから、pm.max_childrenは2が一番効率的なんだろうけれども…仕方がない。

なお、pm.max_requestsは未設定(=0)だったものを500に設定した(500がコメントで用意されていたのでそのまま利用)。
これにより、プロセスは500回処理をすると再起動するので、アプリで何らかのメモリリークが発生していても、そのタイミングで開放されるようになる。

設定項目は後にまとめているが、この変更に関係しそうな部分だけを抜粋しておく。

変更した結果を反映させるため、サービスを再起動する。

$ sudo systemctl restart php8.1-fpm

以上の設定で、だいたい問題なく動くようになったと思われる。

Ubuntu20.04でPHPを使用している環境

Ubuntu 20.04の場合も、22.04とやることは同じだった。

PHP FastCGI Process Managerをインストール。

$ sudo apt install php-fpm

php-fpmのphp.iniを設定する。
今までにファイルのアップロードサイズなどの変更を加えており、同じ動作をさせるため。
具体的には、/etc/php/7.4/apache2/php.iniと/etc/php/7.4/fpm/php.iniの差分を比較し、変更点をfpm/php.iniに反映させる。

続いて、php-fpmのpool wwwを設定する。
具体的には、プロセスマネージャーをstaticにして、pm.max_childrenをコア数に、pm.max_requestsを500に設定。

/etc/php/7.4/fpm/pool.d/www.conf

pm = static
pm.max_children = 2
pm.max_requests = 500

php-fpmの設定変更を反映する。

$ sudo systemctl restart php7.4-fpm.service

続いて、Apacheを止めて、MPMをpreforkからeventに変更する。
また、関連するモジュールや設定を有効化する。

$ sudo systemctl stop apache2

$ sudo a2dismod php7.4
$ sudo a2dismod mpm_prefork

$ sudo a2enmod mpm_event http2 proxy_fcgi
$ sudo a2enconf php7.4-fpm

$ sudo systemctl start apache2

これで、HTTP/2に切り替えることができた。

最初に設定を変更したときに、設定漏れでPHPのソースが表示されてしまった。

これは、モジュールproxy_fcgiを有効化しておらず、MPM eventが作業をリスナーに渡す事自体をしていなかったために発生していた。
もし、設定php7.4-fpmを有効にし忘れると、proxy_fcgiが作業をリスナーに渡す方法がわからないので、同様にPHPのソースが表示される。

仕組みから考えれば当然ではあるが、セットで一式ちゃんと設定することが大切。

PHP-FPMとは何か

Ubuntuのマニュアルを一生懸命読んで、各設定ファイルのコメントを翻訳した後で、こういうページを見つけるわけで…
PHP / FastCGI Process Manager(FPM)

Ubuntuのマニュアルがこちらで、概要にこのようなことが書かれている。
ubuntu manuals / php-fpm - PHP FastCGI Process Manager

• デーモンとしてバックグラウンドで動作し、CGIリクエストをリスニングする。
• 出力は/var/log/php-fpm.logに記録される。
• ほとんどのオプションを/etc/php-fpm.confで設定する。
• デフォルトではlocalhost:9000/httpをリスニングして応答する。
• webserverから、".php"ファイルへの要求をすべてポート9000に転送することを期待する。

リスナーとして動作する、というのはこういうことなのかと理解。
実際にインストールすると、要求の転送はドメインソケットを通じて行われるように初期設定されている。

ポートでの転送と考えると、DockerHubにあるNextCloudのFPMは、恐らくそのタイプ。
docker-compose.ymlにNginxを加えてフロントに立たせ、NextCloudのコンテナはアプリケーションの動作だけを実行するようだった。
途中までしか試していないから断言はできないが、NextCloudコンテナのプロセス1がphp-fmpだったので、恐らくは。

Ubuntuのパッケージはこちら。
ubuntu packages / php8.1-fpm

インストール後に/lib/systemd/system/php8.1-fpm.serviceを見てみると、/etc/php/8.1/fpm/php-fpm.confを設定ファイルとして読み込むようになっていた。

php-fpm.conf

php-fpmの設定ファイルにあるコメントを、ほぼDeepL先生に翻訳してもらってみた。

最初のメッセージがこれ。

この設定ファイル内の相対パスは、すべて PHP のインストール先である /usr からの相対パスとなります。このプレフィックスは、コマンドラインから '-p' 引数を使用することで動的に変更することができます。

セクションはglobalのみ。

www.conf

php-fpm.confのincludeの指定によって、pool.d/www.confが読み込まれる。
この中で www というセクションが定義されていて、これがプールと呼ばれている。

こちらもほぼDeepL先生に翻訳してもらう。

インストール直後は、プロセスマネージャーがdynamicに設定されており、かつ、pm.max_childrenに5が設定されている。
これはだいぶ小さいようなので広げておいて上げるのが良さそうだ。

WordPressのセットアップ

PHPがちゃんと動いている環境をテストのために作成。

WordPressをセットアップする。ほとんどTutorialsの手順でやっているので、手順の説明は省略。
ubuntu tutorials / Install and configure WordPress

$ sudo apt -y install apache2 ghostscript libapache2-mod-php mariadb-server php php-bcmath php-curl php-imagick php-intl php-json php-mbstring php-mysql php-xml php-zip
$ sudo mkdir /srv/www
$ sudo chown www-data: /srv/www/
$ curl https://wordpress.org/latest.tar.gz | sudo -u www-data tar zx -C /srv/www

$ sudo tee /etc/apache2/sites-available/wordpress.conf <<EOF > /dev/null
<VirtualHost *:80>
    DocumentRoot /srv/www/wordpress
    <Directory /srv/www/wordpress>
        Options FollowSymLinks
        AllowOverride Limit Options FileInfo
        DirectoryIndex index.php
        Require all granted
    </Directory>
    <Directory /srv/www/wordpress/wp-content>
        Options FollowSymLinks
        Require all granted
    </Directory>
</VirtualHost>
EOF
$ sudo a2ensite wordpress
$ sudo a2dissite 000-default
$ sudo a2enmod rewrite
$ sudo systemctl restart apache2

$ sudo mysql
MariaDB [(none)]> create database wordpress;
MariaDB [(none)]> create user wordpress@localhost identified by 'password';
MariaDB [(none)]> grant select,insert,update,delete,create,drop,alter on wordpress.* to wordpress@localhost;
MariaDB [(none)]> flush privileges;
MariaDB [(none)]> quit

$ sudo -u www-data cp /srv/www/wordpress/wp-config-sample.php /srv/www/wordpress/wp-config.php
$ sudo -u www-data sed -i 's/database_name_here/wordpress/' /srv/www/wordpress/wp-config.php
$ sudo -u www-data sed -i 's/username_here/wordpress/' /srv/www/wordpress/wp-config.php
$ sudo -u www-data sed -i 's/password_here/password/' /srv/www/wordpress/wp-config.php
$ sudo sed -i "/put your unique phrase here/d" /srv/www/wordpress/wp-config.php

WordPressにアクセスし(http://<あなたのサイト>)、最終設定をすれば完了。

状態を確認、だいたいホームラボの環境と似たようなのができた。

$ php --version
PHP 8.1.2-1ubuntu2.11 (cli) (built: Feb 22 2023 22:56:18) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.1.2, Copyright (c) Zend Technologies
    with Zend OPcache v8.1.2-1ubuntu2.11, Copyright (c), by Zend Technologies
$ apache2 -v
Server version: Apache/2.4.52 (Ubuntu)
Server built:   2023-03-01T22:43:55