Logging and viewing logs

This page describes the logs available when using Cloud Run, and how to view and write logs.

Cloud Run has two types of logs, and these are automatically sent to Stackdriver Logging:

  • Request logs: logs of requests sent to Cloud Run services. These logs are created automatically.
  • Container logs: logs emitted from the container instances, typically from your own code, written to supported locations as described in Writing container logs.

Viewing logs

You can view logs for your service in a couple of ways:

  • Use the Cloud Run page in the GCP Console
  • Use the Stackdriver Logging page in the GCP Console.

Both of these viewing methods examine the same logs stored in Stackdriver Logging, but the Stackdriver Logging page provides more details and more filtering capabilities.

To view logs in the Stackdriver Logging page, follow the instructions provided under Viewing Logs, and filter on the the Cloud Run Revision resource for Cloud Run. For Cloud Run on GKE, filter on the Kubernetes Container resource.

To view logs in the Cloud Run page:

  1. Go to Cloud Run

  2. Click the desired service in the displayed list.

  3. Click the LOGS tab to get the request and container logs for all revisions of this service. You can filter by log severity level.

Writing container logs

When you write logs from your service, they will be picked up automatically by Stackdriver Logging so long as the logs are written to any of these locations:

Most developers are expected to write logs using standard output and standard error.

The container logs written to these supported locations are automatically associated with the Cloud Run service, revision, and location. Exceptions contained in these logs are captured by and reported in Stackdriver Error Reporting.

Using simple text vs structured JSON

When you write logs, you can send a simple text string or send a single line of serialized JSON, also called "structured" data. This is picked up and parsed by Stackdriver Logging and is placed into jsonPayload. In contrast, the simple text message is placed in textPayload.

Special JSON fields in messages

When you provide a structured log as a JSON dictionary, some special fields are stripped from the jsonPayload and are written to the corresponding field in the generated LogEntry as described in the documentation for special fields.

For example, if your JSON includes a severity entry, it is removed from the jsonPayload and appears instead as the log entry's severity. Other special fields include httpRequest, and trace.

Correlating your container logs with a request log

In the Stackdriver logs viewer, logs correlated by the same trace are viewable in "parent-child" format: when you click on the triangle icon at the left of the request log, the container logs related to that request show up nested under the request log.

Container logs are not automatically correlated to request logs unless you use a Stackdriver Logging client library. If you want this correlation without using a client library, use a structured JSON log line that contains a trace field with the content of the incoming X-Cloud-Trace-Context header. Then your logs will be correctly correlated to the request log.

Controlling request log resource usage

Request logs are created automatically. Although you cannot control the amount of request logs directly from Cloud Run, you can make use of the logs exclusion feature from Stackdriver Logging.

Logging resource

Clicking on a log entry in the Stackdriver Logs Viewer opens up a JSON formatted log entry so you can drill down to the details you want.

All of the fields in a log entry, such as timestamps, severity, and httpRequest are standard, and are described in the documentation for a log entry.

However, there are some labels or resource labels that are special to Cloud Run. These are listed here with sample contents:

{
 httpRequest: {…}
 insertId:  "5c82b3d1000ece0000000000"
 labels: {
  instanceId:  "00bf4bf00000fb59c906a00000c9e29c2c4e06dce91500000000056008d2b6460f163c0057b97b2345f2725fb2423ee5f0bafd36df887fdb1122371563cf1ff453717282afe000001"
 }
 logName:  "projects/my-project/logs/run.googleapis.com%2Frequests"
 receiveTimestamp:  "2019-03-08T18:26:25.981686167Z"
 resource: {
  labels: {
   configuration_name:  "myservice"
   location:  "us-central1"
   project_id:  "my-project"
   revision_name:  "myservice-00002"
   service_name:  "myservice"
  }
  type:  "cloud_run_revision"
 }
 severity:  "INFO"
 timestamp:  "2019-03-08T18:26:25.970397Z"
}
Field Values and notes
instanceId The container instance that handled the request.
logName Identifies the log, for example, request log, standard error, standard output, etc.
configuration_name The Configuration resource that created the revision that served the request.
location Identifies the GCP location of the service.
project_id The project the service is deployed to.
revision_name The revision that served the request.
service_name The service that served the request.
type cloud_run_revision. The Cloud Run resource type.
Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Run Documentation