This page describes the logs that are available for App Engine apps, and how to write and view log entries.
App Engine collects two types of logs:
Request log: A log of the requests that are sent to your app. App Engine automatically creates entries in the request log.
App log: log entries that you write to a supported framework or file as described on this page.
App Engine automatically sends these logs to the Cloud Logging agent, and you can view them in the Logs Viewer, on the command line, or programmatically.
Writing app logs
To write log entries, we recommend that you use the Cloud Logging client library for Ruby. For instructions and code samples, see Setting Up Cloud Logging for Ruby.
Alternative: Writing structured logs to
Instead of the recommended approach, you can send simple
text strings to
stderr. The strings will appear as messages in
the Logs Viewer, the command line, and the Cloud Logging API, and will be
associated with the App Engine service and version that emitted them.
If you want to filter these strings in the Logs Viewer by severity level, you need to format them as structured data. For more information, see Structured logging.
If you want to correlate entries in the app log with the request log, your
structured app log entries need to contain the request's trace identifier. You
can extract the trace identifier from the
header. In your structured log entry, write the ID to a field named
logging.googleapis.com/trace. For more information about the
X-Cloud-Trace-Context header, see
Forcing a request to be traced.
See an example of writing structured log entries with a trace ID in the Cloud Run documentation. You can use the same technique in your App Engine apps.
You can view your application and request logs using the Logs Viewer:
Go to the Logs Viewer in the Cloud Console:
Select an existing Google Cloud project at the top of the page.
From the drop-down menus, select GAE Application as your resource type.
To see which app log entries correlate to request log entries:
httpRequest.requestUrllog from the selector menu.
Expand a request log entry. The app logs related to that request show up nested under the request log entry.
If you send simple text entries to standard output, you cannot use the Logs Viewer to filter app entries by severity, nor can you see which app logs correspond to specific requests. You can still use other types of filtering in the Logs Viewer, such as text and timestamp.
You can filter the Logs Viewer by App Engine service and version and other criteria. You can also search the logs for specific entries. See Viewing Logs details.
Viewing logs using the command line
To view your App Engine logs from the command line, use the following command:
gcloud app logs tail
For more information, see gcloud app logs tail.
Reading logs programmatically
If you want to read the logs programmatically, you can use one of these methods:
- Use a log sink to Pub/Sub and a script to pull from Pub/Sub.
- Call the Cloud Logging API through the client library for your programming language.
- Call the Cloud Logging API REST endpoints directly.
Pricing, quotas, and logs retention policy
For information about pricing that applies to both request and app logs, see pricing for Cloud Logging.
For the logs retention policy and the maximum size of log entries, see Quotas and limits. If you want to store your logs for a longer period, you can export your logs to Cloud Storage. You can also export your logs to BigQuery and Pub/Sub for further processing.
Managing log resource usage
You can control the amount of logging activity from your app logs by writing more or fewer entries from your app's code. Request logs are created automatically, so to manage the number of request log entries associated with your app, Use the logs exclusion feature from Cloud Logging.
Sometimes app log entries are not correlated with the request log. This happens the first time your app receives a request and any other time App Engine writes status messages to your app's log. For more information, see https://issuetracker.google.com/issues/138365527.