Package org.apache.flink.state.forst

Enum ForStProperty

java.lang.Object
java.lang.Enum<ForStProperty>
org.apache.flink.state.forst.ForStProperty
All Implemented Interfaces:
Serializable, Comparable<ForStProperty>
@Internal public enum ForStProperty extends Enum<ForStProperty>
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 ForStProperty NumImmutableMemTable

    • MemTableFlushPending

      public static final ForStProperty MemTableFlushPending

    • CompactionPending

      public static final ForStProperty CompactionPending

    • BackgroundErrors

      public static final ForStProperty BackgroundErrors

    • CurSizeActiveMemTable

      public static final ForStProperty CurSizeActiveMemTable

    • CurSizeAllMemTables

      public static final ForStProperty CurSizeAllMemTables

    • SizeAllMemTables

      public static final ForStProperty SizeAllMemTables

    • NumEntriesActiveMemTable

      public static final ForStProperty NumEntriesActiveMemTable

    • NumEntriesImmMemTables

      public static final ForStProperty NumEntriesImmMemTables

    • NumDeletesActiveMemTable

      public static final ForStProperty NumDeletesActiveMemTable

    • NumDeletesImmMemTables

      public static final ForStProperty NumDeletesImmMemTables

    • EstimateNumKeys

      public static final ForStProperty EstimateNumKeys

    • EstimateTableReadersMem

      public static final ForStProperty EstimateTableReadersMem

    • NumSnapshots

      public static final ForStProperty NumSnapshots

    • NumLiveVersions

      public static final ForStProperty NumLiveVersions

    • EstimateLiveDataSize

      public static final ForStProperty EstimateLiveDataSize

    • TotalSstFilesSize

      public static final ForStProperty TotalSstFilesSize

    • LiveSstFilesSize

      public static final ForStProperty LiveSstFilesSize

    • EstimatePendingCompactionBytes

      public static final ForStProperty EstimatePendingCompactionBytes

    • NumRunningCompactions

      public static final ForStProperty NumRunningCompactions

    • NumRunningFlushes

      public static final ForStProperty NumRunningFlushes

    • ActualDelayedWriteRate

      public static final ForStProperty ActualDelayedWriteRate

    • IsWriteStopped

      public static final ForStProperty IsWriteStopped

    • BlockCacheCapacity

      public static final ForStProperty BlockCacheCapacity

    • BlockCacheUsage

      public static final ForStProperty BlockCacheUsage

    • BlockCachePinnedUsage

      public static final ForStProperty BlockCachePinnedUsage

    • NumFilesAtLevel0

      public static final ForStProperty NumFilesAtLevel0

    • NumFilesAtLevel1

      public static final ForStProperty NumFilesAtLevel1

    • NumFilesAtLevel2

      public static final ForStProperty NumFilesAtLevel2

    • NumFilesAtLevel3

      public static final ForStProperty NumFilesAtLevel3

    • NumFilesAtLevel4

      public static final ForStProperty NumFilesAtLevel4

    • NumFilesAtLevel5

      public static final ForStProperty NumFilesAtLevel5

    • NumFilesAtLevel6

      public static final ForStProperty NumFilesAtLevel6

  • Method Details

    • values

      public static ForStProperty[] 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 ForStProperty 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

    • getForStProperty

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

    • getNumericalPropertyValue

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

    • getConfigKey

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