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_CATALOG_SERVICE_ENDPOINT=...overrides theEndpointOption(which defaults to "dataplex.googleapis.com") used byMakeCatalogServiceConnection().
GOOGLE_CLOUD_CPP_CONTENT_SERVICE_ENDPOINT=...overrides theEndpointOption(which defaults to "dataplex.googleapis.com") used byMakeContentServiceConnection().
GOOGLE_CLOUD_CPP_DATAPLEX_SERVICE_ENDPOINT=...overrides theEndpointOption(which defaults to "dataplex.googleapis.com") used byMakeDataplexServiceConnection().
GOOGLE_CLOUD_CPP_DATA_SCAN_SERVICE_ENDPOINT=...overrides theEndpointOption(which defaults to "dataplex.googleapis.com") used byMakeDataScanServiceConnection().
GOOGLE_CLOUD_CPP_DATA_TAXONOMY_SERVICE_ENDPOINT=...overrides theEndpointOption(which defaults to "dataplex.googleapis.com") used byMakeDataTaxonomyServiceConnection().
GOOGLE_CLOUD_CPP_METADATA_SERVICE_ENDPOINT=...overrides theEndpointOption(which defaults to "dataplex.googleapis.com") used byMakeMetadataServiceConnection().
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 setGOOGLE_CLOUD_CPP_ENABLE_CLOGto produce any output on the program's console.
See Also
google::cloud::LoggingComponentsOptionGOOGLE_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-09-04 UTC."],[[["\u003cp\u003eThis document provides documentation for various versions of the Dataplex C++ library, ranging from version 2.11.0 up to the latest release candidate, 2.37.0-rc.\u003c/p\u003e\n"],["\u003cp\u003eThe library's behavior can be configured using environment variables, such as overriding default endpoints for services like Catalog, Content, Dataplex, Data Scan, Data Taxonomy, and Metadata.\u003c/p\u003e\n"],["\u003cp\u003eTracing for gRPC calls can be enabled by setting the \u003ccode\u003eGOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc\u003c/code\u003e environment variable, with further customization options available through \u003ccode\u003eGOOGLE_CLOUD_CPP_TRACING_OPTIONS\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGOOGLE_CLOUD_CPP_ENABLE_CLOG\u003c/code\u003e variable turns on logging in the library when set to "yes", which is required to see the tracing output if no other logging backend is configured.\u003c/p\u003e\n"],["\u003cp\u003eThere is an option to set the default GCP Project via \u003ccode\u003eGOOGLE_CLOUD_PROJECT\u003c/code\u003e, although it does not have any effect on the library.\u003c/p\u003e\n"]]],[],null,["Version 2.29.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/dataplex/latest/dataplex-env)\n- [2.41.0](/cpp/docs/reference/dataplex/2.41.0/dataplex-env)\n- [2.40.0](/cpp/docs/reference/dataplex/2.40.0/dataplex-env)\n- [2.39.0](/cpp/docs/reference/dataplex/2.39.0/dataplex-env)\n- [2.38.0](/cpp/docs/reference/dataplex/2.38.0/dataplex-env)\n- [2.37.0](/cpp/docs/reference/dataplex/2.37.0/dataplex-env)\n- [2.36.0](/cpp/docs/reference/dataplex/2.36.0/dataplex-env)\n- [2.35.0](/cpp/docs/reference/dataplex/2.35.0/dataplex-env)\n- [2.34.0](/cpp/docs/reference/dataplex/2.34.0/dataplex-env)\n- [2.33.0](/cpp/docs/reference/dataplex/2.33.0/dataplex-env)\n- [2.32.0](/cpp/docs/reference/dataplex/2.32.0/dataplex-env)\n- [2.31.0](/cpp/docs/reference/dataplex/2.31.0/dataplex-env)\n- [2.30.0](/cpp/docs/reference/dataplex/2.30.0/dataplex-env)\n- [2.29.0](/cpp/docs/reference/dataplex/2.29.0/dataplex-env)\n- [2.28.0](/cpp/docs/reference/dataplex/2.28.0/dataplex-env)\n- [2.27.0](/cpp/docs/reference/dataplex/2.27.0/dataplex-env)\n- [2.26.0](/cpp/docs/reference/dataplex/2.26.0/dataplex-env)\n- [2.25.1](/cpp/docs/reference/dataplex/2.25.1/dataplex-env)\n- [2.24.0](/cpp/docs/reference/dataplex/2.24.0/dataplex-env)\n- [2.23.0](/cpp/docs/reference/dataplex/2.23.0/dataplex-env)\n- [2.22.1](/cpp/docs/reference/dataplex/2.22.1/dataplex-env)\n- [2.21.0](/cpp/docs/reference/dataplex/2.21.0/dataplex-env)\n- [2.20.0](/cpp/docs/reference/dataplex/2.20.0/dataplex-env)\n- [2.19.0](/cpp/docs/reference/dataplex/2.19.0/dataplex-env)\n- [2.18.0](/cpp/docs/reference/dataplex/2.18.0/dataplex-env)\n- [2.17.0](/cpp/docs/reference/dataplex/2.17.0/dataplex-env)\n- [2.16.0](/cpp/docs/reference/dataplex/2.16.0/dataplex-env)\n- [2.15.1](/cpp/docs/reference/dataplex/2.15.1/dataplex-env)\n- [2.14.0](/cpp/docs/reference/dataplex/2.14.0/dataplex-env)\n- [2.13.0](/cpp/docs/reference/dataplex/2.13.0/dataplex-env)\n- [2.12.0](/cpp/docs/reference/dataplex/2.12.0/dataplex-env)\n- [2.11.0](/cpp/docs/reference/dataplex/2.11.0/dataplex-env) \n\nEnvironment Variables\n=====================\n\nA 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.\n\nEndpoint Overrides\n------------------\n\n- `GOOGLE_CLOUD_CPP_CATALOG_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"dataplex.googleapis.com\") used by `MakeCatalogServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_CONTENT_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"dataplex.googleapis.com\") used by `MakeContentServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_DATAPLEX_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"dataplex.googleapis.com\") used by `MakeDataplexServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_DATA_SCAN_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"dataplex.googleapis.com\") used by `MakeDataScanServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_DATA_TAXONOMY_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"dataplex.googleapis.com\") used by `MakeDataTaxonomyServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_METADATA_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"dataplex.googleapis.com\") used by `MakeMetadataServiceConnection()`.\n\n###### See Also\n\n[`google::cloud::EndpointOption`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1EndpointOption.html)\n\nLogging\n-------\n\n`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.\n\n###### See Also\n\n[`google::cloud::LoggingComponentsOption`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1LoggingComponentsOption.html)`GOOGLE_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.\n\n###### See Also\n\n[`google::cloud::GrpcTracingOptionsOption`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1GrpcTracingOptionsOption.html)`GOOGLE_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.\n\n###### See Also\n\n[`google::cloud::LogBackend`](https://cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1LogBackend.html)\n\n###### See Also\n\n[`google::cloud::LogSink`](https://cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1LogSink.html)\n\nSetting the Default Project\n---------------------------\n\n`GOOGLE_CLOUD_PROJECT=...`: is used in examples and integration tests to configure the GCP project. This has no effect in the library."]]
