Package io.opentelemetry.contrib.disk.buffering.storage.impl

Class FileStorageConfiguration

java.lang.Object
io.opentelemetry.contrib.disk.buffering.storage.impl.FileStorageConfiguration
public abstract class FileStorageConfiguration extends Object
Defines how the storage should be managed.

  • Constructor Details

    • FileStorageConfiguration

      public FileStorageConfiguration()

  • Method Details

    • getMaxFileAgeForWriteMillis

      public abstract long getMaxFileAgeForWriteMillis()
      The max amount of time a file can receive new data.

    • getMinFileAgeForReadMillis

      public abstract long getMinFileAgeForReadMillis()
      The min amount of time needed to pass before reading from a file. Historically this was the mechanism that prevented the reader from observing a file the writer was still appending to. As of the rename-on-close design, finalized files are made visible to the reader atomically once they are rolled, so this value is no longer required for correctness and defaults to 0. The setting is kept for callers that still want to delay reads of newly-rolled files (e.g. to encourage larger batches before iteration).

    • getMaxFileAgeForReadMillis

      public abstract long getMaxFileAgeForReadMillis()
      The max amount of time a file can be read from, which is also the amount of time a file is not considered to be deleted as stale.

    • getMaxFileSize

      public abstract int getMaxFileSize()
      The max file size, If the getMaxFileAgeForWriteMillis() time value hasn't passed but the file has reached this size, it stops receiving data.

    • getMaxFolderSize

      public abstract int getMaxFolderSize()
      All the files are stored in a signal-specific folder. This number represents each folder's size, therefore the max amount of cache size for the overall telemetry data would be the sum of the folder sizes of all the signals being stored in disk.

    • getDeleteItemsOnIteration

      public abstract boolean getDeleteItemsOnIteration()
      Whether to automatically delete items from disk during iteration. When true (the default), items are removed from disk as the iterator advances. When false, items remain on disk until explicitly removed via Iterator.remove().

    • getDefault

      public static FileStorageConfiguration getDefault()

    • builder

      public static FileStorageConfiguration.Builder builder()