davidradl commented on code in PR #26107:
URL: https://github.com/apache/flink/pull/26107#discussion_r1945020962
##########
docs/layouts/shortcodes/generated/forst_native_metric_configuration.html:
##########
@@ -0,0 +1,246 @@
+<table class="configuration table table-bordered">
+ <thead>
+ <tr>
+ <th class="text-left" style="width: 20%">Key</th>
+ <th class="text-left" style="width: 15%">Default</th>
+ <th class="text-left" style="width: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+
<td><h5>state.backend.forst.metrics.actual-delayed-write-rate</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the current actual delayed write rate. 0 means no
delay.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.background-errors</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of background errors in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.block-cache-capacity</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor block cache capacity.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.block-cache-pinned-usage</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the memory size for the entries being pinned in block
cache.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.block-cache-usage</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the memory size for the entries residing in block
cache.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.compaction-pending</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Track pending compactions in RocksDB. Returns 1 if a
compaction is pending, 0 otherwise.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.cur-size-active-mem-table</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the approximate size of the active memtable in
bytes.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.cur-size-all-mem-tables</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the approximate size of the active and unflushed
immutable memtables in bytes.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.estimate-live-data-size</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Estimate of the amount of live data in bytes (usually smaller
than sst files size due to space amplification).</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.estimate-num-keys</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Estimate the number of keys in RocksDB.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.estimate-pending-compaction-bytes</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Estimated total number of bytes compaction needs to rewrite to
get all levels down to under target size. Not valid for other compactions than
level-based.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.estimate-table-readers-mem</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Estimate the memory used for reading SST tables, excluding
memory used in block cache (e.g.,filter and index blocks) in bytes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.is-write-stopped</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Track whether write has been stopped in RocksDB. Returns 1 if
write has been stopped, 0 otherwise.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.live-sst-files-size</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total size (bytes) of all SST files belonging to
the latest version.WARNING: may slow down online queries if there are too many
files.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.mem-table-flush-pending</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of pending memtable flushes in RocksDB.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.num-deletes-active-mem-table</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total number of delete entries in the active
memtable.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.num-deletes-imm-mem-tables</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total number of delete entries in the unflushed
immutable memtables.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.num-entries-active-mem-table</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total number of entries in the active
memtable.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.num-entries-imm-mem-tables</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total number of entries in the unflushed immutable
memtables.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.num-immutable-mem-table</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of immutable memtables in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.num-live-versions</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor number of live versions. Version is an internal data
structure. See RocksDB file version_set.h for details. More live versions often
mean more SST files are held from being deleted, by iterators or unfinished
compactions.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.forst.metrics.num-running-compactions</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of currently running compactions.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.num-running-flushes</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of currently running flushes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.num-snapshots</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of unreleased snapshots of the
database.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.size-all-mem-tables</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the approximate size of the active, unflushed
immutable, and pinned immutable memtables in bytes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.forst.metrics.total-sst-files-size</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total size (bytes) of all SST files of all
versions.WARNING: may slow down online queries if there are too many files.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.block-cache-hit</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total count of block cache hit in RocksDB
(BLOCK_CACHE_HIT == BLOCK_CACHE_INDEX_HIT + BLOCK_CACHE_FILTER_HIT +
BLOCK_CACHE_DATA_HIT).</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.block-cache-miss</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total count of block cache misses in RocksDB
(BLOCK_CACHE_MISS == BLOCK_CACHE_INDEX_MISS + BLOCK_CACHE_FILTER_MISS +
BLOCK_CACHE_DATA_MISS).</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.rocksdb.metrics.bloom-filter-full-positive</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total count of reads not avoided by bloom full
filter.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.rocksdb.metrics.bloom-filter-full-true-positive</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total count of reads not avoided by bloom full
filter and the data actually exists in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.bloom-filter-useful</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total count of reads avoided by bloom filter.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.bytes-read</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of uncompressed bytes read (from
memtables/cache/sst) from Get() operation in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.bytes-written</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of uncompressed bytes written by
DB::{Put(), Delete(), Merge(), Write()} operations, which does not include the
compaction written bytes, in RocksDB.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.rocksdb.metrics.column-family-as-variable</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Whether to expose the column family as a variable for RocksDB
property based metrics.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.rocksdb.metrics.compaction-read-bytes</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the bytes read during compaction in RocksDB.</td>
+ </tr>
+ <tr>
+
<td><h5>state.backend.rocksdb.metrics.compaction-write-bytes</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the bytes written during compaction in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.iter-bytes-read</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of uncompressed bytes read (from
memtables/cache/sst) from an iterator operation in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-files-at-level</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of files at each level.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.stall-micros</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the duration of writer requiring to wait for
compaction or flush to finish in RocksDB.</td>
Review Comment:
nit: Monitor the duration of writer requiring to wait -> Monitor writer wait
duration
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
