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_API_GATEWAY_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "apigateway.googleapis.com") used by MakeApiGatewayServiceConnection().
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 document provides a comprehensive list of API Gateway environment variables and their corresponding versions, starting from version 2.11.0 up to the latest release candidate 2.37.0-rc."],["You can override the default endpoint for the API Gateway service using the `GOOGLE_CLOUD_CPP_API_GATEWAY_SERVICE_ENDPOINT` environment variable."],["Tracing for gRPC calls can be enabled by setting `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`, which will log each request and response."],["Logging within the library can be activated by setting the `GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes` environment variable, which allows the library to print log output."],["The environment variable `GOOGLE_CLOUD_PROJECT` is used in examples and tests to set the GCP project, however it does not impact the functionality of the library itself."]]],[]]
