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 details the logging capabilities and configurations for Google Cloud Platform C++ client libraries, emphasizing that logging is developer-controlled and not used to report errors."],["The latest version available is 2.37.0-rc, with a comprehensive list of previous versions accessible for each of the logging versions."],["Logging is designed to be low-cost, potentially disabled at compile time, and easily integrated with complex objects and the C++ iostream classes."],["To enable logging, developers must configure the log destination using a backend and specify the components to be traced, using either the `LogSink` class and `TracingComponentsOption` or environment variables like `GOOGLE_CLOUD_CPP_ENABLE_CLOG` and `GOOGLE_CLOUD_CPP_ENABLE_TRACING`."],["Logs can be outputted to `std::clog` by using the environment variable `GOOGLE_CLOUD_CPP_ENABLE_CLOG`, or by calling the `google::cloud::LogSink::EnableStdClog()` function, and will automatically flush when a log message at severity `WARNING` or higher is encountered."]]],[]]
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