Logging client libraries

This page shows how to get started with the Cloud Client Libraries for theCloud Logging API. Client libraries make it easier to accessGoogle Cloud APIs from a supported language. Although you can useGoogle Cloud APIs directly by making raw requests to the server, clientlibraries provide simplifications that significantly reduce the amount of codeyou need to write.

Read more about the Cloud Client Librariesand the older Google API Client Libraries inClient libraries explained.

Cloud Logging client libraries are idiomatic interfaces around the API.Client libraries provide an integration option with Logging.You can use client libraries in addition to using an agent.Some Google Cloud services, such as Google Kubernetes Engine,contain an integrated logging agent that sendsthe data written tostdout orstderr as logs to Cloud Logging.

  • For App Engine flexible environment and Cloud Run functions, you can use the integrated agent.
  • For Android, we recommend that you use Firebase for logging.For more information, seeWrite and view logs.

To learn more about setting upLogging using a language runtime, seeSetting up Language Runtimes.

Incoming log entries with timestamps that are more than thelogs retention period in the past or thatare more than 24 hours in the future are discarded.

Install the client library

C++

SeeSetting up a C++ development environmentfor details about this client library's requirements and install dependencies.

C#

dotnet add package Google.Cloud.Logging.V2

For more information, seeSetting Up a C# Development Environment.

Go

go get cloud.google.com/go/logging

For more information, seeSetting Up a Go Development Environment.

Java

If you are usingMaven witha BOM, add the following to yourpom.xml file:

<dependencyManagement>  <dependencies>    <dependency>      <groupId>com.google.cloud</groupId>      <artifactId>libraries-bom</artifactId>      <version>26.55.0</version>      <type>pom</type>      <scope>import</scope>    </dependency>  </dependencies></dependencyManagement><dependencies>  <dependency>    <groupId>com.google.cloud</groupId>    <artifactId>google-cloud-logging</artifactId>  </dependency>  <!--...</dependencies>

If you are usingMavenwithout a BOM, add this to your dependencies:

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

If you are usingGradle,add the following to your dependencies:

implementationplatform('com.google.cloud:libraries-bom:26.72.0')implementation'com.google.cloud:google-cloud-logging'

If you are usingsbt, addthe following to your dependencies:

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

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

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.

For more information, seeSetting Up a Java Development Environment.

Node.js

npm install @google-cloud/logging

For more information, seeSetting Up a Node.js Development Environment.

PHP

composer require google/cloud-logging

For more information, seeUsing PHP on Google Cloud.

Python

pip install --upgrade google-cloud-logging
Install thegoogle-cloud-logging library, not an explicitly versioned library.

For more information, seeSetting Up a Python Development Environment.

Ruby

gem install google-cloud-logging

For more information, seeSetting Up a Ruby Development Environment.

Set up authentication

To authenticate calls to Google Cloud APIs, client libraries supportApplication Default Credentials (ADC);the libraries look for credentials in a set of defined locations and use those credentialsto authenticate requests to the API. With ADC, you can makecredentials available to your application in a variety of environments, such as localdevelopment or production, without needing to modify your application code.

For production environments, the way you set up ADC depends on the serviceand context. For more information, seeSet up Application Default Credentials.

For a local development environment, you can set up ADC with the credentialsthat are associated with your Google Account:

  1. Install the Google Cloud CLI. After installation,initialize the Google Cloud CLI by running the following command:

    gcloudinit

    If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  2. If you're using a local shell, then create local authentication credentials for your user account:

    gcloudauthapplication-defaultlogin

    You don't need to do this if you're using Cloud Shell.

    If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

    A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.

Use the client library

The following example shows how to use the client library.

C++

#include"google/cloud/logging/v2/logging_service_v2_client.h"#include"google/cloud/project.h"#include <iostream>intmain(intargc,char*argv[])try{if(argc!=2){std::cerr <<"Usage: " <<argv[0] <<" project-id\n";return1;}namespacelogging=::google::cloud::logging_v2;autoclient=logging::LoggingServiceV2Client(logging::MakeLoggingServiceV2Connection());autoconstproject=google::cloud::Project(argv[1]);for(autol:client.ListLogs(project.FullName())){if(!l)throwstd::move(l).status();std::cout <<*l <<"\n";}return0;}catch(google::cloud::Statusconst&status){std::cerr <<"google::cloud::Status thrown: " <<status <<"\n";return1;}

C#

usingSystem;// Imports the Google Cloud Logging client libraryusingGoogle.Cloud.Logging.V2;usingGoogle.Cloud.Logging.Type;usingSystem.Collections.Generic;usingGoogle.Api;namespaceGoogleCloudSamples{publicclassQuickStart{publicstaticvoidMain(string[]args){// Your Google Cloud Platform project ID.stringprojectId="YOUR-PROJECT-ID";// Instantiates a client.varclient=LoggingServiceV2Client.Create();// Prepare new log entry.LogEntrylogEntry=newLogEntry();stringlogId="my-log";LogNamelogName=newLogName(projectId,logId);logEntry.LogNameAsLogName=logName;logEntry.Severity=LogSeverity.Info;// Create log entry message.stringmessage="Hello World!";stringmessageId=DateTime.Now.Millisecond.ToString();TypemyType=typeof(QuickStart);stringentrySeverity=logEntry.Severity.ToString().ToUpper();logEntry.TextPayload=$"{messageId} {entrySeverity} {myType.Namespace}.LoggingSample - {message}";// Set the resource type to control which GCP resource the log entry belongs to.// See the list of resource types at:// https://cloud.google.com/logging/docs/api/v2/resource-list// This sample uses resource type 'global' causing log entries to appear in the// "Global" resource list of the Developers Console Logs Viewer://  https://console.cloud.google.com/logs/viewerMonitoredResourceresource=newMonitoredResource{Type="global"};// Create dictionary object to add custom labels to the log entry.IDictionary<string,string>entryLabels=newDictionary<string,string>();entryLabels.Add("size","large");entryLabels.Add("color","red");// Add log entry to collection for writing. Multiple log entries can be added.IEnumerable<LogEntry>logEntries=newLogEntry[]{logEntry};// Write new log entry.client.WriteLogEntries(logName,resource,entryLabels,logEntries);Console.WriteLine("Log Entry created.");}}}

Go

// Sample logging-quickstart writes a log entry to Cloud Logging.packagemainimport("context""fmt""log""cloud.google.com/go/logging")funcmain(){ctx:=context.Background()// Sets your Google Cloud Platform project ID.projectID:="YOUR_PROJECT_ID"// Creates a client.client,err:=logging.NewClient(ctx,projectID)iferr!=nil{log.Fatalf("Failed to create client: %v",err)}// Sets the name of the log to write to.logName:="my-log"// Selects the log to write to.logger:=client.Logger(logName)// Sets the data to log.text:="Hello, world!"// Adds an entry to the log buffer.logger.Log(logging.Entry{Payload:text})// Closes the client and flushes the buffer to the Cloud Logging// service.iferr:=client.Close();err!=nil{log.Fatalf("Failed to close client: %v",err)}fmt.Printf("Logged: %v\n",text)}

Java

importcom.google.cloud.MonitoredResource;importcom.google.cloud.logging.LogEntry;importcom.google.cloud.logging.Logging;importcom.google.cloud.logging.LoggingOptions;importcom.google.cloud.logging.Payload.StringPayload;importcom.google.cloud.logging.Severity;importjava.util.Collections;/** * This sample demonstrates writing logs using the Cloud Logging API. The library also offers a * java.util.logging Handler `com.google.cloud.logging.LoggingHandler` Logback integration is also * available : * https://github.com/googleapis/google-cloud-java/tree/master/google-cloud-clients/google-cloud-contrib/google-cloud-logging-logback * Using the java.util.logging handler / Logback appender should be preferred to using the API * directly. */publicclassQuickstartSample{/** Expects a new or existing Cloud log name as the first argument. */publicstaticvoidmain(String...args)throwsException{// The name of the log to write toStringlogName=args[0];// "my-log";StringtextPayload="Hello, world!";// Instantiates a clienttry(Logginglogging=LoggingOptions.getDefaultInstance().getService()){LogEntryentry=LogEntry.newBuilder(StringPayload.of(textPayload)).setSeverity(Severity.ERROR).setLogName(logName).setResource(MonitoredResource.newBuilder("global").build()).build();// Writes the log entry asynchronouslylogging.write(Collections.singleton(entry));// Optional - flush any pending log entries just before Logging is closedlogging.flush();}System.out.printf("Logged: %s%n",textPayload);}}

Node.js

// Imports the Google Cloud client libraryconst{Logging}=require('@google-cloud/logging');asyncfunctionquickstart(projectId='YOUR_PROJECT_ID',// Your Google Cloud Platform project IDlogName='my-log'// The name of the log to write to){// Creates a clientconstlogging=newLogging({projectId});// Selects the log to write toconstlog=logging.log(logName);// The data to write to the logconsttext='Hello, world!';// The metadata associated with the entryconstmetadata={resource:{type:'global'},// See: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverityseverity:'INFO',};// Prepares a log entryconstentry=log.entry(metadata,text);asyncfunctionwriteLog(){// Writes the log entryawaitlog.write(entry);console.log(`Logged:${text}`);}writeLog();}

PHP

# Includes the autoloader for libraries installed with composerrequire __DIR__ . '/vendor/autoload.php';# Imports the Google Cloud client libraryuse Google\Cloud\Logging\LoggingClient;# Your Google Cloud Platform project ID$projectId = 'YOUR_PROJECT_ID';# Instantiates a client$logging = new LoggingClient([    'projectId' => $projectId]);# The name of the log to write to$logName = 'my-log';# Selects the log to write to$logger = $logging->logger($logName);# The data to log$text = 'Hello, world!';# Creates the log entry$entry = $logger->entry($text);# Writes the log entry$logger->write($entry);echo 'Logged ' . $text;

Python

# Imports the Google Cloud client libraryfromgoogle.cloudimportlogging# Instantiates a clientlogging_client=logging.Client()# The name of the log to write tolog_name="my-log"# Selects the log to write tologger=logging_client.logger(log_name)# The data to logtext="Hello, world!"# Writes the log entrylogger.log_text(text)print("Logged:{}".format(text))

Ruby

# Imports the Google Cloud client libraryrequire"google/cloud/logging"# Instantiates a clientlogging=Google::Cloud::Logging.new# Prepares a log entryentry=logging.entry# payload = "The data you want to log"entry.payload=payload# log_name = "The name of the log to write to"entry.log_name=log_name# The resource associated with the dataentry.resource.type="global"# Writes the log entrylogging.write_entriesentryputs"Logged#{entry.payload}"

Code samples

For all code samples, seeAll logging samples.

For Cloud Shell tutorials that illustrate how to write structured logs,see the following:

Go

For step-by-step guidance on running a client library in Cloud Shell Editor:

  1. ClickGuide me.

  2. You see a panelLearn. ClickStart to follow the tutorial.

Guide me

Java

For step-by-step guidance on running a client library in Cloud Shell Editor:

  1. ClickGuide me.

  2. You see a panelLearn. ClickStart to follow the tutorial.

Guide me

Node.js

For step-by-step guidance on running a client library in Cloud Shell Editor:

  1. ClickGuide me.

  2. You see a panelLearn. ClickStart to follow the tutorial.

Guide me

Python

For step-by-step guidance on running a client library in Cloud Shell Editor:

  1. ClickGuide me.

  2. You see a panelLearn. ClickStart to follow the tutorial.

Guide me

Additional resources

C++

The following list contains links to more resources related to theclient library for C++:

C#

The following list contains links to more resources related to theclient library for C#:

Go

The following list contains links to more resources related to theclient library for Go:

Java

The following list contains links to more resources related to theclient library for Java:

Node.js

The following list contains links to more resources related to theclient library for Node.js:

PHP

The following list contains links to more resources related to theclient library for PHP:

Python

The following list contains links to more resources related to theclient library for Python:

Ruby

The following list contains links to more resources related to theclient library for Ruby:

Additional client libraries

In addition to the libraries previously listed, a set of integration librariesare available to support using popular third-party logging libraries withCloud Logging.

LanguageLibrary
C#ASP.NET
C#log4Net
Javalogback
Nodebunyan
Nodewinston
PHPPSR-3

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.