From 9dfbfb05765dbca8a7f8ec698f0f76c4ee53bb91 Mon Sep 17 00:00:00 2001 From: blakeli Date: Tue, 7 Apr 2026 14:57:20 -0400 Subject: [PATCH 1/4] docs: add warning about sensitive data to SpanTracerFactory --- .../google/api/gax/tracing/SpanTracerFactory.java | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java index 4c4dafb88f78..ab01aa18b678 100644 --- a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java +++ b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java @@ -53,7 +53,20 @@ public class SpanTracerFactory implements ApiTracerFactory { private final OpenTelemetry openTelemetry; private final ApiTracerContext apiTracerContext; - /** Creates a SpanTracerFactory */ + /** + *

Warning: Traces may contain sensitive data such as resource names, full + * URLs, and error messages. + * + *

Before configuring subscribers or exporters for traces, review the + * contents of the spans and consult the [opentelemetry] documentation to + * set up filters and formatters to prevent leaking sensitive information, + * depending on your intended use case. + * + *

[OpenTelemetry Semantic Conventions]: + * https://opentelemetry.io/docs/concepts/semantic-conventions/ + *

[opentelemetry]: + * https://opentelemetry.io/docs/security/handling-sensitive-data/ + */ public SpanTracerFactory(OpenTelemetry openTelemetry) { this(openTelemetry, null, ApiTracerContext.empty()); } From 2ab4a0a0207be61c370b841c6fdffe5f1553d058 Mon Sep 17 00:00:00 2001 From: blakeli Date: Tue, 7 Apr 2026 15:14:54 -0400 Subject: [PATCH 2/4] docs: fix Javadoc convention in SpanTracerFactory --- .../google/api/gax/tracing/SpanTracerFactory.java | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java index ab01aa18b678..ffec585753e8 100644 --- a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java +++ b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java @@ -54,18 +54,19 @@ public class SpanTracerFactory implements ApiTracerFactory { private final ApiTracerContext apiTracerContext; /** - *

Warning: Traces may contain sensitive data such as resource names, full + * Warning: Traces may contain sensitive data such as resource names, full * URLs, and error messages. * *

Before configuring subscribers or exporters for traces, review the - * contents of the spans and consult the [opentelemetry] documentation to + * contents of the spans and consult the OpenTelemetry documentation to * set up filters and formatters to prevent leaking sensitive information, * depending on your intended use case. * - *

[OpenTelemetry Semantic Conventions]: - * https://opentelemetry.io/docs/concepts/semantic-conventions/ - *

[opentelemetry]: - * https://opentelemetry.io/docs/security/handling-sensitive-data/ + *

See also: + *

*/ public SpanTracerFactory(OpenTelemetry openTelemetry) { this(openTelemetry, null, ApiTracerContext.empty()); From b7fa748ffae26e809488ae377885b92619c74a2e Mon Sep 17 00:00:00 2001 From: blakeli Date: Tue, 7 Apr 2026 15:16:09 -0400 Subject: [PATCH 3/4] docs: use inline HTML links in Javadoc for SpanTracerFactory --- .../api/gax/tracing/SpanTracerFactory.java | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java index ffec585753e8..b52b3a9cf2a3 100644 --- a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java +++ b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java @@ -58,15 +58,15 @@ public class SpanTracerFactory implements ApiTracerFactory { * URLs, and error messages. * *

Before configuring subscribers or exporters for traces, review the - * contents of the spans and consult the OpenTelemetry documentation to - * set up filters and formatters to prevent leaking sensitive information, - * depending on your intended use case. + * contents of the spans and consult the + * OpenTelemetry documentation to set up filters and formatters to + * prevent leaking sensitive information, depending on your intended use + * case. * - *

See also: - *

+ *

See also the + * OpenTelemetry Semantic Conventions. */ public SpanTracerFactory(OpenTelemetry openTelemetry) { this(openTelemetry, null, ApiTracerContext.empty()); From 07b64dec32f94802e900833a1f7aa32fca591413 Mon Sep 17 00:00:00 2001 From: blakeli Date: Tue, 7 Apr 2026 15:22:05 -0400 Subject: [PATCH 4/4] format --- .../api/gax/tracing/SpanTracerFactory.java | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java index b52b3a9cf2a3..7f167128c51f 100644 --- a/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java +++ b/sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/tracing/SpanTracerFactory.java @@ -54,18 +54,15 @@ public class SpanTracerFactory implements ApiTracerFactory { private final ApiTracerContext apiTracerContext; /** - * Warning: Traces may contain sensitive data such as resource names, full - * URLs, and error messages. + * Warning: Traces may contain sensitive data such as resource names, full URLs, and error + * messages. * - *

Before configuring subscribers or exporters for traces, review the - * contents of the spans and consult the - * OpenTelemetry documentation to set up filters and formatters to - * prevent leaking sensitive information, depending on your intended use - * case. + *

Before configuring subscribers or exporters for traces, review the contents of the spans and + * consult the + * OpenTelemetry documentation to set up filters and formatters to prevent leaking sensitive + * information, depending on your intended use case. * - *

See also the + *

See also the * OpenTelemetry Semantic Conventions. */ public SpanTracerFactory(OpenTelemetry openTelemetry) {