fix: Clarify how metrics are recorded in the docs for the metric fields

pull/24376/head
Carol (Nichols || Goulding) 2022-07-18 15:24:29 -04:00
parent 07e10852a8
commit 0a545bf325
No known key found for this signature in database
GPG Key ID: E907EE5A736F87D4
1 changed files with 5 additions and 2 deletions

View File

@ -245,10 +245,13 @@ pub struct Compactor {
/// Gauge for the number of compaction partition candidates
compaction_candidate_gauge: Metric<U64Gauge>,
/// Gauge for the number of Parquet file candidates
/// Gauge for the number of Parquet file candidates. The recorded values have attributes for
/// the compaction level of the file and whether the file was selected for compaction or not.
pub(crate) parquet_file_candidate_gauge: Metric<U64Gauge>,
/// Gauge for the number of bytes of Parquet file candidates
/// Gauge for the number of bytes of Parquet file candidates. The recorded values have
/// attributes for the compaction level of the file and whether the file was selected for
/// compaction or not.
pub(crate) parquet_file_candidate_bytes_gauge: Metric<U64Gauge>,
/// Histogram for tracking the time to compact a partition