Package org.apache.flink.state.rocksdb

Enum RocksDBProperty

java.lang.Object
java.lang.Enum<RocksDBProperty>
org.apache.flink.state.rocksdb.RocksDBProperty
All Implemented Interfaces:
Serializable, Comparable<RocksDBProperty>
@Internal public enum RocksDBProperty extends Enum<RocksDBProperty>
RocksDB properties that can be queried by Flink's metrics reporter.

Note: Metrics properties are added in each new version of RocksDB, when upgrading to a latter version consider updating this class with newly added properties.

  • Enum Constant Details

    • NumImmutableMemTable

      public static final RocksDBProperty NumImmutableMemTable

    • MemTableFlushPending

      public static final RocksDBProperty MemTableFlushPending

    • CompactionPending

      public static final RocksDBProperty CompactionPending

    • BackgroundErrors

      public static final RocksDBProperty BackgroundErrors

    • CurSizeActiveMemTable

      public static final RocksDBProperty CurSizeActiveMemTable

    • CurSizeAllMemTables

      public static final RocksDBProperty CurSizeAllMemTables

    • SizeAllMemTables

      public static final RocksDBProperty SizeAllMemTables

    • NumEntriesActiveMemTable

      public static final RocksDBProperty NumEntriesActiveMemTable

    • NumEntriesImmMemTables

      public static final RocksDBProperty NumEntriesImmMemTables

    • NumDeletesActiveMemTable

      public static final RocksDBProperty NumDeletesActiveMemTable

    • NumDeletesImmMemTables

      public static final RocksDBProperty NumDeletesImmMemTables

    • EstimateNumKeys

      public static final RocksDBProperty EstimateNumKeys

    • EstimateTableReadersMem

      public static final RocksDBProperty EstimateTableReadersMem

    • NumSnapshots

      public static final RocksDBProperty NumSnapshots

    • NumLiveVersions

      public static final RocksDBProperty NumLiveVersions

    • EstimateLiveDataSize

      public static final RocksDBProperty EstimateLiveDataSize

    • TotalSstFilesSize

      public static final RocksDBProperty TotalSstFilesSize

    • LiveSstFilesSize

      public static final RocksDBProperty LiveSstFilesSize

    • EstimatePendingCompactionBytes

      public static final RocksDBProperty EstimatePendingCompactionBytes

    • NumRunningCompactions

      public static final RocksDBProperty NumRunningCompactions

    • NumRunningFlushes

      public static final RocksDBProperty NumRunningFlushes

    • ActualDelayedWriteRate

      public static final RocksDBProperty ActualDelayedWriteRate

    • IsWriteStopped

      public static final RocksDBProperty IsWriteStopped

    • BlockCacheCapacity

      public static final RocksDBProperty BlockCacheCapacity

    • BlockCacheUsage

      public static final RocksDBProperty BlockCacheUsage

    • BlockCachePinnedUsage

      public static final RocksDBProperty BlockCachePinnedUsage

    • NumFilesAtLevel0

      public static final RocksDBProperty NumFilesAtLevel0

    • NumFilesAtLevel1

      public static final RocksDBProperty NumFilesAtLevel1

    • NumFilesAtLevel2

      public static final RocksDBProperty NumFilesAtLevel2

    • NumFilesAtLevel3

      public static final RocksDBProperty NumFilesAtLevel3

    • NumFilesAtLevel4

      public static final RocksDBProperty NumFilesAtLevel4

    • NumFilesAtLevel5

      public static final RocksDBProperty NumFilesAtLevel5

    • NumFilesAtLevel6

      public static final RocksDBProperty NumFilesAtLevel6

  • Field Details

  • Method Details

    • values

      public static RocksDBProperty[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static RocksDBProperty valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getRocksDBProperty

      public String getRocksDBProperty()
      Returns:
      property string that can be used to query RocksDB.getLongProperty(ColumnFamilyHandle, String).

    • getNumericalPropertyValue

      public long getNumericalPropertyValue(org.rocksdb.RocksDB rocksDB, org.rocksdb.ColumnFamilyHandle handle) throws Exception
      Throws:
      Exception

    • getConfigKey

      public String getConfigKey()
      Returns:
      key for enabling metric using Configuration.