metric_engine/
lib.rs

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
// Copyright 2023 Greptime Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Metric Engine is a region engine to store timeseries data in metric monitoring
//! scenario. It is something like a multiplexer over the [Mito](mito2::engine::MitoEngine)
//! engine, which is for a more generic use case. By leveraging a synthetic wide physical
//! table (region) that offers storage for multiple logical tables, Metric Engine is able to
//! provide a more efficient storage solution that is able to handle a tremendous number of
//! small tables in scenarios like Prometheus metrics.
//!
//! For more details about implementation, please refer to [MetricEngine](crate::engine::MetricEngine).
//!
//! This new engine doesn't re-implement low level components like file R/W etc. It warps the
//! existing mito engine, with extra storage and metadata multiplexing logic. I.e., it expose
//! multiple logical regions based on two physical mito engine regions like this:
//!
//! ```plaintext
//! ┌───────────────┐ ┌───────────────┐ ┌───────────────┐
//! │ Metric Engine │ │ Metric Engine │ │ Metric Engine │
//! │   Region 1    │ │   Region 2    │ │   Region 3    │
//! └───────────────┘ └───────────────┘ └───────────────┘
//!         ▲               ▲                   ▲
//!         │               │                   │
//!         └───────────────┼───────────────────┘
//!                         │
//!               ┌─────────┴────────┐
//!               │ Metric Region    │
//!               │   Engine         │
//!               │    ┌─────────────┤
//!               │    │ Mito Region │
//!               │    │   Engine    │
//!               └────▲─────────────┘
//!                    │
//!                    │
//!              ┌─────┴───────────────┐
//!              │                     │
//!              │ Mito Engine Regions │
//!              │                     │
//!              └─────────────────────┘
//! ```

#![feature(let_chains)]
#![feature(assert_matches)]

pub mod config;
mod data_region;
pub mod engine;
pub mod error;
mod metadata_region;
mod metrics;
pub mod row_modifier;
#[cfg(test)]
mod test_util;
mod utils;