Skip to content

Commit 684511a

Browse files
authored
docs: add warning about potential sensitive data in tracing (#12701)
1 parent 3053610 commit 684511a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/OpenTelemetryTracingFactory.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,18 @@ public class OpenTelemetryTracingFactory implements ApiTracerFactory {
5353
private final OpenTelemetry openTelemetry;
5454
private final ApiTracerContext apiTracerContext;
5555

56+
/**
57+
* Warning: Traces may contain sensitive data such as resource names, full URLs, and error
58+
* messages.
59+
*
60+
* <p>Before configuring subscribers or exporters for traces, review the contents of the spans and
61+
* consult the <a href="https://opentelemetry.io/docs/security/handling-sensitive-data/">
62+
* OpenTelemetry documentation</a> to set up filters and formatters to prevent leaking sensitive
63+
* information, depending on your intended use case.
64+
*
65+
* <p>See also the <a href="https://opentelemetry.io/docs/concepts/semantic-conventions/">
66+
* OpenTelemetry Semantic Conventions</a>.
67+
*/
5668
public OpenTelemetryTracingFactory(OpenTelemetry openTelemetry) {
5769
this(openTelemetry, null, ApiTracerContext.empty());
5870
}

0 commit comments

Comments
 (0)