Skip to content

Commit 288a5ee

Browse files
authored
doc(spanner): add GOOGLE_CLOUD_CPP_TRACING_OPTIONS description (#11057)
The Spanner "env-logging" section was missing a description for `GOOGLE_CLOUD_CPP_TRACING_OPTIONS`, so add one, and make the shape of the entire section match that of Bigtable. Also add a missing back quote to the Bigtable text.
1 parent 9c01a35 commit 288a5ee

2 files changed

Lines changed: 13 additions & 7 deletions

File tree

google/cloud/bigtable/doc/environment-variables.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ regular RPC calls and streaming RPC calls.
2222

2323
@see google::cloud::TracingComponentsOption
2424

25-
GOOGLE_CLOUD_CPP_TRACING_OPTIONS=...`: modifies the behavior of gRPC tracing,
25+
`GOOGLE_CLOUD_CPP_TRACING_OPTIONS=...`: modifies the behavior of gRPC tracing,
2626
including whether messages will be output on multiple lines, or whether
2727
string/bytes fields will be truncated.
2828

google/cloud/spanner/doc/environment-variables.dox

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ environment variables are convenient when troubleshooting problems.
88

99
@section spanner-env-logging Logging
1010

11-
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC
12-
calls. The library injects an additional Stub decorator that prints each gRPC
13-
request and response. Unless you have configured you own logging backend,
14-
you should also set `GOOGLE_CLOUD_CPP_ENABLE_CLOG` to produce any output on
15-
the program's console.
11+
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC calls.
12+
The library injects an additional Stub decorator that prints each gRPC
13+
request and response. Unless you have configured you own logging backend, you
14+
should also set `GOOGLE_CLOUD_CPP_ENABLE_CLOG` to produce any output on the
15+
program's console.
1616

1717
`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc-streams`: turns on tracing for streaming
1818
gRPC calls, such as `Client::Read()`, `Client::ExecuteQuery()`, and
@@ -24,7 +24,13 @@ regular RPC calls and streaming RPC calls.
2424

2525
@see google::cloud::TracingComponentsOption
2626

27-
`GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes`: turns on logging in the library, basically
27+
`GOOGLE_CLOUD_CPP_TRACING_OPTIONS=...`: modifies the behavior of gRPC tracing,
28+
including whether messages will be output on multiple lines, or whether
29+
string/bytes fields will be truncated.
30+
31+
@see google::cloud::TracingOptionsOption
32+
33+
`GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes`: turns on logging in the library. Basically
2834
the library always "logs" but the logging infrastructure has no backend to
2935
actually print anything until the application sets a backend or they set this
3036
environment variable.

0 commit comments

Comments
 (0)