Installing The New Relic PHP Agent on AutoPilot

Introduction

This guide will cover installing the New Relic PHP agent on your AutoPilot deployment, as well as creating an operating system image with New Relic installed so that the installation persists.

Installation

Connect to your deployment with SSH using the Shell Access SSH command found in the deployment's Overview tab. We also have a guide on connecting with SSH here.

If your deployment is an AutoScaling Cluster, these steps should be performed on the leader web node. SSH to the leader web node after connecting to the jump node:

ssh web

Then, to install New Relic, follow New Relic's documentation here. Note that the installation script must be run as root, or with sudo.

Note: AutoPilot uses the aarch64 architecture. The above documentation supports this architecture. Any New Relic guides that are only for x86_64 will not work.

Persistence

Once New Relic is installed, you will need to create a copy of the operating system image. This image will be applied to your future web nodes to ensure they all run the New Relic PHP agent.

To do so, navigate to the Backups tab of your AutoPilot deployment. If your deployment is an AutoScaling Cluster, select Operating System from the Resource drop-down. Enter a suitable name for the backup in the Backup Name field.

Select Request and wait for the backup to complete.

Once the backup is complete, navigate to the Adjust tab of your AutoPilot deployment.

Select Web Configuration.

From the Operating System Image drop-down, select your newly-created backup.

If your deployment is an All-In-One, perform these steps for the Jump Host Configuration section of the page instead.

WARNING: Changing the Operating System Image for your Jump Host will incur brief downtime.

Once finished, scroll to the bottom of the page and select Push Update.

Once the update has completed, your web nodes or jump host will use the same operating system image with New Relic installed and running.