README.md

Google Cloud Logging Logback Appender Client for Java

Java idiomatic client for Cloud Logging Logback Appender.

• Product Documentation
• Client Library Documentation

Note: This client is a work-in-progress, and may occasionally make backwards-incompatible changes.

Quickstart

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

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

If you are using Gradle without BOM, add this to your dependencies:

implementation 'com.google.cloud:google-cloud-logging-logback:0.131.11-alpha'

If you are using SBT, add this to your dependencies:

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

Authentication

See the Authentication section in the base directory's README.

Authorization

The client application making API calls must be granted authorization scopes required for the desired Cloud Logging Logback Appender APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Cloud Logging Logback Appender API calls.

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the Cloud Logging Logback Appender API enabled.

Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google Cloud Command Line Interface and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].

Installation and setup

You'll need to obtain the google-cloud-logging-logback library. See the Quickstart section to add google-cloud-logging-logback as a dependency in your code.

About Cloud Logging Logback Appender

Cloud Logging Logback Appender

See the Cloud Logging Logback Appender client library docs to learn how to use this Cloud Logging Logback Appender Client Library.

Usage

Add the appender to your Logback configuration logback.xml. See Logback filters for information on filtering log output and encoders for information on formatting.

<configuration>
  <appender name="CLOUD" class="com.google.cloud.logging.logback.LoggingAppender">
    <!-- Optional: filter logs at and above this level -->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>INFO</level>
    </filter>

    <!-- Optional: defaults to "java.log" -->
    <log>application.log</log>

    <!-- Optional: defaults to "ERROR" -->
    <flushLevel>WARN</flushLevel>

    <!-- Optional: defaults to ASYNC -->
    <writeSynchronicity>SYNC</writeSynchronicity>

    <!-- Optional: defaults to true -->
    <autoPopulateMetadata>false</autoPopulateMetadata>

    <!-- Optional: defaults to false -->
    <redirectToStdout>true</redirectToStdout>

    <!-- Optional: auto detects on App Engine Flex, Standard, GCE and GKE, defaults to "global". -->
    <resourceType></resourceType>

    <!-- Optional: defaults to the default credentials of the environment -->
    <credentialsFile>/path/to/credentials/file</credentialsFile>

    <!-- Optional: defaults to the project id obtained during authentication process. Project id is also used to construct resource name of the log entries -->
    <logDestinationProjectId>String</logDestinationProjectId>

    <!-- Optional: add custom labels to log entries using LoggingEnhancer classes -->
    <enhancer>com.example.enhancers.TestLoggingEnhancer</enhancer>
    <enhancer>com.example.enhancers.AnotherEnhancer</enhancer>

    <!-- Optional: specifies if a batch's valid entries should be written even if some other entry failed due to an error. Defaults to true 
    See [partial_success](https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write#body.request_body.FIELDS.partial_success) for more info -->
    <partialSuccess>true</partialSuccess>

    <!-- Optional: In the asynchronous mode the call(s) to Logging API takes place asynchronously and few calls to `write()` 
    method may be batched together to compose a single call to Logging API. In order to control the batching settings, 
    the `logbackBatchingSettings` section can be used as shown below.
    See [BatchingSettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.batching.BatchingSettings) 
    for more info regarding parameters shown below -->
    <logbackBatchingSettings>
      <elementCountThreshold>100</elementCountThreshold>
      <requestByteThreshold>1000</requestByteThreshold>
      <delayThreshold>500</delayThreshold>
      <maxOutstandingElementCount>10000</maxOutstandingElementCount>
      <maxOutstandingRequestBytes>100000</maxOutstandingRequestBytes>
      <limitExceededBehavior>Ignore</limitExceededBehavior>
    </logbackBatchingSettings> 
  </appender>

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

In your code:

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

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

    public void log(String name) {
        logger.info("This is a test");
    }

    public static void main(String[] args) {
        TestLogger testLogger = new TestLogger();
        testLogger.log("test");
    }
}

Populate log entries with metadata

The library provides multiple ways to enrich log entries with additional information. You can select one or more ways to customize log entries that will be written into Cloud Logging.

• Manually update a log entry using [LoggingEnhancer] (https://github.com/googleapis/java-logging/blob/main/google-cloud-logging/src/main/java/com/google/cloud/logging/.
• Use ILoggingEvent to update a log entry with [LoggingEventEnhancer] (https://github.com/googleapis/java-logging-logback/blob/main/src/main/java/com/google/cloud/logging/logback/LoggingEventEnhancer.java).
• Enable auto-population of the LogEntry metadata using the autoPopulateMetadata configuration flag.

Optimize log ingestion

By default, the appender will ingest log entries asynchronously by calling Logging API. Multiple calls may be aggregated before being sent to improve use of API quota and bandwidth. You can set the writeSynchronicity configuration flag to SYNC if they want to ingest log entries synchronously. Note that configuring synchronous ingestion will probably result in performance penalties to your applications. If you plan to deploy your application in one of Google Cloud managed environments (e.g. Cloud Run, Cloud Function or App Engine), you can leverage the support provided by the implicit logging agent and the structured logging feature. To use it, set the redirectToStdout configuration flag to true. This flag instructs the appender to print the log entries to stdout instead of ingesting them using Logging API. The log entries are printed using the structured logging Json format. In result, the logging agent will be responsible for ingesting the logs to Logging API. Note that using the structured logging Json format you cannot control the log name where the logs will be ingested. The logs will be ingested into the project that hosts the environment where your application is running. The configuration logDestinationProjectId will be ignored.

Samples

Samples are in the samples/ directory.

Sample	Source Code	Try it
Quickstart	source code
Example Enhancer	source code

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Supported Java Versions

Java 8 or above is required for using this client.

Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).

For new development

In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new development.

Keeping production systems current

Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).

Legacy support

Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.

Where to find specific information

The latest versions and the supported Java versions are identified on the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME and on google-cloud-java.

Versioning

This library follows Semantic Versioning.

It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

Apache 2.0 - See LICENSE for more information.

CI Status

Java Version	Status
Java 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.