Package io.opentelemetry.contrib.disk.buffering

Class StorageConfiguration

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

  • Constructor Details

    • StorageConfiguration

      public StorageConfiguration()

  • Method Details

    • getRootDir

      public abstract File getRootDir()
      The root storage location for buffered telemetry.

    • isDebugEnabled

      public abstract boolean isDebugEnabled()
      Returns true if the storage has been configured with debug verbosity enabled.

    • 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. This value MUST be greater than getMaxFileAgeForWriteMillis() to make sure the selected file to read is not being written to.

    • 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.

    • getTemporaryFileProvider

      public abstract io.opentelemetry.contrib.disk.buffering.internal.files.TemporaryFileProvider getTemporaryFileProvider()
      A creator of temporary files needed to do the disk reading process.

    • getDefault

      public static StorageConfiguration getDefault(File rootDir)

    • builder

      public static StorageConfiguration.Builder builder()