Package com.google.cloud.logging

A client to Stackdriver Logging.

See: Description

Interface Summary

Interface	Description
Logging
LoggingFactory	An interface for Logging factories.

Class Summary

Class	Description
AsyncLoggingHandler	A logging handler that asynchronously outputs logs generated with Logger to Stackdriver Logging.
HttpRequest	Objects of this class represent information about the (optional) HTTP request associated with a log entry.
HttpRequest.Builder	A builder for HttpRequest objects.
LogEntry	A Stackdriver Logging log entry.
LogEntry.Builder	A builder for LogEntry objects.
Logging.EntryListOption	Class for specifying options for listing log entries.
Logging.ListOption	Class for specifying options for listing sinks, monitored resources and monitored resource descriptors.
Logging.WriteOption	Class for specifying options for writing log entries.
LoggingHandler	A logging handler that synchronously outputs logs generated with Logger to Stackdriver Logging.
LoggingLevel	This class adds some additional Java logging levels for Stackdriver Logging.
LoggingOptions
LoggingOptions.Builder
LoggingOptions.DefaultLoggingFactory
LoggingOptions.DefaultLoggingRpcFactory
Metric	Stackdriver Logging metrics describe logs-based metric.
Metric.Builder	A builder for Metric objects.
MetricInfo	Stackdriver Logging metrics describe logs-based metric.
MetricInfo.Builder	A builder for MetricInfo objects.
Operation	Additional information about a potentially long-running operation with which a log entry is associated.
Operation.Builder	A builder for Operation objects.
Payload<T>	A base class for log entry payloads.
Payload.JsonPayload	A log entry's JSON payload.
Payload.ProtoPayload	A log entry payload as a protobuf object.
Payload.StringPayload	A log entry payload as an UTF-8 string.
Sink	Stackdriver Logging sinks can be used to control the export of your logs.
Sink.Builder	A builder for Sink objects.
SinkInfo	Stackdriver Logging sinks can be used to control the export of your logs.
SinkInfo.Builder	A builder for SinkInfo objects.
SinkInfo.Destination
SinkInfo.Destination.BucketDestination	Class for specifying a Google Cloud Storage bucket as destination for the sink.
SinkInfo.Destination.DatasetDestination	Class for specifying a Google Cloud BigQuery dataset as destination for the sink.
SinkInfo.Destination.TopicDestination	Class for specifying a Google Cloud BigQuery dataset as destination for the sink.

Enum Summary

Enum	Description
HttpRequest.RequestMethod	The HTTP request method.
Logging.SortingField	Fields according to which log entries can be sorted.
Logging.SortingOrder	Sorting orders available when listing log entries.
Payload.Type	Type for a log entry payload.
Severity	The severity of the event described in a log entry.
SinkInfo.Destination.Type	Type of destination for Stackdriver Logging sink.
SinkInfo.VersionFormat	Available log entry formats.

Exception Summary

Exception	Description
LoggingException	Logging service exception.

Package com.google.cloud.logging Description

A client to Stackdriver Logging.

Here's a simple usage example for using gcloud-java from Compute Engine/App Engine Flexible. This example shows how to write and list log entries. For the complete source code see WriteAndListLogEntries.java.

 LoggingOptions options = LoggingOptions.defaultInstance();
 try(Logging logging = options.service()) {

   LogEntry firstEntry = LogEntry.builder(StringPayload.of("message"))
       .logName("test-log")
       .resource(MonitoredResource.builder("global")
           .addLabel("project_id", options.projectId())
           .build())
       .build();
   logging.write(Collections.singleton(firstEntry));

   Page<LogEntry> entries = logging.listLogEntries(
   EntryListOption.filter("logName=projects/" + options.projectId() + "/logs/test-log"));
   Iterator<LogEntry> entryIterator = entries.iterateAll();
   while (entryIterator.hasNext()) {
     System.out.println(entryIterator.next());
   }
 }

This second example shows how to use a Logger to write log entries to Stackdriver Logging. The snippet installs a Stackdriver Logging handler using LoggingHandler.addHandler(Logger, LoggingHandler). Notice that this could also be done through the logging.properties file, adding the following line:

 com.google.cloud.examples.logging.snippets.AddLoggingHandler.handlers=com.google.cloud.logging.LoggingHandler
 

For the complete source code see AddLoggingHandler.java.

 Logger logger = Logger.getLogger(AddLoggingHandler.class.getName());
 LoggingHandler.addHandler(logger, new LoggingHandler());
 logger.warning("test warning");
 

See Also:

Stackdriver Logging