Setting Up Stackdriver Logging for PHP

You can write logs to Stackdriver Logging from PHP applications by using the Stackdriver Logging library for PHP directly.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. In the Cloud Console, on the project selector page, select or create a Cloud project.

    Go to the project selector page

  3. Make sure that billing is enabled for your Google Cloud project. Learn how to confirm billing is enabled for your project.

  4. Enable the Stackdriver Logging API.

    Enable the API

Installing the Stackdriver Logging library for PHP

The Stackdriver Logging library for PHP provides a simple PSR-3 logger implementation for PHP web frameworks.

To write logs from your app, add the Stackdriver Logging library for PHP to your composer.json:

composer require google/cloud-logging

Creating a PSR-3 logger

Use the following code to create a PSR-3 logger:

$logging = new LoggingClient([
    'projectId' => $projectId
$logger = $logging->psrLogger('app');

Enabling batching option

The PSR-3 logger sends the logs synchronously. This means that whenever you emit a log, it will add RPC latency to the user request. Especially if you emit multiple logs in a single request, the added latency will be significant. You probably want to avoid that.

The following code creates a PSR-3 logger which will batch multiple logs into one single RPC calls:

$logger = LoggingClient::psrBatchLogger('app');

By default, this logger batches the logs within a single process. On App Engine flexible environment, you can configure the Stackdriver Logging library for PHP for even higher throughput and lower latency. For details, see Configuring the logging daemon.

Configuring the Stackdriver Logging library for PHP

You can customize the behavior of the Stackdriver Logging library for PHP. See the configuration document for a list of possible configuration options.

Using the PSR-3 logger

Once the logger is created, you can use the logger in your application:

$logger->info('Hello World');
$logger->error('Oh no');

For more information on installation, see the documentation for the Stackdriver Logging library for PHP. You can also report issues using the issue tracker.

Using the Cloud Client Library directly

For information on using the Stackdriver Logging Cloud client library for PHP directly, see Stackdriver Logging Client Libraries.

Running on Google Cloud

Using Stackdriver Logging library for PHP requires the Cloud IAM Logs Writer role on Google Cloud. Most Google Cloud environments provide this role by default.

App Engine

App Engine grants the Logs Writer role by default.

The Stackdriver Logging library for PHP can be used without needing to explicitly provide credentials.

Stackdriver Logging is automatically enabled for App Engine applications. No additional setup is required.

However, we recommend that you use the PSR-3 logger which automatically adds metadata to your logs so that your application logs are correlated to the request logs.

Configuring the daemon for App Engine flexible environment

In the App Engine flexible environment, you can configure the Stackdriver Logging library for PHP to use an external daemon program to maximize the log throughput and minimize the app's latency. To enable this feature, add the following line to runtime_config section in app.yaml:

enable_stackdriver_integration: true

Google Kubernetes Engine

On Google Kubernetes Engine, you must add the logging.write access scope when creating the cluster:

gcloud container clusters create example-cluster-name --scopes

Compute Engine

When using Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud Console, you can do this in the Identity and API access section of the Create Instance panel. Use the Compute Engine default service account or another service account of your choice, and select Allow full access to all Cloud APIs in the Identity and API access section. Whichever service account you select, ensure that it has been granted the Logs Writer role in the IAM & admin section of the Cloud Console.

Running locally and elsewhere

To use the Stackdriver Logging library for PHP outside of Google Cloud, including running the library on your own workstation, on your data center's computers, or on the VM instances of another cloud provider, you must supply your Google Cloud project ID and appropriate service account credentials directly to the Stackdriver Logging library for PHP.

You can create and obtain service account credentials manually. When specifying the Role field, use the Logs Writer role. For more information on Cloud Identity and Access Management roles, go to Access control guide.

Viewing the logs

After deployment, you can view the logs in the Cloud Console Logs Viewer.

Go to the Logs Viewer

In the Logs Viewer, you must specify one or more resources, but the resource selection might not be obvious. Here are some tips to help you get started:

  • If you are deploying your application to App Engine or using the App Engine-specific libraries, set your resource to GAE Application.

  • If you are deploying your application on Compute Engine, set the resource to GCE VM Instance.

  • If you are deploying your application on Google Kubernetes Engine, your cluster's logging configuration determines the resource type of the log entries. For a detailed discussion on the Legacy Stackdriver and the Stackdriver Kubernetes Monitoring solutions, and how those options affect the resource type, see Migrating to Stackdriver Kubernetes Monitoring.

  • If your application is using the Stackdriver Logging API directly, the resource is dependent on the API and your configuration. For example, in your application, you can specify a resource or use a default resource.

  • If you don't see any logs in the Logs Viewer, to see all log entries, switch to the advanced query mode and use an empty query.

    1. To switch to the advanced query mode, click menu (▾) at the top of the Logs Viewer and then select Convert to advanced filter.
    2. Clear the content that appears in the filter box.
    3. Click Submit Filter.

    You can examine the individual entries to identify your resources.

For additional information, see Viewing Logs and Advanced logs queries.

Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Logging