With New Relic APM's PHP agent, you can monitor applications that reside in the Google App Engine (GAE) flexible environment. Adding New Relic to your GAE flex app gives you insight into the health and performance of your app and extends GAE with metrics you can view in New Relic APM, Browser, and Insights.
This document explains how to add New Relic to your GAE flex app by configuring a custom runtime, and gives an example of deploying a PHP app with Docker.
The New Relic PHP agent can run in a GAE flexible environment using a custom runtime. Due to limitations of other environments, do not use the GAE standard environment or Google App Engine's "native mode" installation.
Build a custom runtime using Docker
See Google's documentation for building custom runtimes. This example describes how to add New Relic to your GAE flex app by installing the New Relic PHP agent, building a custom runtime, and deploying a single PHP application via Debian. For best results with the GAE flex environment, always use Debian.
For more information about deploying and configuring your PHP app in the GAE flexible environment, see:
- 1. Set up the GAE project and install dependencies
- Follow standard procedures to install the New Relic PHP agent for your specific app server, and obtain your license key.
- Follow Google App Engine procedures for PHP to create a new Cloud Platform project, create an App Engine application, and complete other prerequisites for the Google Cloud SDK.
The Google Cloud SDK provides the
gcloudcommand line tool to manage and deploy GAE apps.
- 2. Extend the GAE image for PHP
In this example, the Dockerfile extends the generic PHP image with application files for a single application in Debian. You can add your New Relic license key directly to your Dockerfile, or use an environment variable in your
FROM gcr.io/google-appengine/php:latest ENV DOCUMENT_ROOT /app RUN DEBIAN_FRONTEND=noninteractive apt-get update; DEBIAN_FRONTEND=noninteractive apt-get -y install wget sudo RUN wget -O - https://download.newrelic.com/548C16BF.gpg | sudo apt-key add - RUN echo 'deb http://apt.newrelic.com/debian/ newrelic non-free' | tee /etc/apt/sources.list.d/newrelic.list RUN DEBIAN_FRONTEND=noninteractive apt-get update && DEBIAN_FRONTEND=noninteractive apt-get -y install newrelic-php5 RUN NR_INSTALL_KEY="new-relic-license-key" NR_INSTALL_SILENT=true newrelic-install install
- 3. Configure your app.yaml
app.yamlconfiguration file is required for a GAE flexible environment app with a custom runtime. At a minimum, make sure it contains:
env: flex runtime: custom runtime_config: document_root: .
- 4. Build a Docker image
The Dockerfile defines the Docker image to be built and is required for a GAE flexible environment app. When building the Docker image, use the PHP image from Google App Engine. Standard Docker images from other providers may cause problems with GAE.
To build the Docker image, run the following command. Be sure to include the period at the end of the code, to indicate the current directory contains the build files.
docker build --rm -t Docker-image-name .
- 5. Deploy Docker image to initialized GAE flexible environment
Optional: Disable health checks
Google App Engine sends periodic health check requests to confirm that an instance has been successfully deployed, and to check that a running instance maintains a healthy status. A health check is an HTTP request to the URL
If you create a custom runtime, your app must be able to handle a large number of health check requests. Otherwise, your app data may not display correctly in New Relic APM.
If you notice performance issues, disable GAE health checks. In your
health_check: enable_health_check: False
Get New Relic agent troubleshooting logs from GAE
Use these resources to troubleshoot your GAE flex environment app:
- To connect to the GAE instance and start a shell in the Docker container running your code, see Debugging an instance.
- To view the logs, use the Cloud Platform Console's Log Viewer.