Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Track store metrics by DB column #6041

Merged
merged 1 commit into from
Jul 18, 2024
Merged

Track store metrics by DB column #6041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions beacon_node/store/src/leveldb_store.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,13 @@ impl<E: EthSpec> LevelDB<E> {
) -> Result<(), Error> {
let column_key = get_key_for_col(col, key);

metrics::inc_counter(&metrics::DISK_DB_WRITE_COUNT);
metrics::inc_counter_by(&metrics::DISK_DB_WRITE_BYTES, val.len() as u64);
let timer = metrics::start_timer(&metrics::DISK_DB_WRITE_TIMES);
metrics::inc_counter_vec(&metrics::DISK_DB_WRITE_COUNT, &[col]);
metrics::inc_counter_vec_by(&metrics::DISK_DB_WRITE_BYTES, &[col], val.len() as u64);
let _timer = metrics::start_timer(&metrics::DISK_DB_WRITE_TIMES);

self.db
.put(opts, BytesKey::from_vec(column_key), val)
.map_err(Into::into)
.map(|()| {
metrics::stop_timer(timer);
})
}

pub fn keys_iter(&self) -> KeyIterator<BytesKey> {
Expand All @@ -94,15 +91,19 @@ impl<E: EthSpec> KeyValueStore<E> for LevelDB<E> {
fn get_bytes(&self, col: &str, key: &[u8]) -> Result<Option<Vec<u8>>, Error> {
let column_key = get_key_for_col(col, key);

metrics::inc_counter(&metrics::DISK_DB_READ_COUNT);
metrics::inc_counter_vec(&metrics::DISK_DB_READ_COUNT, &[col]);
let timer = metrics::start_timer(&metrics::DISK_DB_READ_TIMES);

self.db
.get(self.read_options(), BytesKey::from_vec(column_key))
.map_err(Into::into)
.map(|opt| {
opt.map(|bytes| {
metrics::inc_counter_by(&metrics::DISK_DB_READ_BYTES, bytes.len() as u64);
metrics::inc_counter_vec_by(
&metrics::DISK_DB_READ_BYTES,
&[col],
bytes.len() as u64,
);
metrics::stop_timer(timer);
bytes
})
Expand All @@ -113,7 +114,7 @@ impl<E: EthSpec> KeyValueStore<E> for LevelDB<E> {
fn key_exists(&self, col: &str, key: &[u8]) -> Result<bool, Error> {
let column_key = get_key_for_col(col, key);

metrics::inc_counter(&metrics::DISK_DB_EXISTS_COUNT);
metrics::inc_counter_vec(&metrics::DISK_DB_EXISTS_COUNT, &[col]);

self.db
.get(self.read_options(), BytesKey::from_vec(column_key))
Expand All @@ -125,7 +126,7 @@ impl<E: EthSpec> KeyValueStore<E> for LevelDB<E> {
fn key_delete(&self, col: &str, key: &[u8]) -> Result<(), Error> {
let column_key = get_key_for_col(col, key);

metrics::inc_counter(&metrics::DISK_DB_DELETE_COUNT);
metrics::inc_counter_vec(&metrics::DISK_DB_DELETE_COUNT, &[col]);

self.db
.delete(self.write_options(), BytesKey::from_vec(column_key))
Expand All @@ -137,14 +138,28 @@ impl<E: EthSpec> KeyValueStore<E> for LevelDB<E> {
for op in ops_batch {
match op {
KeyValueStoreOp::PutKeyValue(key, value) => {
let col = get_col_from_key(&key).unwrap_or("unknown".to_owned());
metrics::inc_counter_vec(&metrics::DISK_DB_WRITE_COUNT, &[&col]);
metrics::inc_counter_vec_by(
&metrics::DISK_DB_WRITE_BYTES,
&[&col],
value.len() as u64,
);

leveldb_batch.put(BytesKey::from_vec(key), &value);
}

KeyValueStoreOp::DeleteKey(key) => {
let col = get_col_from_key(&key).unwrap_or("unknown".to_owned());
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

get_col_from_key should never error as we define the DBColumn enum variants. The use of col is purely informational on metrics, so unwrapping to unknown to have something

metrics::inc_counter_vec(&metrics::DISK_DB_DELETE_COUNT, &[&col]);

leveldb_batch.delete(BytesKey::from_vec(key));
}
}
}

let _timer = metrics::start_timer(&metrics::DISK_DB_WRITE_TIMES);

self.db.write(self.write_options(), &leveldb_batch)?;
Ok(())
}
Expand Down
14 changes: 14 additions & 0 deletions beacon_node/store/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,13 @@ pub fn get_key_for_col(column: &str, key: &[u8]) -> Vec<u8> {
result
}

pub fn get_col_from_key(key: &[u8]) -> Option<String> {
if key.len() < 3 {
return None;
}
String::from_utf8(key[0..3].to_vec()).ok()
}

#[must_use]
#[derive(Clone)]
pub enum KeyValueStoreOp {
Expand Down Expand Up @@ -412,4 +419,11 @@ mod tests {

assert!(!store.exists::<StorableThing>(&key).unwrap());
}

#[test]
fn test_get_col_from_key() {
let key = get_key_for_col(DBColumn::BeaconBlock.into(), &[1u8; 32]);
let col = get_col_from_key(&key).unwrap();
assert_eq!(col, "blk");
}
}
30 changes: 18 additions & 12 deletions beacon_node/store/src/metrics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,25 @@ lazy_static! {
try_create_int_gauge("store_disk_db_size", "Size of the hot on-disk database (bytes)");
pub static ref FREEZER_DB_SIZE: Result<IntGauge> =
try_create_int_gauge("store_freezer_db_size", "Size of the on-disk freezer database (bytes)");
pub static ref DISK_DB_WRITE_BYTES: Result<IntCounter> = try_create_int_counter(
pub static ref DISK_DB_WRITE_BYTES: Result<IntCounterVec> = try_create_int_counter_vec(
"store_disk_db_write_bytes_total",
"Number of bytes attempted to be written to the hot on-disk DB"
"Number of bytes attempted to be written to the hot on-disk DB",
&["col"],
);
pub static ref DISK_DB_READ_BYTES: Result<IntCounter> = try_create_int_counter(
pub static ref DISK_DB_READ_BYTES: Result<IntCounterVec> = try_create_int_counter_vec(
"store_disk_db_read_bytes_total",
"Number of bytes read from the hot on-disk DB"
"Number of bytes read from the hot on-disk DB",
&["col"],
);
pub static ref DISK_DB_READ_COUNT: Result<IntCounter> = try_create_int_counter(
pub static ref DISK_DB_READ_COUNT: Result<IntCounterVec> = try_create_int_counter_vec(
"store_disk_db_read_count_total",
"Total number of reads to the hot on-disk DB"
"Total number of reads to the hot on-disk DB",
&["col"],
);
pub static ref DISK_DB_WRITE_COUNT: Result<IntCounter> = try_create_int_counter(
pub static ref DISK_DB_WRITE_COUNT: Result<IntCounterVec> = try_create_int_counter_vec(
"store_disk_db_write_count_total",
"Total number of writes to the hot on-disk DB"
"Total number of writes to the hot on-disk DB",
&["col"],
);
pub static ref DISK_DB_READ_TIMES: Result<Histogram> = try_create_histogram(
"store_disk_db_read_seconds",
Expand All @@ -36,13 +40,15 @@ lazy_static! {
"store_disk_db_write_seconds",
"Time taken to write bytes to store."
);
pub static ref DISK_DB_EXISTS_COUNT: Result<IntCounter> = try_create_int_counter(
pub static ref DISK_DB_EXISTS_COUNT: Result<IntCounterVec> = try_create_int_counter_vec(
"store_disk_db_exists_count_total",
"Total number of checks if a key is in the hot on-disk DB"
"Total number of checks if a key is in the hot on-disk DB",
&["col"],
);
pub static ref DISK_DB_DELETE_COUNT: Result<IntCounter> = try_create_int_counter(
pub static ref DISK_DB_DELETE_COUNT: Result<IntCounterVec> = try_create_int_counter_vec(
"store_disk_db_delete_count_total",
"Total number of deletions from the hot on-disk DB"
"Total number of deletions from the hot on-disk DB",
&["col"],
);
/*
* Beacon State
Expand Down
Loading