APMインサイトのPHPエージェント

PHPエージェントをWebサーバーにデプロイすればエンド・エンドでWebトランザクションを把握でき、パフォーマンス低下の切り分けと解消を、素早く実行できます。PHPアプリケーションのパフォーマンスを把握するには、APMインサイトのPHPエージェントをWebサーバーに配置する必要があります。エージェントはアプリケーションのパフォーマンス メトリックを収集し、Applications Managerサーバーへ60秒に1回、送信します。

要件：PHP 5.3から7.4、Linux 64ビット版（Alpine OSを除く）、Windows

サポートするWebサーバー：IIS、Apache 2、ngnix、その他FPMベースのWebサーバー

サポートするフレームワーク：CodeIgniter、CakePHP、Laravel、Drupal、Joomla、WordPress

サポートするデータベース：MySQLドライバ―、SQLite、PostgreSQL、PDOベースのDBクエリ

メモ：
  • Windowsでは、PHPバージョン5.3から7.4までをサポートします。Webサーバーには一般的なものにくわえ、IISが使えます。
  • Linuxでは、PHPバージョン5.3から7.4までをサポートします。WebサーバーにIISは現状サポートしていません。

メモ：APMインサイトのエージェントを、他のアプリケーション パフォーマンス管理ツール（APM）と併用しないでください。同じ環境で他のAPM製品やサービスが動いていると、当社のエージェントのインストールに失敗することがあります。

エージェント設定

エージェント パフォーマンス レポート

APMインサイトPHPエージェントはアプリケーションへの影響を最小にとどめるよう最適化されています。エージェントによるリソース利用の状況は、パフォーマンス レポートで確認ください。

PHPエージェントをLinuxにインストールするには

Linux用エージェントは、次の説明に従ってインストールしてください。

  1. Applications ManagerのWebクライアントで、APMインサイト タブへ移動し、ヘルプ カードにあるライセンス キーをコピーします。
  2. PHPエージェントのLinux用ファイル（agent_php.zip）を、ダウンロード ページで入手します。
  3. rootへのログインで作業を始めます。
  4. agent_php.zipファイルを/optディレクトリに解凍すると、サブディレクトリzpaができます。

    $ cd /opt
    $ wget [agent_php.zip LINK]
    $ unzip agent_php.zip

  5. /zpa/binディレクトリへ移動して、次のコマンドを実行してください。

    $ cd zpa/bin
    $ sudo sh configure.sh [ENTER LICENSE KEY HERE]

  6. /zpa/confディレクトリにあるapminsight.confファイルを開き、次のキーを記載します。

    PHPエージェント バージョン2.9.3より前では

    apm.host=[HOST-NAME]
    apm.port=[HOST-PORT]
    use.https=[true/false]

    PHPエージェント バージョン2.9.3以降では

    apm.host=[HOST-NAME]
    apm.port=[HOST-PORT]
    apm.protocol.https=[true/false]

    サンプル：

    PHPエージェント バージョン2.9.3より前では

    apm.host=localhost
    apm.port=8443
    use.https=true

    PHPエージェント バージョン2.9.3以降では

    apm.host=localhost
    apm.port=8443
    apm.protocol.https=true

    必要キーを記載したら、ファイルを閉じます。

  7. PHPエージェントを次のコマンドで再起動してください。

    $ sh run.sh restart

  8. WebサーバーやFPMサーバーを次のコマンドで再起動してください。

    # Apacheサーバーの場合
    $ sudo service apache2 restart

    # FPMサーバーの場合
    $ sudo service php-fpm restart

インストール成功を確認するには

インストール後、端末で次のコマンドを実行します。

$ php -m | grep zpa

出力にzpaがあれば成功です。

メモ：

エージェントはサーバー リブート時に自動では再起動しません。起動、停止、再起動には、次のコマンドを利用してください。

$ cd /opt/zpa/bin

# エージェントの起動
$ sh run.sh start

# エージェントの停止
$ sh run.sh stop

# エージェントの再起動
$ sh run.sh restart

# systemd対応OSでは、次のコマンドで再起動できます。
$ service zpdpsvc restart

サービス リブート中にエージェントを自動的に再起動するには

システム リブート時に、APMインサイトのPHPエージェントを自動で再起動させるには、次の手順に従ってください。

systemdのあるサーバーでは

インストール先Linuxフレーバーがsystemd対応であれば、サーバー リブート時にエージェントも自動起動します。

systemdのないサーバーでは

  1. /etc/rc.localファイルを編集してください。
  2. rc.localに次の行を加筆します。

    cd /opt/zpa/bin
    sh run.sh restart

    最後にファイルを保存してください。

PHPエージェントをWindowsにインストールするには

Windows用エージェントは、次の説明に従ってインストールしてください。

  1. Applications ManagerのWebクライアントで、APMインサイト タブへ移動し、ヘルプ カードにあるライセンス キーをコピーします。
  2. PHPエージェントのWindows用.msiファイルを、ダウンロード ページで入手します。
  3. インストール ウィザードを起動し、指示手順に従って進んでください。
  4. APMインサイト タブからコピーしたライセンス キーを、インストール ウィザードからの指示に従って貼り付け、インストールを続行してください。
  5. インストールが完了したら、\APM Insight PHP Agent\zpa\confディレクトリにあるapminsight.confファイルを開き、次のキーを記載します。

    PHPエージェント バージョン2.9.3より前では

    apm.host=[HOST-NAME]
    apm.port=[HOST-PORT]
    use.https=[true/false]

    PHPエージェント バージョン2.9.3以降では

    apm.host=[HOST-NAME]
    apm.port=[HOST-PORT]
    apm.protocol.https=[true/false]

    サンプル：

    PHPエージェント バージョン2.9.3より前では

    apm.host=localhost
    apm.port=8443
    use.https=true

    PHPエージェント バージョン2.9.3以降では

    apm.host=localhost
    apm.port=8443
    apm.protocol.https=true

    必要キーを記載したら、ファイルを閉じます。

  6. 上記の変更後、iisresetコマンドを手動で実行してください。
  7. サーバーでトラフィックを発生させてみて、APMインサイトのコンソールに収集データが表示されるか確認ください。

PHPエージェントをLinuxからアンインストールするには

Linuxでのアンインストール作業は、次の説明どおりに実行します。

  • /zpa/binディレクトリに移動し、次のコマンドを実行してください。

    $ sh configure.sh uninstall

  • 最後にWebサーバーを再起動してください。

PHPエージェントをWindowsからアンインストールするには

Windowsでのアンインストール作業は、次の説明どおりに実行します。

  • コントロール パネルを開きます。
  • プログラムと機能を開き、APMインサイトPHPエージェントを右クリックしてアンインストールを選択します。
  • マシンの指示にしたがって削除を完了させてください。

メモ：

  • エージェントのアンインストールには、Windows管理グループでの管理者権限が必要です。
  • エージェント関連の設定ファイルやログも、自動で削除されます。