docs: add guides for occ, configure_client, and troubleshooting#5441
Draft
bshaffer wants to merge 7 commits intogoogleapis:mainfrom
Draft
docs: add guides for occ, configure_client, and troubleshooting#5441bshaffer wants to merge 7 commits intogoogleapis:mainfrom
bshaffer wants to merge 7 commits intogoogleapis:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5441 +/- ##
=======================================
Coverage 97.73% 97.73%
=======================================
Files 217 217
Lines 48177 48177
=======================================
Hits 47087 47087
Misses 1090 1090 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
|
The The formatting error is more complicated: Maybe we need to update |
dbolduc
reviewed
Apr 17, 2026
Member
dbolduc
left a comment
dbolduc
left a comment
There was a problem hiding this comment.
I only looked at the proxy section
|
|
||
| ### Proxy with gRPC | ||
|
|
||
| When using the gRPC transport (standard for most services), the client library |
Member
There was a problem hiding this comment.
Nope, they almost all use REST.
| .build()?; | ||
|
|
||
| let config = ClientConfig::default() | ||
| .with_http_client(http_client); |
Member
There was a problem hiding this comment.
This is not an API.
Which is why we compile our sample code.
coryan
reviewed
Apr 17, 2026
Contributor
coryan
left a comment
coryan
left a comment
There was a problem hiding this comment.
Just some drive-by comments.
Comment on lines
+39
to
+40
| If you are using a client that wraps the gRPC C-core, environment variables like | ||
| `GRPC_TRACE` and `GRPC_VERBOSITY` may also be relevant. |
Contributor
There was a problem hiding this comment.
There is never a wrapped C-core for gRPC in Rust.
Suggested change
| If you are using a client that wraps the gRPC C-core, environment variables like | |
| `GRPC_TRACE` and `GRPC_VERBOSITY` may also be relevant. |
Comment on lines
+48
to
+51
| ```bash | ||
| # Point gRPC to a CA bundle that includes your proxy's certificate | ||
| export GRPC_DEFAULT_SSL_ROOTS_FILE_PATH="/path/to/roots.pem" | ||
| ``` |
Contributor
There was a problem hiding this comment.
Nothing in Rust uses that environment variable.
Comment on lines
+40
to
+41
| export http_proxy="http://proxy.example.com:3128" | ||
| export https_proxy="http://proxy.example.com:3128" |
Contributor
There was a problem hiding this comment.
I assume this is true, but frankly I have not tested this feature.
Comment on lines
+59
to
+75
| ```rust | ||
| use google_cloud_secret_manager::v1::client::{SecretManagerClient, ClientConfig}; | ||
|
|
||
| async fn run() -> Result<(), Box<dyn std::error::Error>> { | ||
| // Configure a proxy using standard environment variables or a custom connector | ||
| let proxy = reqwest::Proxy::all("http://user:password@proxy.example.com")?; | ||
| let http_client = reqwest::Client::builder() | ||
| .proxy(proxy) | ||
| .build()?; | ||
|
|
||
| let config = ClientConfig::default() | ||
| .with_http_client(http_client); | ||
|
|
||
| let client = SecretManagerClient::new(config).await?; | ||
| Ok(()) | ||
| } | ||
| ``` |
Contributor
There was a problem hiding this comment.
Please move this to a code sample so we can compile it, it won't compile
Comment on lines
+81
to
+95
| ## 5. Logging | ||
|
|
||
| You can use the `tracing` crate to capture client logs. By initializing a | ||
| subscriber, you can debug request metadata, status codes, and events. | ||
|
|
||
| ```rust | ||
| use tracing_subscriber; | ||
|
|
||
| fn main() { | ||
| // Initialize tracing subscriber to see debug output from the client | ||
| tracing_subscriber::fmt() | ||
| .with_max_level(tracing::Level::DEBUG) | ||
| .init(); | ||
| } | ||
| ``` |
Contributor
There was a problem hiding this comment.
I think we can just reference this doc instead:
Comment on lines
+97
to
+107
| ## 6. Other common configuration options | ||
|
|
||
| The following options can be passed to the configuration builder of most | ||
| clients. | ||
|
|
||
| | Option | Type | Description | | ||
| | ----- | ----- | ----- | | ||
| | `credentials` | `Option<Credentials>` | Explicit credentials object for authentication. | | ||
| | `endpoint` | `String` | The address of the API remote host. Used for Regional Endpoints (e.g., `https://us-central1-pubsub.googleapis.com:443`) or Private Service Connect. | | ||
|
|
||
| To use API Keys [override the default credentials with API keys][override-api-keys]. |
Contributor
There was a problem hiding this comment.
Co-authored-by: Carlos O'Ryan <carlos.oryan@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.