Skip to content

Commit 6b60e33

Browse files
authored
docs(storage): Update build instructions for gcs+grpc (#14833)
* docs(storage): Update build instructions for gcs+grpc * and end mark * spacing + feedback on prometheus * checkers
1 parent 38bb296 commit 6b60e33

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

google/cloud/storage/doc/storage-grpc.dox

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ differently from the REST-based implementation.
2020
[`RestEndpointOption`](@ref google::cloud::storage::RestEndpointOption).
2121
1. The cloud path endpoint (`storage.googleapis.com`) works from any hosting
2222
environment (on-prem, GKE, GCE, other cloud providers, etc.). For best
23-
performance on GCE or GKE consider we default to the direct connectivity endpoint
23+
performance on GCE or GKE we default to the direct connectivity endpoint
2424
`google-c2p:///storage.googleapis.com`.
2525
1. The [`Fields`](@ref google::cloud::storage::Fields) request parameter is
2626
passed verbatim to the backend. Some fields have different names in gRPC, and
@@ -90,4 +90,31 @@ cc_binary(
9090
)
9191
```
9292

93+
## gRPC+OpenTelemetry
94+
95+
The gRPC client will default to enabling OpenTelemetry metrics. This means that
96+
the library must be built with support for OpenTelemetry and support for the gRPC
97+
OpenTelemetry plugin. Please note metrics require using a version of gRPC > 1.64.
98+
99+
If you are using CMake to compile your application:
100+
101+
1. Build and install OpenTelemetry with the following options:
102+
```{.bash}
103+
-DWITH_ABSEIL=ON
104+
```
105+
106+
1. Build and install gRPC with the OpenTelemetry plugin enabled:
107+
108+
Build and and install gRPC with the following option:
109+
```{.bash}
110+
-DgRPC_BUILD_GRPCPP_OTEL_PLUGIN=ON
111+
```
112+
113+
If you are using Bazel and wish to disable gRPC metrics please
114+
build with the following option:
115+
116+
```{.bash}
117+
--//google/cloud/storage:enable_grpc_metrics=false
118+
```
119+
93120
*/

0 commit comments

Comments
 (0)