add attribute namespaces, change to snake_case

whuffman36 · whuffman36 · commit 0ebaa9239a13 · 2025-05-20T16:06:48.000-07:00
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryImpl.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryImpl.java
@@ -445,7 +445,6 @@ && getOptions().getOpenTelemetryTracer() != null) {
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.createJob")
               .setAllAttributes(jobInfo.getJobId().getOtelAttributes())
-              .setAttribute("status", getFieldAsString(jobInfo.getStatus()))
               .setAllAttributes(otelAttributesFromOptions(options))
               .startSpan();
     }
@@ -616,7 +615,7 @@ && getOptions().getOpenTelemetryTracer() != null) {
           getOptions()
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.listDatasets")
-              .setAttribute("projectId", projectId)
+              .setAttribute("bq.dataset.project_id", projectId)
               .setAllAttributes(otelAttributesFromOptions(options))
               .startSpan();
     }
@@ -1638,7 +1637,6 @@ && getOptions().getOpenTelemetryTracer() != null) {
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.listTableData")
               .setAllAttributes(tableId.getOtelAttributes())
-              .setAllAttributes(schema.getOtelAttributes())
               .setAllAttributes(otelAttributesFromOptions(options))
               .startSpan();
     }
@@ -1735,7 +1733,7 @@ && getOptions().getOpenTelemetryTracer() != null) {
           getOptions()
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.getJob")
-              .setAllAttributes(jobId.getOtelAttributes())
+              .setAllAttributes(completeJobId.getOtelAttributes())
               .setAllAttributes(otelAttributesFromOptions(options))
               .startSpan();
     }
@@ -1848,7 +1846,7 @@ && getOptions().getOpenTelemetryTracer() != null) {
           getOptions()
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.cancelJob")
-              .setAllAttributes(jobId.getOtelAttributes())
+              .setAllAttributes(completeJobId.getOtelAttributes())
               .startSpan();
     }
     try (Scope jobCancelScope = jobCancel != null ? jobCancel.makeCurrent() : null) {
@@ -1895,7 +1893,6 @@ && getOptions().getOpenTelemetryTracer() != null) {
           getOptions()
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.query")
-              .setAllAttributes(configuration.getOtelAttributes())
               .setAllAttributes(otelAttributesFromOptions(options))
               .startSpan();
     }
@@ -1933,7 +1930,7 @@ && getOptions().getOpenTelemetryTracer() != null) {
           getOptions()
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.queryRpc")
-              .setAttribute("projectId", projectId)
+              .setAttribute("bq.query.project_id", projectId)
               .setAllAttributes(otelAttributesFromQueryRequest(content))
               .setAllAttributes(otelAttributesFromOptions(options))
               .startSpan();
@@ -2034,7 +2031,6 @@ && getOptions().getOpenTelemetryTracer() != null) {
           getOptions()
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.query")
-              .setAllAttributes(configuration.getOtelAttributes())
               .setAllAttributes(jobId.getOtelAttributes())
               .setAllAttributes(otelAttributesFromOptions(options))
               .startSpan();
@@ -2267,7 +2263,7 @@ && getOptions().getOpenTelemetryTracer() != null) {
               .getOpenTelemetryTracer()
               .spanBuilder("com.google.cloud.bigquery.BigQuery.testIamPermissions")
               .setAllAttributes(tableId.getOtelAttributes())
-              .setAttribute("permissions", permissions.toString())
+              .setAttribute("bq.iam.permissions", permissions.toString())
               .setAllAttributes(otelAttributesFromOptions(options))
               .startSpan();
     }
@@ -2318,27 +2314,27 @@ private static Attributes otelAttributesFromOptions(Option... options) {
     for (Option option : options) {
       attributes =
           attributes.toBuilder()
-              .put(option.getRpcOption().toString(), option.getValue().toString())
+              .put("bq.option." + option.getRpcOption().toString(), option.getValue().toString())
               .build();
     }
     return attributes;
   }
 
   private static Attributes otelAttributesFromQueryRequest(QueryRequest request) {
     return Attributes.builder()
-        .put("dryRun", getFieldAsString(request.getDryRun()))
-        .put("jobCreationMode", getFieldAsString(request.getJobCreationMode()))
-        .put("kind", getFieldAsString(request.getKind()))
-        .put("location", getFieldAsString(request.getLocation()))
-        .put("requestId", getFieldAsString(request.getRequestId()))
-        .put("useQueryCache", getFieldAsString(request.getUseQueryCache()))
+        .put("bq.query.dry_run", getFieldAsString(request.getDryRun()))
+        .put("bq.query.job_creation_mode", getFieldAsString(request.getJobCreationMode()))
+        .put("bq.query.kind", getFieldAsString(request.getKind()))
+        .put("bq.query.location", getFieldAsString(request.getLocation()))
+        .put("bq.query.request_id", getFieldAsString(request.getRequestId()))
+        .put("bq.query.use_query_cache", getFieldAsString(request.getUseQueryCache()))
         .build();
   }
 
   private static Attributes otelAttributesFromPolicy(Policy policy) {
     return Attributes.builder()
-        .put("version", getFieldAsString(policy.getVersion()))
-        .put("bindings", getFieldAsString(policy.getBindings()))
+        .put("bq.policy.version", getFieldAsString(policy.getVersion()))
+        .put("bq.policy.bindings", getFieldAsString(policy.getBindings()))
         .build();
   }
 
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/DatasetId.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/DatasetId.java
@@ -88,8 +88,8 @@ static DatasetId fromPb(DatasetReference datasetRef) {
 
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
-        .put("project", this.getProject())
-        .put("dataset", this.getDataset())
+        .put("bq.dataset.project", this.getProject())
+        .put("bq.dataset.id", this.getDataset())
         .build();
   }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/DatasetInfo.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/DatasetInfo.java
@@ -754,8 +754,8 @@ private static String getFieldAsString(Object field) {
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
         .putAll(this.getDatasetId().getOtelAttributes())
-        .put("lastModified", getFieldAsString(this.getLastModified()))
-        .put("location", getFieldAsString(this.getLocation()))
+        .put("bq.dataset.lastModified", getFieldAsString(this.getLastModified()))
+        .put("bq.dataset.location", getFieldAsString(this.getLocation()))
         .build();
   }
 
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/JobId.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/JobId.java
@@ -131,9 +131,9 @@ private static String getFieldAsString(Object field) {
 
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
-        .put("job", getFieldAsString(this.getJob()))
-        .put("location", getFieldAsString(this.getLocation()))
-        .put("project", getFieldAsString(this.getProject()))
+        .put("bq.job.id", getFieldAsString(this.getJob()))
+        .put("bq.job.location", getFieldAsString(this.getLocation()))
+        .put("bq.job.project", getFieldAsString(this.getProject()))
         .build();
   }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/JobInfo.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/JobInfo.java
@@ -19,7 +19,6 @@
 import com.google.api.services.bigquery.model.Job;
 import com.google.common.base.Function;
 import com.google.common.base.MoreObjects;
-import io.opentelemetry.api.common.Attributes;
 import java.io.Serializable;
 import java.util.Objects;
 
@@ -376,18 +375,4 @@ public static JobInfo of(JobId jobId, JobConfiguration configuration) {
   static JobInfo fromPb(Job jobPb) {
     return new BuilderImpl(jobPb).build();
   }
-
-  private static String getFieldAsString(Object field) {
-    return field == null ? "null" : field.toString();
-  }
-
-  protected Attributes getOtelAttributes() {
-    return Attributes.builder()
-        .putAll(this.getJobId().getOtelAttributes())
-        .put("creationTime", getFieldAsString(this.getStatistics().getCreationTime()))
-        .put("startTime", getFieldAsString(this.getStatistics().getStartTime()))
-        .put("endTime", getFieldAsString(this.getStatistics().getEndTime()))
-        .put("jobType", getFieldAsString(this.getConfiguration().getType()))
-        .build();
-  }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/ModelId.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/ModelId.java
@@ -109,9 +109,9 @@ static ModelId fromPb(ModelReference modelRef) {
 
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
-        .put("project", this.getProject())
-        .put("dataset", this.getDataset())
-        .put("model", this.getModel())
+        .put("bq.model.project", this.getProject())
+        .put("bq.model.dataset", this.getDataset())
+        .put("bq.model.id", this.getModel())
         .build();
   }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/ModelInfo.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/ModelInfo.java
@@ -462,11 +462,11 @@ private static String getFieldAsString(Object field) {
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
         .putAll(this.getModelId().getOtelAttributes())
-        .put("modelType", getFieldAsString(this.getModelType()))
-        .put("creationTime", getFieldAsString(this.getCreationTime()))
-        .put("lastModifiedTime", getFieldAsString(this.getLastModifiedTime()))
-        .put("expirationTime", getFieldAsString(this.getExpirationTime()))
-        .put("location", getFieldAsString(this.getLocation()))
+        .put("bq.model.type", getFieldAsString(this.getModelType()))
+        .put("bq.model.creation_time", getFieldAsString(this.getCreationTime()))
+        .put("bq.model.last_modified_time", getFieldAsString(this.getLastModifiedTime()))
+        .put("bq.model.expiration_time", getFieldAsString(this.getExpirationTime()))
+        .put("bq.model.location", getFieldAsString(this.getLocation()))
         .build();
   }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/QueryJobConfiguration.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/QueryJobConfiguration.java
@@ -32,7 +32,6 @@
 import com.google.common.collect.Iterables;
 import com.google.common.collect.Lists;
 import com.google.common.collect.Maps;
-import io.opentelemetry.api.common.Attributes;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
@@ -1214,16 +1213,4 @@ public QueryParameter apply(Map.Entry<String, QueryParameterValue> entry) {
               return queryParameterPb;
             }
           };
-
-  private static String getFieldAsString(Object field) {
-    return field == null ? "null" : field.toString();
-  }
-
-  public Attributes getOtelAttributes() {
-    return Attributes.builder()
-        .put("destinationTable", getFieldAsString(this.getDestinationTable()))
-        .put("useQueryCache", getFieldAsString(this.useQueryCache()))
-        .put("dryRun", getFieldAsString(this.dryRun()))
-        .build();
-  }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/RoutineId.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/RoutineId.java
@@ -112,9 +112,9 @@ static RoutineId fromPb(RoutineReference routineRef) {
 
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
-        .put("project", this.getProject())
-        .put("dataset", this.getDataset())
-        .put("routine", this.getRoutine())
+        .put("bq.routine.project", this.getProject())
+        .put("bq.routine.dataset", this.getDataset())
+        .put("bq.routine.id", this.getRoutine())
         .build();
   }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/RoutineInfo.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/RoutineInfo.java
@@ -553,9 +553,9 @@ private static String getFieldAsString(Object field) {
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
         .putAll(this.getRoutineId().getOtelAttributes())
-        .put("routineType", getFieldAsString(this.getRoutineType()))
-        .put("creationTime", getFieldAsString(this.getCreationTime()))
-        .put("lastModifiedTime", getFieldAsString(this.getLastModifiedTime()))
+        .put("bq.routine.type", getFieldAsString(this.getRoutineType()))
+        .put("bq.routine.creation_time", getFieldAsString(this.getCreationTime()))
+        .put("bq.routine.last_modified_time", getFieldAsString(this.getLastModifiedTime()))
         .build();
   }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/Schema.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/Schema.java
@@ -22,7 +22,6 @@
 import com.google.api.services.bigquery.model.TableSchema;
 import com.google.common.base.Function;
 import com.google.common.base.MoreObjects;
-import io.opentelemetry.api.common.Attributes;
 import java.io.Serializable;
 import java.util.Collections;
 import java.util.List;
@@ -100,13 +99,4 @@ static Schema fromPb(com.google.api.services.bigquery.model.TableSchema tableSch
     }
     return Schema.of(FieldList.fromPb(fields));
   }
-
-  public Attributes getOtelAttributes() {
-    Attributes attributes = Attributes.builder().build();
-    for (Field field : this.getFields()) {
-      attributes =
-          attributes.toBuilder().put("Field: " + field.getName(), field.toString()).build();
-    }
-    return attributes;
-  }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/TableId.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/TableId.java
@@ -118,9 +118,9 @@ static TableId fromPb(TableReference tableRef) {
 
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
-        .put("project", this.getProject())
-        .put("dataset", this.getDataset())
-        .put("table", this.getTable())
+        .put("bq.table.project", this.getProject())
+        .put("bq.table.dataset", this.getDataset())
+        .put("bq.table.id", this.getTable())
         .build();
   }
 }
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/TableInfo.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/TableInfo.java
@@ -772,11 +772,11 @@ private static String getFieldAsString(Object field) {
   protected Attributes getOtelAttributes() {
     return Attributes.builder()
         .putAll(this.getTableId().getOtelAttributes())
-        .put("creationTime", getFieldAsString(this.getCreationTime()))
-        .put("expirationTime", getFieldAsString(this.getExpirationTime()))
-        .put("lastModifiedTime", getFieldAsString(this.getLastModifiedTime()))
-        .put("numBytes", getFieldAsString(this.getNumBytes()))
-        .put("numRows", getFieldAsString(this.getNumRows()))
+        .put("bq.table.creation_time", getFieldAsString(this.getCreationTime()))
+        .put("bq.table.expiration_time", getFieldAsString(this.getExpirationTime()))
+        .put("bq.table.last_modified_time", getFieldAsString(this.getLastModifiedTime()))
+        .put("bq.table.num_bytes", getFieldAsString(this.getNumBytes()))
+        .put("bq.table.num_rows", getFieldAsString(this.getNumRows()))
         .build();
   }
 }
diff --git a/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/it/ITBigQueryTest.java b/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/it/ITBigQueryTest.java
@@ -7587,19 +7587,19 @@ public void testOpenTelemetryTracingDatasets() {
       parentSpan.end();
       Map<AttributeKey<?>, Object> createMap =
           OTEL_ATTRIBUTES.get("com.google.cloud.bigquery.BigQuery.createDataset");
-      assertEquals(createMap.get(AttributeKey.stringKey("location")), "null");
+      assertEquals(createMap.get(AttributeKey.stringKey("bq.dataset.location")), "null");
 
       Map<AttributeKey<?>, Object> getMap =
           OTEL_ATTRIBUTES.get("com.google.cloud.bigquery.BigQuery.getDataset");
-      assertEquals(getMap.get(AttributeKey.stringKey("dataset")), billingModelDataset);
+      assertEquals(getMap.get(AttributeKey.stringKey("bq.dataset.id")), billingModelDataset);
 
       Map<AttributeKey<?>, Object> updateMap =
           OTEL_ATTRIBUTES.get("com.google.cloud.bigquery.BigQuery.updateDataset");
-      assertEquals(updateMap.get(AttributeKey.stringKey("ACCESS_POLICY_VERSION")), "2");
+      assertEquals(updateMap.get(AttributeKey.stringKey("bq.option.ACCESS_POLICY_VERSION")), "2");
 
       Map<AttributeKey<?>, Object> deleteMap =
           OTEL_ATTRIBUTES.get("com.google.cloud.bigquery.BigQuery.deleteDataset");
-      assertEquals(deleteMap.get(AttributeKey.stringKey("dataset")), billingModelDataset);
+      assertEquals(deleteMap.get(AttributeKey.stringKey("bq.dataset.id")), billingModelDataset);
 
       // All should be children spans of parentSpan
       assertEquals(
@@ -7644,12 +7644,12 @@ public void testOpenTelemetryTracingTables() {
     assertEquals(
         OTEL_ATTRIBUTES
             .get("com.google.cloud.bigquery.BigQuery.createTable")
-            .get(AttributeKey.stringKey("table")),
+            .get(AttributeKey.stringKey("bq.table.id")),
         tableName);
     assertEquals(
         OTEL_ATTRIBUTES
             .get("com.google.cloud.bigquery.BigQuery.createTable")
-            .get(AttributeKey.stringKey("creationTime")),
+            .get(AttributeKey.stringKey("bq.table.creation_time")),
         "null");
 
     Table updatedTable =

Original file line number	Diff line number	Diff line change
`@@ -88,8 +88,8 @@ static DatasetId fromPb(DatasetReference datasetRef) {`
`88`	`88`
`89`	`89`	`protected Attributes getOtelAttributes() {`
`90`	`90`	`return Attributes.builder()`
`91`		`- .put("project", this.getProject())`
`92`		`- .put("dataset", this.getDataset())`
	`91`	`+ .put("bq.dataset.project", this.getProject())`
	`92`	`+ .put("bq.dataset.id", this.getDataset())`
`93`	`93`	`.build();`
`94`	`94`	`}`
`95`	`95`	`}`
Original file line number	Diff line number	Diff line change
`@@ -131,9 +131,9 @@ private static String getFieldAsString(Object field) {`
`131`	`131`
`132`	`132`	`protected Attributes getOtelAttributes() {`
`133`	`133`	`return Attributes.builder()`
`134`		`- .put("job", getFieldAsString(this.getJob()))`
`135`		`- .put("location", getFieldAsString(this.getLocation()))`
`136`		`- .put("project", getFieldAsString(this.getProject()))`
	`134`	`+ .put("bq.job.id", getFieldAsString(this.getJob()))`
	`135`	`+ .put("bq.job.location", getFieldAsString(this.getLocation()))`
	`136`	`+ .put("bq.job.project", getFieldAsString(this.getProject()))`
`137`	`137`	`.build();`
`138`	`138`	`}`
`139`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -109,9 +109,9 @@ static ModelId fromPb(ModelReference modelRef) {`
`109`	`109`
`110`	`110`	`protected Attributes getOtelAttributes() {`
`111`	`111`	`return Attributes.builder()`
`112`		`- .put("project", this.getProject())`
`113`		`- .put("dataset", this.getDataset())`
`114`		`- .put("model", this.getModel())`
	`112`	`+ .put("bq.model.project", this.getProject())`
	`113`	`+ .put("bq.model.dataset", this.getDataset())`
	`114`	`+ .put("bq.model.id", this.getModel())`
`115`	`115`	`.build();`
`116`	`116`	`}`
`117`	`117`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,9 +112,9 @@ static RoutineId fromPb(RoutineReference routineRef) {`
`112`	`112`
`113`	`113`	`protected Attributes getOtelAttributes() {`
`114`	`114`	`return Attributes.builder()`
`115`		`- .put("project", this.getProject())`
`116`		`- .put("dataset", this.getDataset())`
`117`		`- .put("routine", this.getRoutine())`
	`115`	`+ .put("bq.routine.project", this.getProject())`
	`116`	`+ .put("bq.routine.dataset", this.getDataset())`
	`117`	`+ .put("bq.routine.id", this.getRoutine())`
`118`	`118`	`.build();`
`119`	`119`	`}`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -553,9 +553,9 @@ private static String getFieldAsString(Object field) {`
`553`	`553`	`protected Attributes getOtelAttributes() {`
`554`	`554`	`return Attributes.builder()`
`555`	`555`	`.putAll(this.getRoutineId().getOtelAttributes())`
`556`		`- .put("routineType", getFieldAsString(this.getRoutineType()))`
`557`		`- .put("creationTime", getFieldAsString(this.getCreationTime()))`
`558`		`- .put("lastModifiedTime", getFieldAsString(this.getLastModifiedTime()))`
	`556`	`+ .put("bq.routine.type", getFieldAsString(this.getRoutineType()))`
	`557`	`+ .put("bq.routine.creation_time", getFieldAsString(this.getCreationTime()))`
	`558`	`+ .put("bq.routine.last_modified_time", getFieldAsString(this.getLastModifiedTime()))`
`559`	`559`	`.build();`
`560`	`560`	`}`
`561`	`561`	`}`