Skip to content

Commit 44a371b

Browse files
committed
chore: remove enableDefaultTelemetryExporter and introduce enableGcpTraceExporter enableGcpLogExporter
1 parent ec25dcf commit 44a371b

File tree

5 files changed

+63
-31
lines changed

5 files changed

+63
-31
lines changed

java-bigquery/google-cloud-bigquery-jdbc/src/main/java/com/google/cloud/bigquery/jdbc/BigQueryConnection.java

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,8 @@ public class BigQueryConnection extends BigQueryNoOpsConnection {
140140
Long connectionPoolSize;
141141
Long listenerPoolSize;
142142
String partnerToken;
143-
boolean enableDefaultTelemetryExporter;
143+
boolean enableGcpTraceExporter;
144+
boolean enableGcpLogExporter;
144145
OpenTelemetry customOpenTelemetry;
145146
Tracer tracer =
146147
OpenTelemetry.noop().getTracer(BigQueryJdbcOpenTelemetry.INSTRUMENTATION_SCOPE_NAME);
@@ -248,7 +249,8 @@ public class BigQueryConnection extends BigQueryNoOpsConnection {
248249
this.connectionPoolSize = ds.getConnectionPoolSize();
249250
this.listenerPoolSize = ds.getListenerPoolSize();
250251
this.partnerToken = ds.getPartnerToken();
251-
this.enableDefaultTelemetryExporter = ds.getEnableDefaultTelemetryExporter();
252+
this.enableGcpTraceExporter = ds.getEnableGcpTraceExporter();
253+
this.enableGcpLogExporter = ds.getEnableGcpLogExporter();
252254
this.customOpenTelemetry = ds.getCustomOpenTelemetry();
253255

254256
this.headerProvider = createHeaderProvider();
@@ -945,8 +947,10 @@ private BigQuery getBigQueryConnection() {
945947

946948
OpenTelemetry openTelemetry =
947949
BigQueryJdbcOpenTelemetry.getOpenTelemetry(
948-
this.enableDefaultTelemetryExporter, this.customOpenTelemetry);
949-
if (this.enableDefaultTelemetryExporter || this.customOpenTelemetry != null) {
950+
this.enableGcpTraceExporter, this.enableGcpLogExporter, this.customOpenTelemetry);
951+
if (this.enableGcpTraceExporter
952+
|| this.enableGcpLogExporter
953+
|| this.customOpenTelemetry != null) {
950954
this.tracer = BigQueryJdbcOpenTelemetry.getTracer(openTelemetry);
951955
bigQueryOptions.setOpenTelemetryTracer(this.tracer);
952956
}

java-bigquery/google-cloud-bigquery-jdbc/src/main/java/com/google/cloud/bigquery/jdbc/BigQueryJdbcOpenTelemetry.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616

1717
package com.google.cloud.bigquery.jdbc;
1818

19-
import io.opentelemetry.api.GlobalOpenTelemetry;
2019
import io.opentelemetry.api.OpenTelemetry;
2120
import io.opentelemetry.api.trace.Tracer;
2221

@@ -29,14 +28,16 @@ public class BigQueryJdbcOpenTelemetry {
2928
* customOpenTelemetry if provided; fallback to an auto-configured GCP exporter if requested.
3029
*/
3130
public static OpenTelemetry getOpenTelemetry(
32-
boolean enableDefaultTelemetryExporter, OpenTelemetry customOpenTelemetry) {
31+
boolean enableGcpTraceExporter,
32+
boolean enableGcpLogExporter,
33+
OpenTelemetry customOpenTelemetry) {
3334
if (customOpenTelemetry != null) {
3435
return customOpenTelemetry;
3536
}
3637

37-
if (enableDefaultTelemetryExporter) {
38-
// TODO(b/491245568): Initialize and return GCP-specific auto-configured SDK
39-
return GlobalOpenTelemetry.get();
38+
if (enableGcpTraceExporter || enableGcpLogExporter) {
39+
// TODO(b/491238299): Initialize and return GCP-specific auto-configured SDK
40+
return OpenTelemetry.noop();
4041
}
4142

4243
return OpenTelemetry.noop();

java-bigquery/google-cloud-bigquery-jdbc/src/main/java/com/google/cloud/bigquery/jdbc/BigQueryJdbcUrlUtility.java

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,10 @@ protected boolean removeEldestEntry(Map.Entry<String, Map<String, String>> eldes
162162
static final int DEFAULT_SWA_APPEND_ROW_COUNT_VALUE = 1000;
163163
static final String SWA_ACTIVATION_ROW_COUNT_PROPERTY_NAME = "SWA_ActivationRowCount";
164164
static final int DEFAULT_SWA_ACTIVATION_ROW_COUNT_VALUE = 3;
165-
static final String ENABLE_DEFAULT_TELEMETRY_EXPORTER_PROPERTY_NAME =
166-
"enableDefaultTelemetryExporter";
167-
static final boolean DEFAULT_ENABLE_DEFAULT_TELEMETRY_EXPORTER_VALUE = false;
165+
static final String ENABLE_GCP_TRACE_EXPORTER_PROPERTY_NAME = "enableGcpTraceExporter";
166+
static final boolean DEFAULT_ENABLE_GCP_TRACE_EXPORTER_VALUE = false;
167+
static final String ENABLE_GCP_LOG_EXPORTER_PROPERTY_NAME = "enableGcpLogExporter";
168+
static final boolean DEFAULT_ENABLE_GCP_LOG_EXPORTER_VALUE = false;
168169
private static final BigQueryJdbcCustomLogger LOG =
169170
new BigQueryJdbcCustomLogger(BigQueryJdbcUrlUtility.class.getName());
170171
static final String FILTER_TABLES_ON_DEFAULT_DATASET_PROPERTY_NAME =
@@ -612,11 +613,16 @@ protected boolean removeEldestEntry(Map.Entry<String, Map<String, String>> eldes
612613
+ " header.")
613614
.build(),
614615
BigQueryConnectionProperty.newBuilder()
615-
.setName(ENABLE_DEFAULT_TELEMETRY_EXPORTER_PROPERTY_NAME)
616+
.setName(ENABLE_GCP_TRACE_EXPORTER_PROPERTY_NAME)
616617
.setDescription(
617-
"Enables or disables default OpenTelemetry exporters in the Driver. Disabled by default.")
618-
.setDefaultValue(
619-
String.valueOf(DEFAULT_ENABLE_DEFAULT_TELEMETRY_EXPORTER_VALUE))
618+
"Enables or disables GCP OpenTelemetry Trace exporter. Disabled by default.")
619+
.setDefaultValue(String.valueOf(DEFAULT_ENABLE_GCP_TRACE_EXPORTER_VALUE))
620+
.build(),
621+
BigQueryConnectionProperty.newBuilder()
622+
.setName(ENABLE_GCP_LOG_EXPORTER_PROPERTY_NAME)
623+
.setDescription(
624+
"Enables or disables GCP OpenTelemetry Log exporter. Disabled by default.")
625+
.setDefaultValue(String.valueOf(DEFAULT_ENABLE_GCP_LOG_EXPORTER_VALUE))
620626
.build())));
621627

622628
private static final List<String> NETWORK_PROPERTIES =

java-bigquery/google-cloud-bigquery-jdbc/src/main/java/com/google/cloud/bigquery/jdbc/BigQueryStatement.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1664,7 +1664,7 @@ private Tracer getSafeTracer() {
16641664
if (connection != null && connection.getTracer() != null) {
16651665
return connection.getTracer();
16661666
}
1667-
return BigQueryJdbcOpenTelemetry.getOpenTelemetry(false, null)
1667+
return BigQueryJdbcOpenTelemetry.getOpenTelemetry(false, false, null)
16681668
.getTracer(BigQueryJdbcOpenTelemetry.INSTRUMENTATION_SCOPE_NAME);
16691669
}
16701670
}

java-bigquery/google-cloud-bigquery-jdbc/src/main/java/com/google/cloud/bigquery/jdbc/DataSource.java

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@ public class DataSource implements javax.sql.DataSource {
114114
private String privateServiceConnect;
115115
private Long connectionPoolSize;
116116
private Long listenerPoolSize;
117-
private Boolean enableDefaultTelemetryExporter;
117+
private Boolean enableGcpTraceExporter;
118+
private Boolean enableGcpLogExporter;
118119
private OpenTelemetry customOpenTelemetry;
119120

120121
// Make sure the JDBC driver class is loaded.
@@ -328,12 +329,17 @@ public class DataSource implements javax.sql.DataSource {
328329
BigQueryJdbcUrlUtility.LISTENER_POOL_SIZE_PROPERTY_NAME,
329330
(ds, val) -> ds.setListenerPoolSize(Long.parseLong(val)))
330331
.put(
331-
BigQueryJdbcUrlUtility.ENABLE_DEFAULT_TELEMETRY_EXPORTER_PROPERTY_NAME,
332+
BigQueryJdbcUrlUtility.ENABLE_GCP_TRACE_EXPORTER_PROPERTY_NAME,
332333
(ds, val) ->
333-
ds.setEnableDefaultTelemetryExporter(
334+
ds.setEnableGcpTraceExporter(
334335
BigQueryJdbcUrlUtility.convertIntToBoolean(
335-
val,
336-
BigQueryJdbcUrlUtility.ENABLE_DEFAULT_TELEMETRY_EXPORTER_PROPERTY_NAME)))
336+
val, BigQueryJdbcUrlUtility.ENABLE_GCP_TRACE_EXPORTER_PROPERTY_NAME)))
337+
.put(
338+
BigQueryJdbcUrlUtility.ENABLE_GCP_LOG_EXPORTER_PROPERTY_NAME,
339+
(ds, val) ->
340+
ds.setEnableGcpLogExporter(
341+
BigQueryJdbcUrlUtility.convertIntToBoolean(
342+
val, BigQueryJdbcUrlUtility.ENABLE_GCP_LOG_EXPORTER_PROPERTY_NAME)))
337343
.build();
338344

339345
public static DataSource fromUrl(String url) {
@@ -630,10 +636,15 @@ private Properties createProperties() {
630636
BigQueryJdbcUrlUtility.LISTENER_POOL_SIZE_PROPERTY_NAME,
631637
String.valueOf(this.listenerPoolSize));
632638
}
633-
if (this.enableDefaultTelemetryExporter != null) {
639+
if (this.enableGcpTraceExporter != null) {
640+
connectionProperties.setProperty(
641+
BigQueryJdbcUrlUtility.ENABLE_GCP_TRACE_EXPORTER_PROPERTY_NAME,
642+
String.valueOf(this.enableGcpTraceExporter));
643+
}
644+
if (this.enableGcpLogExporter != null) {
634645
connectionProperties.setProperty(
635-
BigQueryJdbcUrlUtility.ENABLE_DEFAULT_TELEMETRY_EXPORTER_PROPERTY_NAME,
636-
String.valueOf(this.enableDefaultTelemetryExporter));
646+
BigQueryJdbcUrlUtility.ENABLE_GCP_LOG_EXPORTER_PROPERTY_NAME,
647+
String.valueOf(this.enableGcpLogExporter));
637648
}
638649
return connectionProperties;
639650
}
@@ -756,14 +767,24 @@ public void setListenerPoolSize(Long listenerPoolSize) {
756767
this.listenerPoolSize = listenerPoolSize;
757768
}
758769

759-
public Boolean getEnableDefaultTelemetryExporter() {
760-
return enableDefaultTelemetryExporter != null
761-
? enableDefaultTelemetryExporter
762-
: BigQueryJdbcUrlUtility.DEFAULT_ENABLE_DEFAULT_TELEMETRY_EXPORTER_VALUE;
770+
public Boolean getEnableGcpTraceExporter() {
771+
return enableGcpTraceExporter != null
772+
? enableGcpTraceExporter
773+
: BigQueryJdbcUrlUtility.DEFAULT_ENABLE_GCP_TRACE_EXPORTER_VALUE;
774+
}
775+
776+
public void setEnableGcpTraceExporter(Boolean enableGcpTraceExporter) {
777+
this.enableGcpTraceExporter = enableGcpTraceExporter;
778+
}
779+
780+
public Boolean getEnableGcpLogExporter() {
781+
return enableGcpLogExporter != null
782+
? enableGcpLogExporter
783+
: BigQueryJdbcUrlUtility.DEFAULT_ENABLE_GCP_LOG_EXPORTER_VALUE;
763784
}
764785

765-
public void setEnableDefaultTelemetryExporter(Boolean enableDefaultTelemetryExporter) {
766-
this.enableDefaultTelemetryExporter = enableDefaultTelemetryExporter;
786+
public void setEnableGcpLogExporter(Boolean enableGcpLogExporter) {
787+
this.enableGcpLogExporter = enableGcpLogExporter;
767788
}
768789

769790
public OpenTelemetry getCustomOpenTelemetry() {

0 commit comments

Comments
 (0)