Stay organized with collections Save and categorize content based on your preferences.
The client libraries never use logging to report errors, but logging can be enabled to help troubleshoot problems when the last error message does not provide a good enough indication of the root cause.
In general, we abide by the following principles:
std::clog
immediately before a GCP_LOG(FATAL)
terminates the process.#ifdef
/#endif
directives around them.if()
statement. At the very least it should not incur additional memory allocations or locks.The application needs to do two things to enable logging:
*Connection
object with a TracingComponentsOption. Consult the documentation for each *Client
class to find what tracing components are available.At run-time, setting the GOOGLE_CLOUD_CPP_ENABLE_CLOG
to a non-empty value configures a LogBackend that uses std::clog
. Likewise, setting the GOOGLE_CLOUD_CPP_ENABLE_TRACING=a,b
will enable tracing for components a
and b
across all client objects. The most common components are auth
, rpc
, and rpc-streams
.
Note that while std::clog
is buffered, the framework will flush any log message at severity WARNING
or higher.
Use the GCP_LOG()
macro to log from a Google Cloud Platform C++ library:
void LibraryCode(ComplexThing const& thing) {
GCP_LOG(INFO) << "I am here";
if (thing.is_bad()) {
GCP_LOG(ERROR) << "Poor thing is bad: " << thing;
}
}
Example: Enable Logs to std::clog
To enable logs to std::clog
the application can call:
void AppCode() {
google::cloud::LogSink::EnableStdClog();
}
As previously noted, this can be switched at run-time using the GOOGLE_CLOUD_CPP_ENABLE_CLOG
environment variable.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["This document provides versioned documentation for logging in Google Cloud Platform C++ client libraries, ranging from version 2.10.1 up to the latest release candidate 2.37.0-rc."],["Logging in these libraries is designed to be controlled by the application developer and is not enabled by default, with the libraries only emitting to `std::clog` when a `GCP_LOG(FATAL)` is encountered."],["Enabling logging requires configuring a backend destination using `LogSink` and specifying which components to log, often done through `TracingComponentsOption` when initializing `*Connection` objects."],["Logs can be enabled at runtime by setting environment variables such as `GOOGLE_CLOUD_CPP_ENABLE_CLOG` for `std::clog` output and `GOOGLE_CLOUD_CPP_ENABLE_TRACING` to specify tracing components."],["The logging framework is designed to be low-cost, allowing for compile-time disabling, minimal overhead for disabled log levels, and easy logging of complex objects."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4