Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(main): add OpenTelemetry-Go compatibility warning to debug.md #9268

Merged
merged 3 commits into from
Jan 22, 2024
Merged

docs(main): add OpenTelemetry-Go compatibility warning to debug.md #9268

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4cf4566
docs(main): add OpenTelemetry-Go compatibility warning to debug.md
quartzmo Jan 16, 2024
c9e18a0
Merge branch 'main' into debug-otel-compatiblity
harshachinta Jan 17, 2024
d5efd50
Merge branch 'main' into debug-otel-compatiblity
quartzmo Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Logging, Debugging and Telemetry

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

## Logging and debugging

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

## Telemetry

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

#### OpenCensus

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

#### OpenTelemetry

**Warning: OpenTelemetry-Go ensures
[compatibility](https://github.com/open-telemetry/opentelemetry-go/tree/main?tab=readme-ov-file#compatibility)
with ONLY the current supported versions of the [Go
language](https://go.dev/doc/devel/release#policy). This support may be narrower
than the support that has been offered historically by the Go Client Libraries.
Ensure that your Go runtime version is supported by the OpenTelemetry-Go
[compatibility](https://github.com/open-telemetry/opentelemetry-go/tree/main?tab=readme-ov-file#compatibility)
policy before enabling OpenTelemetry instrumentation.**

To opt-in to experimental OpenTelemetry tracing currently available in the
clients listed above, set the environment variable
`GOOGLE_API_GO_EXPERIMENTAL_TELEMETRY_PLATFORM_TRACING` to the case-insensitive
Expand Down