add debug mode for verbose logging.

Author: breedx-splk

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/StorageConfiguration.java

@@ -18,6 +18,9 @@ public abstract class StorageConfiguration {
   /** The root storage location for buffered telemetry. */
   public abstract File getRootDir();
 
+  /** Returns true if the storage has been configured with debug verbosity enabled. */
+  public abstract boolean isDebugEnabled();
+
   /** The max amount of time a file can receive new data. */
   public abstract long getMaxFileAgeForWriteMillis();
 
@@ -62,6 +65,7 @@ public static Builder builder() {
         .setMaxFileAgeForWriteMillis(TimeUnit.SECONDS.toMillis(30))
         .setMinFileAgeForReadMillis(TimeUnit.SECONDS.toMillis(33))
         .setMaxFileAgeForReadMillis(TimeUnit.HOURS.toMillis(18))
+        .setDebugEnabled(false)
         .setTemporaryFileProvider(fileProvider);
   }
 
@@ -81,6 +85,8 @@ public abstract static class Builder {
 
     public abstract Builder setRootDir(File rootDir);
 
+    public abstract Builder setDebugEnabled(boolean debugEnabled);
+
     public abstract StorageConfiguration build();
   }
 }

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/exporter/FromDiskExporterBuilder.java

@@ -25,6 +25,8 @@ public class FromDiskExporterBuilder<T> {
   private Function<Collection<T>, CompletableResultCode> exportFunction =
       x -> CompletableResultCode.ofFailure();
 
+  private boolean debugEnabled = false;
+
   @NotNull
   private static <T> SignalDeserializer<T> noopDeserializer() {
     return x -> emptyList();
@@ -63,8 +65,14 @@ public FromDiskExporterBuilder<T> setExportFunction(
     return this;
   }
 
+  @CanIgnoreReturnValue
+  public FromDiskExporterBuilder<T> setDebugEnabled(boolean debugEnabled) {
+    this.debugEnabled = debugEnabled;
+    return this;
+  }
+
   public FromDiskExporterImpl<T> build() throws IOException {
     Storage storage = storageBuilder.build();
-    return new FromDiskExporterImpl<>(serializer, exportFunction, storage);
+    return new FromDiskExporterImpl<>(serializer, exportFunction, storage, debugEnabled);
   }
 }

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/exporter/FromDiskExporterImpl.java

@@ -11,6 +11,7 @@
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import java.io.IOException;
 import java.util.Collection;
+import java.util.List;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Function;
 import java.util.logging.Level;
@@ -21,18 +22,21 @@
  * another delegated exporter.
  */
 public final class FromDiskExporterImpl<EXPORT_DATA> implements FromDiskExporter {
+  private static final Logger logger = Logger.getLogger(FromDiskExporterImpl.class.getName());
   private final Storage storage;
   private final SignalDeserializer<EXPORT_DATA> deserializer;
   private final Function<Collection<EXPORT_DATA>, CompletableResultCode> exportFunction;
-  private static final Logger logger = Logger.getLogger(FromDiskExporterImpl.class.getName());
+  private final boolean debugEnabled;
 
   FromDiskExporterImpl(
       SignalDeserializer<EXPORT_DATA> deserializer,
       Function<Collection<EXPORT_DATA>, CompletableResultCode> exportFunction,
-      Storage storage) {
+      Storage storage,
+      boolean debugEnabled) {
     this.deserializer = deserializer;
     this.exportFunction = exportFunction;
     this.storage = storage;
+    this.debugEnabled = debugEnabled;
   }
 
   public static <T> FromDiskExporterBuilder<T> builder() {
@@ -44,24 +48,36 @@ public static <T> FromDiskExporterBuilder<T> builder() {
    *
    * @param timeout The amount of time to wait for the wrapped exporter to finish.
    * @param unit The unit of the time provided.
-   * @return true if there was data available and it was successfully exported within the timeout
+   * @return true if there was data available, and it was successfully exported within the timeout
    *     provided. false otherwise.
    * @throws IOException If an unexpected error happens.
    */
   @Override
   public boolean exportStoredBatch(long timeout, TimeUnit unit) throws IOException {
-    logger.log(Level.INFO, "Attempting to export batch from disk.");
+    log("Attempting to export " + deserializer.signalType() + " batch from disk.");
     ReadableResult result =
         storage.readAndProcess(
             bytes -> {
-              logger.log(Level.INFO, "About to export stored batch.");
-              CompletableResultCode join =
-                  exportFunction.apply(deserializer.deserialize(bytes)).join(timeout, unit);
+              log(
+                  "Read "
+                      + bytes.length
+                      + " "
+                      + deserializer.signalType()
+                      + " bytes from storage.");
+              List<EXPORT_DATA> telemetry = deserializer.deserialize(bytes);
+              log("Now exporting batch of " + telemetry.size() + " " + deserializer.signalType());
+              CompletableResultCode join = exportFunction.apply(telemetry).join(timeout, unit);
               return join.isSuccess();
             });
     return result == ReadableResult.SUCCEEDED;
   }
 
+  private void log(String msg) {
+    if (debugEnabled) {
+      logger.log(Level.INFO, msg);
+    }
+  }
+
   @Override
   public void shutdown() throws IOException {
     storage.close();

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/serialization/deserializers/LogRecordDataDeserializer.java

@@ -28,4 +28,9 @@ public List<LogRecordData> deserialize(byte[] source) {
       throw new IllegalArgumentException(e);
     }
   }
+
+  @Override
+  public String signalType() {
+    return "logs";
+  }
 }

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/serialization/deserializers/MetricDataDeserializer.java

@@ -28,4 +28,9 @@ public List<MetricData> deserialize(byte[] source) {
       throw new IllegalArgumentException(e);
     }
   }
+
+  @Override
+  public String signalType() {
+    return "metrics";
+  }
 }

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/serialization/deserializers/SignalDeserializer.java

@@ -24,5 +24,11 @@ static SignalDeserializer<LogRecordData> ofLogs() {
     return LogRecordDataDeserializer.getInstance();
   }
 
+  /** Deserializes the given byte array into a list of telemetry items. */
   List<SDK_ITEM> deserialize(byte[] source);
+
+  /** Returns the name of the type of signal -- one of "metrics", "traces", or "logs". */
+  default String signalType() {
+    return "unknown";
+  }
 }

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/serialization/deserializers/SpanDataDeserializer.java

@@ -28,4 +28,9 @@ public List<SpanData> deserialize(byte[] source) {
       throw new IllegalArgumentException(e);
     }
   }
+
+  @Override
+  public String signalType() {
+    return "spans";
+  }
 }

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/storage/FolderManager.java

@@ -15,6 +15,7 @@
 import java.io.IOException;
 import java.util.Objects;
 import javax.annotation.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 public final class FolderManager {
   private final File folder;
@@ -42,6 +43,7 @@ public synchronized ReadableFile getReadableFile() throws IOException {
     return null;
   }
 
+  @NotNull
   public synchronized WritableFile createWritableFile() throws IOException {
     long systemCurrentTimeMillis = nowMillis(clock);
     File[] existingFiles = folder.listFiles();

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/storage/Storage.java

@@ -5,6 +5,9 @@
 
 package io.opentelemetry.contrib.disk.buffering.internal.storage;
 
+import static java.util.logging.Level.WARNING;
+
+import io.opentelemetry.contrib.disk.buffering.internal.exporter.FromDiskExporterImpl;
 import io.opentelemetry.contrib.disk.buffering.internal.storage.files.ReadableFile;
 import io.opentelemetry.contrib.disk.buffering.internal.storage.files.WritableFile;
 import io.opentelemetry.contrib.disk.buffering.internal.storage.responses.ReadableResult;
@@ -13,17 +16,23 @@
 import java.io.IOException;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.function.Function;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 import javax.annotation.Nullable;
 
 public final class Storage implements Closeable {
   private static final int MAX_ATTEMPTS = 3;
+  private static final Logger logger = Logger.getLogger(FromDiskExporterImpl.class.getName());
+
   private final FolderManager folderManager;
+  private final boolean debugEnabled;
   private final AtomicBoolean isClosed = new AtomicBoolean(false);
   @Nullable private WritableFile writableFile;
   @Nullable private ReadableFile readableFile;
 
-  public Storage(FolderManager folderManager) {
+  public Storage(FolderManager folderManager, boolean debugEnabled) {
     this.folderManager = folderManager;
+    this.debugEnabled = debugEnabled;
   }
 
   public static StorageBuilder builder() {
@@ -42,13 +51,16 @@ public boolean write(byte[] item) throws IOException {
 
   private boolean write(byte[] item, int attemptNumber) throws IOException {
     if (isClosed.get()) {
+      log("Refusing to write to storage after being closed.");
       return false;
     }
     if (attemptNumber > MAX_ATTEMPTS) {
+      log("Max number of attempts to write buffered data exceeded.", WARNING);
       return false;
     }
     if (writableFile == null) {
       writableFile = folderManager.createWritableFile();
+      log("Created new writableFile: " + writableFile);
     }
     WritableResult result = writableFile.append(item);
     if (result != WritableResult.SUCCEEDED) {
@@ -72,17 +84,22 @@ public ReadableResult readAndProcess(Function<byte[], Boolean> processing) throw
   private ReadableResult readAndProcess(Function<byte[], Boolean> processing, int attemptNumber)
       throws IOException {
     if (isClosed.get()) {
+      log("Refusing to read from storage after being closed.");
       return ReadableResult.FAILED;
     }
     if (attemptNumber > MAX_ATTEMPTS) {
+      log("Maximum number of attempts to read and process buffered data exceeded.", WARNING);
       return ReadableResult.FAILED;
     }
     if (readableFile == null) {
+      log("Obtaining a new readableFile from the folderManager.");
       readableFile = folderManager.getReadableFile();
       if (readableFile == null) {
+        log("Unable to get or create readable file.");
         return ReadableResult.FAILED;
       }
     }
+    log("Attempting to read data from " + readableFile);
     ReadableResult result = readableFile.readAndProcess(processing);
     switch (result) {
       case SUCCEEDED:
@@ -95,8 +112,19 @@ private ReadableResult readAndProcess(Function<byte[], Boolean> processing, int
     }
   }
 
+  private void log(String msg) {
+    log(msg, Level.INFO);
+  }
+
+  private void log(String msg, Level level) {
+    if (debugEnabled) {
+      logger.log(level, msg);
+    }
+  }
+
   @Override
   public void close() throws IOException {
+    log("Closing disk buffering storage.");
     if (isClosed.compareAndSet(false, true)) {
       if (writableFile != null) {
         writableFile.close();

disk-buffering/src/main/java/io/opentelemetry/contrib/disk/buffering/internal/storage/StorageBuilder.java

@@ -10,9 +10,13 @@
 import io.opentelemetry.sdk.common.Clock;
 import java.io.File;
 import java.io.IOException;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 public class StorageBuilder {
 
+  private static final Logger logger = Logger.getLogger(StorageBuilder.class.getName());
+
   private String folderName = "data";
   private StorageConfiguration configuration = StorageConfiguration.getDefault(new File("."));
   private Clock clock = Clock.getDefault();
@@ -40,7 +44,10 @@ public StorageBuilder setStorageClock(Clock clock) {
   public Storage build() throws IOException {
     File folder = ensureSubdir(configuration.getRootDir(), folderName);
     FolderManager folderManager = new FolderManager(folder, configuration, clock);
-    return new Storage(folderManager);
+    if (configuration.isDebugEnabled()) {
+      logger.log(Level.INFO, "Building storage with configuration => " + configuration);
+    }
+    return new Storage(folderManager, configuration.isDebugEnabled());
   }
 
   private static File ensureSubdir(File rootDir, String child) throws IOException {