Setting Up Stackdriver Logging for Java

You can write logs to Stackdriver Logging from Java applications by using the Logback appender or a java.util.logging handler, or by using the Stackdriver Logging library for Java directly.

The Stackdriver Logging agent does not have to be installed to use the Stackdriver Logging library for Java.

Before you begin

1. Sign in to your Google Account.

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

2. Select or create a GCP project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to the project selector page

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

4. Enable the Stackdriver Logging API.

   Enable the API

Logback appender for Stackdriver Logging

Using the Logback appender, you can use Stackdriver Logging with the SLF4J logging facade.

Installing the dependency

If you are using Maven, add the following to your pom.xml file:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-logging-logback</artifactId>
  <version>0.114.0-alpha</version>
</dependency>

If you are using Gradle, add the following to your dependencies:

compile 'com.google.cloud:google-cloud-logging-logback:0.114.0-alpha'

If you are using SBT, add the following to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-logging-logback" % "0.114.0-alpha"

Logback configuration

Logback can be configured programmatically or using a script expressed in XML or Groovy.

You can customize the minimum severity threshold, log name, or provide additional enhancers. This is a sample Logback configuration in XML format:

View on GitHub Feedback

<configuration>
  <appender name="CLOUD" class="com.google.cloud.logging.logback.LoggingAppender">
    <!-- Optional : filter logs at or above a level -->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>INFO</level>
    </filter>
    <log>application.log</log> <!-- Optional : default java.log -->
    <resourceType>gae_app</resourceType> <!-- Optional : default: auto-detected, fallback: global -->
    <enhancer>com.example.logging.logback.enhancers.ExampleEnhancer</enhancer> <!-- Optional -->
    <flushLevel>WARN</flushLevel> <!-- Optional : default ERROR -->
  </appender>

  <root level="info">
    <appender-ref ref="CLOUD" />
  </root>
</configuration>

Example

Once you have configured Logback to use the Stackdriver Logging Logback appender, you can now redirect logs using the SLF4J logging API. This snippet shows how to log using SLF4J facade within your application:

View on GitHub Feedback

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Quickstart {
  private static final Logger logger = LoggerFactory.getLogger(Quickstart.class);

  public static void main(String[] args) {
    logger.info("Logging INFO with Logback");
    logger.error("Logging ERROR with Logback");
  }
}

The java.util.logging handler

You can also use the Stackdriver Logging API using a default Java Logging API handler.

Installing the dependency

If you are using Maven, add the following to your pom.xml file:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-logging</artifactId>
  <version>1.96.0</version>
</dependency>

If you are using Gradle, add the following to your dependencies:

compile 'com.google.cloud:google-cloud-logging:1.96.0'

If you are using SBT, add the following to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-logging" % "1.96.0"

If you're using IntelliJ or Eclipse, you can add client libraries to your project using the following IDE plugins:

• Cloud Code for IntelliJ
• Cloud Tools for Eclipse

The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.

Note: Cloud Java client libraries do not currently support Android.

java.util.logging configuration

Logging handlers can be added programmatically or by using a configuration file. The path to the configuration file must be provided to your application as a system property: -Djava.util.logging.config.file=/path/to/logging.properties

Here is an example of a configuration file:

View on GitHub Feedback

# To use this configuration, add to system properties : -Djava.util.logging.config.file="/path/to/file"
#
.level = INFO

# it is recommended that io.grpc and sun.net logging level is kept at INFO level,
# as both these packages are used by Stackdriver internals and can result in verbose / initialization problems.
io.grpc.netty.level=INFO
sun.net.level=INFO

com.example.logging.jul.Quickstart.handlers=com.google.cloud.logging.LoggingHandler
# default : java.log
com.google.cloud.logging.LoggingHandler.log=custom_log

# default : INFO
com.google.cloud.logging.LoggingHandler.level=FINE

# default : ERROR
com.google.cloud.logging.LoggingHandler.flushLevel=ERROR

# default : auto-detected, fallback "global"
com.google.cloud.logging.LoggingHandler.resourceType=container

# custom formatter
com.google.cloud.logging.LoggingHandler.formatter=java.util.logging.SimpleFormatter
java.util.logging.SimpleFormatter.format=%3$s: %5$s%6$s

#optional enhancers (to add additional fields, labels)
com.google.cloud.logging.LoggingHandler.enhancers=com.example.logging.jul.enhancers.ExampleEnhancer

Example

This snippet shows you how to log using java.util.logging:

View on GitHub Feedback

import java.util.logging.Logger;

public class Quickstart {
  private static final Logger logger = Logger.getLogger(Quickstart.class.getName());

  public static void main(String[] args) {
    logger.info("Logging INFO with java.util.logging");
    logger.severe("Logging ERROR with java.util.logging");
  }
}

Common Configuration

The following sections cover configuration that is common to the java.util.logging handler and the Logback appender for Stackdriver Logging.

Defaults

The Logback appender and java.util.logging handler use the following defaults to instantiate a Stackdriver Logging client:

• Log name : java.log

• Minimum threshold to log : INFO

• Flush severity : ERROR

The Stackdriver Logging library for Java batches messages by size and time since last write. Batches with logging requests at or above the flush severity are immediately written out.

Note: If using the Stackdriver Logging library for Java API directly, there is no default log name or minimum threshold.

Monitored resource detection

All logs sent via the Stackdriver Logging libraries require a monitored resource type to identify your application.

The Logback appender and the java.util.logging handler provide automatic resource type detection of your App Engine, Compute Engine, and Google Kubernetes Engine applications.

A global monitored resource is used as the default in other environments.

You can override the monitored resource type to a valid type in the Logback appender Configuration or the java.util.logging Handler Configuration.

Note: If using the Stackdriver Logging API directly, you must provide a valid monitored resource type when logging using the API.

Additional fields and labels

Using the Logback appender and the java.util.logging handler, you can add or update fields on a LogEntry object using an instance of LoggingEnhancer.

The enhancers must be configured as shown in the Logback appender configuration or the java.util.logging handler configuration:

View on GitHub Feedback

import com.google.cloud.logging.LogEntry;
import com.google.cloud.logging.LoggingEnhancer;

// Add / update additional fields to the log entry
public class ExampleEnhancer implements LoggingEnhancer {

  @Override
  public void enhanceLogEntry(LogEntry.Builder logEntry) {
    // add additional labels
    logEntry.addLabel("test-label-1", "test-value-1");
  }
}

For more information on installation, see the documentation for the Stackdriver Logging library for Java. 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 Java directly, see Stackdriver Logging Client Libraries.

Running on Google Cloud Platform

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

App Engine

App Engine grants the Logs Writer role by default.

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

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

Note: Logs written to stdout and stderr are automatically sent to Stackdriver Logging for you, without needing to use Stackdriver Logging library for Java.

App Engine standard environment, by default, uses the java.util.logging.Logger API; this writes to Stackdriver Logging directly and is easy to configure.

For further details, see App Engine documentation on Reading and Writing Application Logs.

App Engine flexible environment

On App Engine flexible environment, java.util.logging uses the ConsoleHandler by default, and sends logs to stdout and stderr.

The Jetty Runtime is bundled with the Stackdriver Logging library for Java.

The java.util.logging handler can be used to log directly to Stackdriver Logging by providing the logging.properties in your app.yaml as shown here:

    env_variables:
      JETTY_ARGS: -Djava.util.logging.config.file=WEB-INF/logging.properties

Trace ID logging is available on Jetty runtimes if you are using the java.util.logging handler or the Logback appender.

When running on App Engine flexible environment, a TraceLoggingEnhancer instance adds a thread-safe trace ID to every log entry using the label trace_id.

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 https://www.googleapis.com/auth/logging.write

Compute Engine

Note: To use the Stackdriver Logging library for Java on a Compute Engine VM instance, you do not need to install the Stackdriver Logging agent.

When using Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud Platform 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 GCP Console.

Running locally and elsewhere

To use the Stackdriver Logging library for Java outside of Google Cloud Platform, 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 GCP project ID and appropriate service account credentials directly to the Stackdriver Logging library for Java.

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