epoch-db 0.2.9

An intelligent, persistent, and concurrent key-value store for Rust, designed to manage data with a lifecycle through frequency tracking and TTL.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! The `metrics` module defines the `Metrics` struct and its associated
//! methods.
//!
//! The corresponding struct is used to update all of the Prometheus metrics
//! that the database contains.

// TODO: Refactor the whole file to use Prometheus crate instead for testing
// purposes

use metrics::{
    counter,
    gauge
};

/// A stateless struct that provides a clean, organized API for updating
/// the application's global Prometheus metrics via the `metrics` facade.
#[derive(Debug)]
pub struct Metrics {}

impl Metrics {
    /// Sets the current number of keys for a given tree.
    pub fn set_keys_total(tree: &str, value: u64) {
        gauge!("epochdb_keys_total", "tree" => tree.to_string()).set(value as f64);
    }

    /// Sets the current number of keys for a given tree.
    pub fn inc_keys_total(tree: &str) {
        gauge!("epochdb_keys_total", "tree" => tree.to_string()).increment(1);
    }

    /// Sets the current number of keys for a given tree.
    pub fn dec_keys_total(tree: &str) {
        gauge!("epochdb_keys_total", "tree" => tree.to_string()).decrement(1);
    }

    /// Increments the counter for a specific database operation.
    pub fn increment_operations(op: &str) {
        counter!("epochdb_operations_total", "operation" => op.to_string()).increment(1);
    }

    /// Sets the current total disk size of the database.
    pub fn set_disk_size(bytes: f64) {
        gauge!("epochdb_disk_size_bytes").set(bytes);
    }

    /// Sets the size of the last successful backup.
    pub fn set_backup_size(bytes: f64) {
        gauge!("epochdb_backup_size_bytes").set(bytes);
    }

    /// Increments the counter for expired TTL keys.
    pub fn increment_ttl_expired_keys() {
        counter!("epochdb_ttl_expired_keys_total").increment(1);
    }

    /// Sets the current number of keys for a given tree.
    pub fn inc_amount_keys_total(tree: &str, value: u64) {
        gauge!("epochdb_keys_total", "tree" => tree.to_string()).set(value as f64);
    }

    /// Sets the current number of keys for a given tree.
    pub fn dec_amount_keys_total(tree: &str, amount: u64) {
        gauge!("epochdb_keys_total", "tree" => tree.to_string()).decrement(amount as f64);
    }

    /// Increments the counter for a specific database operation.
    pub fn increment_amount_operations(op: &str, amount: u64) {
        counter!("epochdb_operations_total", "operation" => op.to_string()).increment(amount);
    }
}