【PHP8.x】cli_set_process_title()関数の使い方

Copy
1<?php
2
3/**
4 * CLI環境で実行されるPHPスクリプトのプロセス名を変更するサンプルコード。
5 * このスクリプトはコマンドラインインターフェース (CLI) から実行してください。
6 * 例: php your_script_name.php
7 */
8function updateCliProcessTitle(): void
9{
10    // cli_set_process_title 関数はCLI環境でのみ利用可能です。
11    // その他の環境 (例: Webサーバー) で実行された場合はエラーとなります。
12    if (php_sapi_name() !== 'cli') {
13        echo "エラー: このスクリプトはCLI環境でのみ実行可能です。\n";
14        exit(1); // エラーコードで終了
15    }
16
17    // 設定したい新しいプロセス名
18    // この名前は、OSのプロセスリスト (例: `ps aux`) で確認できます。
19    $newTitle = 'MyCustomPhpWorkerProcess';
20
21    // プロセス名を変更する
22    // 成功した場合は true、失敗した場合は false を返します。
23    $isSuccess = cli_set_process_title($newTitle);
24
25    if ($isSuccess) {
26        echo "プロセス名が「{$newTitle}」に正常に変更されました。\n";
27        echo "別のターミナルを開き、「ps aux | grep {$newTitle}」コマンドを実行して、変更を確認できます。\n";
28        // プロセスがすぐに終了すると確認しにくいため、必要に応じて一時停止を入れると良いでしょう。
29        // 例: echo "10秒間停止します。この間に確認してください...\n";
30        //     sleep(10);
31    } else {
32        echo "プロセス名の変更に失敗しました。\n";
33        echo "この機能は、実行環境のOSやシステム権限によっては利用できない場合があります。\n";
34    }
35}
36
37// 関数を実行してプロセス名を変更します
38updateCliProcessTitle();

cli_set_process_title関数は、PHPスクリプトがコマンドラインインターフェース（CLI）環境で実行されている際に、そのスクリプトのプロセス名を変更するために使用されます。これにより、OSのプロセスリスト（例えば、Linuxのps auxコマンドなど）でPHPスクリプトを識別しやすくなります。

この関数はstring $titleという引数を受け取ります。これは、新しく設定したいプロセス名を文字列で指定するものです。関数がプロセス名の変更に成功した場合はtrueを、失敗した場合はfalseをブール値で返します。

サンプルコードでは、まずphp_sapi_name() !== 'cli'で、スクリプトがCLI環境で実行されているかを確認し、そうでない場合はエラーとして終了します。その後、'MyCustomPhpWorkerProcess'という新しいプロセス名を指定し、cli_set_process_title()関数に渡してプロセス名を変更しています。変更が成功したかどうかに応じて、「プロセス名が正常に変更されました。」または「プロセス名の変更に失敗しました。」というメッセージが表示されます。成功時には、別のターミナルでps aux | grepコマンドを使って変更を確認できることも案内しています。この機能は、実行環境のOSやシステム権限によっては利用できない場合がある点に注意が必要です。

Copy
1<?php
2
3/**
4 * cli_set_process_title関数の使用例
5 *
6 * このスクリプトは、CLI (コマンドラインインターフェース) 環境で実行されたPHPプロセスのタイトルを変更する方法を示します。
7 * プロセス名が変更されることで、システム監視ツール (例: `ps aux` や `top`) でスクリプトの識別が容易になります。
8 *
9 * 前提条件:
10 * - PHP 8 以降のバージョンで実行すること。
11 * - CLI環境で実行すること。
12 * - OSがプロセス名の変更をサポートしていること (Linux/Unix系では一般的にサポートされています)。
13 */
14
15// プロセス名の変更はCLI環境でのみ有効です。
16// $_SERVER['PHP_SAPI'] は、PHPがどのように実行されているか (例: 'cli', 'apache2handler') を示します。
17if ($_SERVER['PHP_SAPI'] !== 'cli') {
18    echo "エラー: このスクリプトはCLI (コマンドラインインターフェース) 環境でのみ実行可能です。\n";
19    exit(1); // CLI以外での実行を防ぎ、エラーコード1で終了
20}
21
22// プロセスに設定する新しいタイトルを定義します。
23// getmypid() 関数は現在のPHPプロセスのIDを返します。これにより、複数のスクリプトが同時に実行されても識別しやすくなります。
24$newProcessTitle = 'MyPhpCliWorker_ID' . getmypid();
25
26echo "現在のPHPプロセスのタイトルを '{$newProcessTitle}' に変更します。\n";
27
28// cli_set_process_title関数を呼び出して、プロセスのタイトルを変更します。
29// この関数は、変更が成功した場合は true、失敗した場合は false を返します。
30if (cli_set_process_title($newProcessTitle)) {
31    echo "プロセス名の変更に成功しました。\n";
32    echo "このスクリプトは15秒間実行を継続します。\n";
33    echo "この間に別のターミナルを開き、以下のコマンドでプロセス名が変更されていることを確認してください。\n";
34    // escapeshellargは、シェルコマンドに引数を安全に渡すために使用します。
35    echo "例: ps aux | grep " . escapeshellarg($newProcessTitle) . "\n";
36
37    sleep(15); // ユーザーがプロセス名を確認できるように、スクリプトを一時停止します。
38
39    echo "スクリプトが終了します。\n";
40} else {
41    echo "エラー: プロセス名の変更に失敗しました。\n";
42    echo "考えられる原因:\n";
43    echo "  - オペレーティングシステムがプロセス名の変更をサポートしていません。\n";
44    echo "  - スクリプトにプロセス名を変更するのに十分な権限がありません。\n";
45    exit(1); // 失敗した場合もエラーコード1で終了
46}
47
48?>

PHPのcli_set_process_title関数は、CLI（コマンドラインインターフェース）環境で実行されているPHPプロセスのタイトルを変更するために使用されます。この機能により、ps auxやtopのようなシステム監視ツールで、実行中のPHPスクリプトをより具体的に識別できるようになります。

この関数は、string $titleという引数を一つ受け取ります。これは、プロセスに割り当てる新しい名前を文字列として指定するものです。関数の実行が成功した場合はtrueを、何らかの理由で失敗した場合はfalseをブール値で返します。

サンプルコードでは、まず$_SERVER['PHP_SAPI']というPHPのスーパーグローバル変数を用いて、スクリプトがCLI環境で実行されているかを確認しています。これは、cli_set_process_title関数がCLI環境でのみ有効であるためです。次に、getmypid()関数で現在のPHPプロセスのIDを取得し、これを新しいプロセス名に含めることで、複数のスクリプトが同時に実行されても個々のプロセスを識別しやすくしています。

cli_set_process_title関数が成功すると、その旨がユーザーに通知され、プロセス名の変更をps auxのようなOSコマンドで確認できるように、スクリプトは一時的に実行を停止します。失敗した場合、オペレーティングシステムがプロセス名の変更をサポートしていないか、スクリプトに適切な権限がない可能性が示唆されます。この関数は、PHPでバックグラウンド処理やデーモンを作成する際に、その運用監視を効率化するために非常に有用です。