Skip to content

Commit e871169

Browse files
committed
add javadoc warning
1 parent ff492d6 commit e871169

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryOptions.java

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,18 @@ public Builder setDataFormatOptions(DataFormatOptions dataFormatOptions) {
126126
/**
127127
* Enables OpenTelemetry tracing functionality for this BigQuery instance
128128
*
129-
* <p>[TODO] add warning text here
129+
* <p><div class="warning"> Traces may contain sensitive data such as resource names, full URLs,
130+
* and error messages.
131+
*
132+
* <p>Before configuring subscribers or exporters for traces, review the contents of the spans
133+
* and consult the <a
134+
* href="https://opentelemetry.io/docs/security/handling-sensitive-data/">OpenTelemetry
135+
* documentation</a> to set up filters and formatters to prevent leaking sensitive information,
136+
* depending on your intended use case.
137+
*
138+
* <p>See also: <a
139+
* href="https://opentelemetry.io/docs/concepts/semantic-conventions/">OpenTelemetry Semantic
140+
* Conventions</a> </div>
130141
*
131142
* @param enableOpenTelemetryTracing enables OpenTelemetry tracing if true
132143
*/
@@ -138,6 +149,19 @@ public Builder setEnableOpenTelemetryTracing(boolean enableOpenTelemetryTracing)
138149
/**
139150
* Sets the OpenTelemetry tracer for this BigQuery instance to be tracer.
140151
*
152+
* <p><div class="warning"> Traces may contain sensitive data such as resource names, full URLs,
153+
* and error messages.
154+
*
155+
* <p>Before configuring subscribers or exporters for traces, review the contents of the spans
156+
* and consult the <a
157+
* href="https://opentelemetry.io/docs/security/handling-sensitive-data/">OpenTelemetry
158+
* documentation</a> to set up filters and formatters to prevent leaking sensitive information,
159+
* depending on your intended use case.
160+
*
161+
* <p>See also: <a
162+
* href="https://opentelemetry.io/docs/concepts/semantic-conventions/">OpenTelemetry Semantic
163+
* Conventions</a> </div>
164+
*
141165
* @param tracer OpenTelemetry tracer to be used
142166
*/
143167
public Builder setOpenTelemetryTracer(Tracer tracer) {

0 commit comments

Comments
 (0)