feat: Improve Logging (#1892)

eranl · web-flow · commit e74457a14481 · 2024-10-29T10:00:43.000-04:00
* feat: Improve logging

* fix formatting
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/CollectionGroup.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/CollectionGroup.java
@@ -174,4 +174,10 @@ private void consumePartitions(
     }
     consumer.apply(new QueryPartition(partitionQuery, lastCursor, null));
   }
+
+  @SuppressWarnings("MethodDoesntCallSuperMethod")
+  @Override
+  public String toString() {
+    return String.format("CollectionGroup{partitionQuery=%s, options=%s}", partitionQuery, options);
+  }
 }
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/DocumentChange.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/DocumentChange.java
@@ -114,4 +114,11 @@ public boolean equals(Object obj) {
   public int hashCode() {
     return Objects.hash(type, document, oldIndex, newIndex);
   }
+
+  @Override
+  public String toString() {
+    return String.format(
+        "DocumentChange{type=%s, document=%s, oldIndex=%d, newIndex=%d}",
+        type, document, oldIndex, newIndex);
+  }
 }
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/GenericQuerySnapshot.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/GenericQuerySnapshot.java
@@ -162,4 +162,11 @@ public boolean equals(Object o) {
   public int hashCode() {
     return Objects.hash(query, this.getDocumentChanges(), this.getDocuments());
   }
+
+  @Override
+  public String toString() {
+    return String.format(
+        "%s{query=%s, readTime=%s, documentChanges=%s, documents=%s}",
+        getClass().getSimpleName(), query, readTime, documentChanges, documents);
+  }
 }
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/SilenceableBidiStream.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/SilenceableBidiStream.java
@@ -45,11 +45,11 @@
  */
 final class SilenceableBidiStream<RequestT, ResponseT>
     implements BidiStreamObserver<RequestT, ResponseT> {
+  private static final Logger LOGGER = Logger.getLogger(SilenceableBidiStream.class.getName());
 
   private final ClientStream<RequestT> stream;
   private final BidiStreamObserver<RequestT, ResponseT> delegate;
   private boolean silence = false;
-  private static final Logger LOGGER = Logger.getLogger(Watch.class.getName());
 
   SilenceableBidiStream(
       BidiStreamObserver<RequestT, ResponseT> responseObserverT,
@@ -63,17 +63,17 @@ public boolean isSilenced() {
   }
 
   public void send(RequestT request) {
-    LOGGER.info(stream.toString());
+    LOGGER.fine(stream.toString());
     stream.send(request);
   }
 
   public void closeSend() {
-    LOGGER.info(stream::toString);
+    LOGGER.fine(stream::toString);
     stream.closeSend();
   }
 
   public void closeSendAndSilence() {
-    LOGGER.info(stream::toString);
+    LOGGER.fine(stream::toString);
     silence = true;
     stream.closeSend();
   }
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/StreamableQuery.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/StreamableQuery.java
@@ -397,4 +397,9 @@ private boolean isRetryableError(Throwable throwable, Set<StatusCode.Code> retry
     }
     return false;
   }
+
+  @Override
+  public String toString() {
+    return String.format("%s{options=%s}", getClass().getSimpleName(), options);
+  }
 }
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/VectorQuery.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/VectorQuery.java
@@ -171,6 +171,14 @@ VectorQuerySnapshot createSnaphot(
     return VectorQuerySnapshot.withDocuments(this, readTime, documents);
   }
 
+  @SuppressWarnings("MethodDoesntCallSuperMethod")
+  @Override
+  public String toString() {
+    return String.format(
+        "VectorQuery{query=%s, vectorField=%s, queryVector=%s, limit=%d, distanceMeasure=%s, options=%s, options=%s}",
+        query, vectorField, queryVector, limit, distanceMeasure, options, options);
+  }
+
   /**
    * The distance measure to use when comparing vectors in a {@link VectorQuery}.
    *
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/VectorQueryOptions.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/VectorQueryOptions.java
@@ -148,6 +148,13 @@ public boolean equals(Object obj) {
         && Objects.equals(distanceThreshold, otherOptions.distanceThreshold);
   }
 
+  @Override
+  public String toString() {
+    return String.format(
+        "VectorQueryOptions{distanceResultField=%s, distanceThreshold=%s}",
+        distanceResultField, distanceThreshold);
+  }
+
   /** Default VectorQueryOptions instance. */
   private static VectorQueryOptions DEFAULT = newBuilder().build();
 
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/VectorValue.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/VectorValue.java
@@ -76,4 +76,9 @@ MapValue toProto() {
   int size() {
     return this.values.length;
   }
+
+  @Override
+  public String toString() {
+    return String.format("VectorValue{values=%s}", Arrays.toString(values));
+  }
 }
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/Watch.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/Watch.java
@@ -60,6 +60,8 @@
  * synchronization.
  */
 final class Watch implements BidiStreamObserver<ListenRequest, ListenResponse> {
+  private static final Logger LOGGER = Logger.getLogger(Watch.class.getName());
+
   /**
    * Target ID used by watch. Watch uses a fixed target id since we only support one target per
    * stream. The actual target ID we use is arbitrary.
@@ -115,8 +117,6 @@ static class ChangeSet {
     List<QueryDocumentSnapshot> updates = new ArrayList<>();
   }
 
-  private static final Logger LOGGER = Logger.getLogger(Watch.class.getName());
-
   /**
    * @param firestore The Firestore Database client.
    * @param query The query that is used to order the document snapshots returned by this watch.
@@ -474,7 +474,7 @@ private void pushSnapshot(final Timestamp readTime, ByteString nextResumeToken)
     if (!hasPushed || !changes.isEmpty()) {
       final QuerySnapshot querySnapshot =
           QuerySnapshot.withChanges(query, readTime, documentSet, changes);
-      LOGGER.info(querySnapshot.toString());
+      LOGGER.fine(querySnapshot.toString());
       userCallbackExecutor.execute(() -> listener.onEvent(querySnapshot, null));
       hasPushed = true;
     }

Original file line number	Diff line number	Diff line change
`@@ -174,4 +174,10 @@ private void consumePartitions(`
`174`	`174`	`}`
`175`	`175`	`consumer.apply(new QueryPartition(partitionQuery, lastCursor, null));`
`176`	`176`	`}`
	`177`	`+`
	`178`	`+ @SuppressWarnings("MethodDoesntCallSuperMethod")`
	`179`	`+ @Override`
	`180`	`+ public String toString() {`
	`181`	`+ return String.format("CollectionGroup{partitionQuery=%s, options=%s}", partitionQuery, options);`
	`182`	`+ }`
`177`	`183`	`}`
Original file line number	Diff line number	Diff line change
`@@ -114,4 +114,11 @@ public boolean equals(Object obj) {`
`114`	`114`	`public int hashCode() {`
`115`	`115`	`return Objects.hash(type, document, oldIndex, newIndex);`
`116`	`116`	`}`
	`117`	`+`
	`118`	`+ @Override`
	`119`	`+ public String toString() {`
	`120`	`+ return String.format(`
	`121`	`+ "DocumentChange{type=%s, document=%s, oldIndex=%d, newIndex=%d}",`
	`122`	`+ type, document, oldIndex, newIndex);`
	`123`	`+ }`
`117`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -162,4 +162,11 @@ public boolean equals(Object o) {`
`162`	`162`	`public int hashCode() {`
`163`	`163`	`return Objects.hash(query, this.getDocumentChanges(), this.getDocuments());`
`164`	`164`	`}`
	`165`	`+`
	`166`	`+ @Override`
	`167`	`+ public String toString() {`
	`168`	`+ return String.format(`
	`169`	`+ "%s{query=%s, readTime=%s, documentChanges=%s, documents=%s}",`
	`170`	`+ getClass().getSimpleName(), query, readTime, documentChanges, documents);`
	`171`	`+ }`
`165`	`172`	`}`
Original file line number	Diff line number	Diff line change
`@@ -397,4 +397,9 @@ private boolean isRetryableError(Throwable throwable, Set<StatusCode.Code> retry`
`397`	`397`	`}`
`398`	`398`	`return false;`
`399`	`399`	`}`
	`400`	`+`
	`401`	`+ @Override`
	`402`	`+ public String toString() {`
	`403`	`+ return String.format("%s{options=%s}", getClass().getSimpleName(), options);`
	`404`	`+ }`
`400`	`405`	`}`
Original file line number	Diff line number	Diff line change
`@@ -171,6 +171,14 @@ VectorQuerySnapshot createSnaphot(`
`171`	`171`	`return VectorQuerySnapshot.withDocuments(this, readTime, documents);`
`172`	`172`	`}`
`173`	`173`
	`174`	`+ @SuppressWarnings("MethodDoesntCallSuperMethod")`
	`175`	`+ @Override`
	`176`	`+ public String toString() {`
	`177`	`+ return String.format(`
	`178`	`+ "VectorQuery{query=%s, vectorField=%s, queryVector=%s, limit=%d, distanceMeasure=%s, options=%s, options=%s}",`
	`179`	`+ query, vectorField, queryVector, limit, distanceMeasure, options, options);`
	`180`	`+ }`
	`181`	`+`
`174`	`182`	`/**`
`175`	`183`	`* The distance measure to use when comparing vectors in a {@link VectorQuery}.`
`176`	`184`	`*`
Original file line number	Diff line number	Diff line change
`@@ -76,4 +76,9 @@ MapValue toProto() {`
`76`	`76`	`int size() {`
`77`	`77`	`return this.values.length;`
`78`	`78`	`}`
	`79`	`+`
	`80`	`+ @Override`
	`81`	`+ public String toString() {`
	`82`	`+ return String.format("VectorValue{values=%s}", Arrays.toString(values));`
	`83`	`+ }`
`79`	`84`	`}`