A number of environment variables can be used to configure the behavior of the library. There are also functions to configure this behavior in code. The environment variables are convenient when troubleshooting problems.
Endpoint Overrides
GOOGLE_CLOUD_CPP_EKM_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "cloudkms.googleapis.com") used by MakeEkmServiceConnection().
GOOGLE_CLOUD_CPP_KEY_DASHBOARD_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "kmsinventory.googleapis.com") used by MakeKeyDashboardServiceConnection().
GOOGLE_CLOUD_CPP_KEY_MANAGEMENT_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "cloudkms.googleapis.com") used by MakeKeyManagementServiceConnection().
GOOGLE_CLOUD_CPP_KEY_TRACKING_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "kmsinventory.googleapis.com") used by MakeKeyTrackingServiceConnection().
GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc: turns on tracing for most gRPC calls. The library injects an additional Stub decorator that prints each gRPC request and response. Unless you have configured your own logging backend, you should also set GOOGLE_CLOUD_CPP_ENABLE_CLOG to produce any output on the program's console.
See Also
google::cloud::TracingComponentsOptionGOOGLE_CLOUD_CPP_TRACING_OPTIONS=...: modifies the behavior of gRPC tracing, including whether messages will be output on multiple lines, or whether string/bytes fields will be truncated.
See Also
google::cloud::GrpcTracingOptionsOptionGOOGLE_CLOUD_CPP_ENABLE_CLOG=yes: turns on logging in the library, basically the library always "logs" but the logging infrastructure has no backend to actually print anything until the application sets a backend or they set this environment variable.
[[["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-03-05 UTC."],[[["This page provides documentation for various versions of the C++ library, specifically ranging from version 2.10.1 up to the release candidate 2.37.0-rc, with each version linking to its own documentation."],["The library's behavior can be configured using environment variables, which is particularly helpful when debugging issues, in addition to the ability to configure it directly within the code."],["Endpoint overrides can be set for services such as `EkmService`, `KeyDashboardService`, `KeyManagementService`, and `KeyTrackingService` using their respective environment variables."],["Tracing for gRPC calls can be enabled via the `GOOGLE_CLOUD_CPP_ENABLE_TRACING` variable, with options to modify the behavior of the tracing functionality using the `GOOGLE_CLOUD_CPP_TRACING_OPTIONS` variable."],["Logging in the library can be turned on using `GOOGLE_CLOUD_CPP_ENABLE_CLOG`, and while the library always logs, a backend must be set or this variable needs to be defined to actually print logs."]]],[]]
