Install New Relic Ruby agent in GAE flexible environment

With APM's Ruby 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 using solutions like APM and browser monitoring.

This document explains how to add New Relic to your GAE flex app using either of these methods:

• Google App Engine's "native mode" installation with a standard GAE runtime
• Docker installation using a custom runtime

The custom runtime method includes an example of deploying a Sinatra app. If you need specific libraries or headers, New Relic recommends using the custom runtime method.

Deploy using GAE's native support

When using Google App Engine "native mode" installation, you provide your app code and an app.yaml file. Google App Engine then deploys to a standard prebuilt Docker image.

To deploy with native support for Sinatra or Rails:

1. Follow New Relic's standard procedures to install the gem, including your license key.
2. Install the Ruby agent configuration file.

Once the gem and configuration file have been installed, the Ruby agent can automatically monitor applications that reside in the GAE flexible environment. Wait until the deployment completes, then view your GAE flex app data in the APM Summary page.

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 building a custom runtime for Docker. The example uses a Sinatra app for Ruby.

For more information about deploying and configuring your Ruby app in the GAE flexible environment, see:

• Google App Engine's documentation for Ruby
• Google App Engine's tutorials for Ruby

env: flex
runtime: custom
entrypoint: bundle exec ruby app.rb

FROM gcr.io/google-appengine/ruby:latest

$
docker build -f Dockerfile -t custom_ruby_app_container:latest .

Recommendation: Handle 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 /_ah/health.

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 APM.

New Relic recommends that you allow health checks for Ruby apps so that Google can check that your service is up and balanced properly. However, if excessive health checks cause congested transaction traces, you can set the Ruby agent to ignore the health check requests.

• To handle health checks, add a route for _ah/health in your app.
• To ignore health check requests, set the rules.ignore_url_regexes config setting in the application’s Ruby agent config to include '_ah/health'.

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 redirect New Relic Ruby agent logs to Stackdriver in the Cloud Platform Console, change the newrelic.js configuration file to:

  log_file_name: STDOUT

  Copy

• To view the logs, use the Cloud Platform Console's Log Viewer.