Skip to content

Commit 4cf4566

Browse files
committed
docs(main): add OpenTelemetry-Go compatibility warning to debug.md
closes: googleapis#9267
1 parent 6ec2bb2 commit 4cf4566

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

debug.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Logging, Debugging and Telemetry
22

3-
**Warning:The OpenCensus project is obsolete and was archived on July 31st,
3+
**Warning: The OpenCensus project is obsolete and was archived on July 31st,
44
2023.** This means that any security vulnerabilities that are found will not be
55
patched. We recommend that you begin migrating to OpenCensus tracing to
66
OpenTelemetry, the successor project. See [OpenCensus](#opencensus) below for
@@ -16,7 +16,7 @@ into a system's health.
1616

1717
## Logging and debugging
1818

19-
While working with the Go Client libraries you may run into some situations
19+
While working with the Go Client Libraries you may run into some situations
2020
where you need a deeper level of understanding about what is going on in order
2121
to solve your problem. Here are some tips and tricks that you can use in these
2222
cases. *Note* that many of the tips in this section will have a performance
@@ -179,7 +179,7 @@ func main() {
179179

180180
## Telemetry
181181

182-
**Warning:The OpenCensus project is obsolete and was archived on July 31st,
182+
**Warning: The OpenCensus project is obsolete and was archived on July 31st,
183183
2023.** This means that any security vulnerabilities that are found will not be
184184
patched. We recommend that you begin migrating to OpenCensus tracing to
185185
OpenTelemetry, the successor project. See [OpenCensus](#opencensus) below for
@@ -211,7 +211,7 @@ OpenTelemetry support via an environment variable, as described below.
211211

212212
#### OpenCensus
213213

214-
**Warning:The OpenCensus project is obsolete and was archived on July 31st,
214+
**Warning: The OpenCensus project is obsolete and was archived on July 31st,
215215
2023.** This means that any security vulnerabilities that are found will not be
216216
patched. We recommend that you begin migrating to OpenCensus tracing to
217217
OpenTelemetry, the successor project.
@@ -252,6 +252,15 @@ Please refer to the following resources:
252252

253253
#### OpenTelemetry
254254

255+
**Warning: OpenTelemetry-Go ensures
256+
[compatibility](https://github.com/open-telemetry/opentelemetry-go/tree/main?tab=readme-ov-file#compatibility)
257+
with ONLY the current supported versions of the [Go
258+
language](https://go.dev/doc/devel/release#policy). This support may be narrower
259+
than the support that has been offered historically by the Go Client Libraries.
260+
Ensure that your Go runtime version is supported by the OpenTelemetry-Go
261+
[compatibility](https://github.com/open-telemetry/opentelemetry-go/tree/main?tab=readme-ov-file#compatibility)
262+
policy before enabling OpenTelemetry instrumentation.**
263+
255264
To opt-in to experimental OpenTelemetry tracing currently available in the
256265
clients listed above, set the environment variable
257266
`GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING` to the case-insensitive

0 commit comments

Comments
 (0)