This page shows how to get started with the Cloud Client Libraries for the Cloud Logging API. Client libraries make it easier to access Google Cloud APIs from a supported language. Although you can use Google Cloud APIs directly by making raw requests to the server, client libraries provide simplifications that significantly reduce the amount of code you need to write.
Read more about the Cloud Client Libraries and the older Google API Client Libraries in Client 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 sends
the data written to stdout
or stderr
as logs to Cloud Logging.
- For App Engine flexible environment and Cloud Run functions, you can use the integrated agent.
- For Compute Engine, you can install an agent that collects both logs and metrics.
- For Android, we recommend that you use Firebase for logging. For more information, see Write and view logs.
To learn more about setting up Logging using a language runtime, see Setting up Language Runtimes.
Incoming log entries with timestamps that are more than the logs retention period in the past or that are more than 24 hours in the future are discarded.
Install the client library
C++
See Setting up a C++ development environment for details about this client library's requirements and install dependencies.
C#
dotnet add package Google.Cloud.Logging.V2
For more information, see Setting Up a C# Development Environment.
Go
go get cloud.google.com/go/logging
For more information, see Setting Up a Go Development Environment.
Java
If you are using Maven with
a BOM, add the following to your pom.xml
file:
If you are using Maven without a BOM, add this to your dependencies:
If you are using Gradle, add the following to your dependencies:
If you are using sbt, add the following to your dependencies:
If you're using Visual Studio Code, IntelliJ, or Eclipse, 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.
For more information, see Setting Up a Java Development Environment.
Node.js
npm install --save @google-cloud/logging
For more information, see Setting Up a Node.js Development Environment.
PHP
composer require google/cloud-logging
For more information, see Using PHP on Google Cloud.
Python
pip install --upgrade google-cloud-logging
google-cloud-logging
library, not an explicitly versioned library.
For more information, see Setting Up a Python Development Environment.
Ruby
gem install google-cloud-logging
For more information, see Setting Up a Ruby Development Environment.
Set up authentication
To authenticate calls to Google Cloud APIs, client libraries support Application Default Credentials (ADC); the libraries look for credentials in a set of defined locations and use those credentials to authenticate requests to the API. With ADC, you can make credentials available to your application in a variety of environments, such as local development or production, without needing to modify your application code.For production environments, the way you set up ADC depends on the service and context. For more information, see Set up Application Default Credentials.
For a local development environment, you can set up ADC with the credentials that are associated with your Google Account:
-
Install the Google Cloud CLI, then initialize it by running the following command:
gcloud init
-
If you're using a local shell, then create local authentication credentials for your user account:
gcloud auth application-default login
You don't need to do this if you're using Cloud Shell.
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++
C#
Go
Java
Node.js
PHP
Python
Ruby
Code samples
For all code samples, see All 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:
Click Guide me.
You see a panel Learn. Click Start to follow the tutorial.
Java
For step-by-step guidance on running a client library in Cloud Shell Editor:
Click Guide me.
You see a panel Learn. Click Start to follow the tutorial.
Node.js
For step-by-step guidance on running a client library in Cloud Shell Editor:
Click Guide me.
You see a panel Learn. Click Start to follow the tutorial.
Python
For step-by-step guidance on running a client library in Cloud Shell Editor:
Click Guide me.
You see a panel Learn. Click Start to follow the tutorial.
Additional resources
C++
The following list contains links to more resources related to the client library for C++:
C#
The following list contains links to more resources related to the client library for C#:
Go
The following list contains links to more resources related to the client library for Go:
Java
The following list contains links to more resources related to the client library for Java:
Node.js
The following list contains links to more resources related to the client library for Node.js:
PHP
The following list contains links to more resources related to the client library for PHP:
Python
The following list contains links to more resources related to the client library for Python:
Ruby
The following list contains links to more resources related to the client library for Ruby:
Additional client libraries
In addition to the libraries previously listed, a set of integration libraries are available to support using popular third-party logging libraries with Cloud Logging.
Language | Library |
---|---|
C# | ASP.NET |
C# | log4Net |
Java | logback |
Node | bunyan |
Node | winston |
PHP | PSR-3 |