This page shows how to get started with the Cloud Client Libraries for the Cloud Logging API. Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Cloud Logging client libraries are idiomatic interfaces around the API. Client libraries provide an integration option with Logging, in addition to the Logging agent available by default in most Google Cloud services. To learn more about setting up Logging using a language runtime, see Setting up Language Runtimes.
Installing the client library
C#
For more information, see Setting Up a C# Development Environment.
Install-Package Google.Cloud.Logging.V2
Go
For more information, see Setting Up a Go Development Environment.
go get -u cloud.google.com/go/logging
Java
For more information, see Setting Up a Java Development Environment.
Maven を BOM ありで使用している場合は、次のものを pom.xml
ファイルに追加します。
Maven を BOM なしで使用している場合は、次のものを依存関係に追加します。
Gradle を使用している場合は、次のものを依存関係に追加します。
sbt を使用している場合は、次のものを依存関係に追加します。
IntelliJ または Eclipse を使用している場合は、次の IDE プラグインを使用してプロジェクトにクライアント ライブラリを追加できます。
プラグインでは、サービス アカウントのキー管理などの追加機能も提供されます。詳細は各プラグインのドキュメントをご覧ください。
Node.js
For more information, see Setting Up a Node.js Development Environment.
npm install --save @google-cloud/logging
PHP
For more information, see Using PHP on Google Cloud.
composer require google/cloud-logging
Python
For more information, see Setting Up a Python Development Environment.
pip install --upgrade google-cloud-loggingInstall the
google-cloud-logging
library, not an explicitly versioned library.
Ruby
For more information, see Setting Up a Ruby Development Environment.
gem install google-cloud-logging
Setting up authentication
To run the client library, you must first set up authentication by creating a service account and setting an environment variable. Complete the following steps to set up authentication. For other ways to authenticate, see the GCP authentication documentation.
Cloud Console
-
Cloud Console で、[サービス アカウント キーの作成] ページに移動します。
[サービス アカウント キーの作成] ページに移動 - [サービス アカウント] リストから [新しいサービス アカウント] を選択します。
- [サービス アカウント名] フィールドに名前を入力します。
[ロール] リストから、プロジェクト > オーナー
- [作成] をクリックします。キーが含まれている JSON ファイルがパソコンにダウンロードされます。
コマンドライン
ローカルマシン上の Cloud SDK を使用するか、または Cloud Shell 内で以下のコマンドを実行できます。
-
サービス アカウントを作成します。NAME をサービス アカウントの名前に置き換えます。
gcloud iam service-accounts create NAME
-
サービス アカウントに権限を付与します。PROJECT_ID を実際のプロジェクト ID に置き換えます。
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:NAME@PROJECT_ID.iam.gserviceaccount.com" --role="roles/owner"
-
キーファイルを生成します。FILE_NAME はキーファイルの名前に置き換えてください。
gcloud iam service-accounts keys create FILE_NAME.json --iam-account=NAME@PROJECT_ID.iam.gserviceaccount.com
環境変数 GOOGLE_APPLICATION_CREDENTIALS
を設定して、アプリケーション コードに認証情報を指定します。[PATH] は、サービス アカウント キーが含まれる JSON ファイルのファイルパスに置き換えます。この変数は現在のシェル セッションにのみ適用されるため、新しいセッションを開く場合は、変数を再度設定します。
Linux または macOS
export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
例:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"
Windows
PowerShell を使用する場合:
$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"
例:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"
コマンド プロンプトを使用する場合:
set GOOGLE_APPLICATION_CREDENTIALS=[PATH]
Using the client library
The following example shows how to use the client library.
C#
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
PHP
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Ruby
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
The following sections provide additional code samples for writing and managing logs in Logging. As some features are omitted, the language documentation for each library is the authoritative reference.
Log entries
Logs consist of individual log entries
in structured format, with fields like
resource
, sourceLocation
, labels
, and trace
that give additional
context to each log. For more information about log entries, see
Basic concepts.
Write structured logs
This sample demonstrates writing log entries.
C#
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
PHP
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Ruby
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Write standard logs
Some libraries support writing structured logs using the standard library logging syntax native to the language. This example demonstrates how to reconfigure the standard log-writing interface to write to Cloud Logging.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Write request logs
This sample demonstrates logging a supported HttpRequest datatype to Logging.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
List log entries
This sample demonstrates listing the log entries of a given logger. The log
names returned are in resource format; they are URL-encoded and the log names
are prefixed by /projects/PROJECT_ID/logs/
.
C#
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
PHP
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Ruby
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
There are also other ways to view your log entries in Logging:
- To read log entries using the Google Cloud Console, see Using the Logs Explorer.
- To read log entries through the Logging API, see the
entries.list
method. - To read log entries using the
gcloud
command-line tool, see Reading log entries.
Logs
A log, also called a log stream, is the set of log entries that have the same
full resource name. The full resource name is equivalent to the LogName
field
in the LogEntry
. For more
information about logs, see Available Logs
and Basic concepts.
List logs
This example demonstrates listing the names of available Logs.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Delete a log
This example demonstrates deleting a log by deleting all its entries. A log with no entries does not appear in the list of Cloud project logs. Log entries can be explicitly deleted, or they can expire according to the Logging retention policy. If you write new log entries, Logging ingests them.
C#
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
PHP
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Ruby
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Log Sinks
You route logs by creating sinks that send certain log entries to specific destinations. For more information about sinks, see Logs exports.
Create a sink
C#
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
PHP
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Ruby
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Get a sink
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
List sinks
C#
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
PHP
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Ruby
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Update a sink
C#
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
PHP
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Ruby
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Delete a sink
C#
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Go
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Java
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Node.js
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
PHP
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Python
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Ruby
To learn how to install and use the client library for Logging, see the Logging Client Libraries.
Additional resources
C#
Go
Java
Node.js
PHP
Python
Ruby
Additional client libraries
In addition to the libraries shown above, 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 |
Ruby | stackdriver |