metric_engine/
utils.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::collections::HashMap;
16
17use common_telemetry::{info, warn};
18use mito2::engine::MitoEngine;
19use snafu::ResultExt;
20use store_api::metric_engine_consts::{
21    MANIFEST_INFO_EXTENSION_KEY, METRIC_DATA_REGION_GROUP, METRIC_METADATA_REGION_GROUP,
22};
23use store_api::region_engine::{RegionEngine, RegionManifestInfo, RegionStatistic};
24use store_api::storage::RegionId;
25
26use crate::error::{Result, SerializeRegionManifestInfoSnafu};
27
28/// Change the given [RegionId]'s region group to [METRIC_METADATA_REGION_GROUP].
29pub fn to_metadata_region_id(region_id: RegionId) -> RegionId {
30    let table_id = region_id.table_id();
31    let region_sequence = region_id.region_sequence();
32    RegionId::with_group_and_seq(table_id, METRIC_METADATA_REGION_GROUP, region_sequence)
33}
34
35/// Change the given [RegionId]'s region group to [METRIC_DATA_REGION_GROUP].
36pub fn to_data_region_id(region_id: RegionId) -> RegionId {
37    let table_id = region_id.table_id();
38    let region_sequence = region_id.region_sequence();
39    RegionId::with_group_and_seq(table_id, METRIC_DATA_REGION_GROUP, region_sequence)
40}
41
42/// Get the region statistic of the given [RegionId].
43pub fn get_region_statistic(mito: &MitoEngine, region_id: RegionId) -> Option<RegionStatistic> {
44    let metadata_region_id = to_metadata_region_id(region_id);
45    let data_region_id = to_data_region_id(region_id);
46
47    let metadata_stat = mito.region_statistic(metadata_region_id);
48    let data_stat = mito.region_statistic(data_region_id);
49
50    match (&metadata_stat, &data_stat) {
51        (Some(metadata_stat), Some(data_stat)) => {
52            Some(merge_region_statistic(metadata_stat, data_stat))
53        }
54        _ => {
55            warn!(
56                "Failed to get region statistic for region {}, metadata_stat: {:?}, data_stat: {:?}",
57                region_id, metadata_stat, data_stat
58            );
59            None
60        }
61    }
62}
63
64fn merge_region_statistic(
65    metadata_stat: &RegionStatistic,
66    data_stat: &RegionStatistic,
67) -> RegionStatistic {
68    RegionStatistic {
69        num_rows: metadata_stat.num_rows + data_stat.num_rows,
70        memtable_size: metadata_stat.memtable_size + data_stat.memtable_size,
71        wal_size: metadata_stat.wal_size + data_stat.wal_size,
72        manifest_size: metadata_stat.manifest_size + data_stat.manifest_size,
73        sst_size: metadata_stat.sst_size + data_stat.sst_size,
74        sst_num: metadata_stat.sst_num + data_stat.sst_num,
75        index_size: metadata_stat.index_size + data_stat.index_size,
76        manifest: RegionManifestInfo::Metric {
77            data_flushed_entry_id: data_stat.manifest.data_flushed_entry_id(),
78            data_manifest_version: data_stat.manifest.data_manifest_version(),
79            metadata_flushed_entry_id: metadata_stat.manifest.data_flushed_entry_id(),
80            metadata_manifest_version: metadata_stat.manifest.data_manifest_version(),
81        },
82        written_bytes: metadata_stat.written_bytes + data_stat.written_bytes,
83        query_cpu_time: data_stat.query_cpu_time,
84        query_scanned_bytes: data_stat.query_scanned_bytes,
85        data_topic_latest_entry_id: data_stat.data_topic_latest_entry_id,
86        metadata_topic_latest_entry_id: metadata_stat.metadata_topic_latest_entry_id,
87    }
88}
89
90/// Appends the given [RegionId]'s manifest info to the given list.
91pub(crate) fn append_manifest_info(
92    mito: &MitoEngine,
93    region_id: RegionId,
94    manifest_infos: &mut Vec<(RegionId, RegionManifestInfo)>,
95) {
96    if let Some(statistic) = get_region_statistic(mito, region_id) {
97        manifest_infos.push((region_id, statistic.manifest));
98    }
99}
100
101/// Encodes the given list of ([RegionId], [RegionManifestInfo]) to extensions(key: MANIFEST_INFO_EXTENSION_KEY).
102pub(crate) fn encode_manifest_info_to_extensions(
103    manifest_infos: &[(RegionId, RegionManifestInfo)],
104    extensions: &mut HashMap<String, Vec<u8>>,
105) -> Result<()> {
106    extensions.insert(
107        MANIFEST_INFO_EXTENSION_KEY.to_string(),
108        RegionManifestInfo::encode_list(manifest_infos)
109            .context(SerializeRegionManifestInfoSnafu)?,
110    );
111    for (region_id, manifest_info) in manifest_infos {
112        info!(
113            "Added manifest info: {:?} to extensions, region_id: {:?}",
114            manifest_info, region_id
115        );
116    }
117    Ok(())
118}
119
120#[cfg(test)]
121mod tests {
122
123    use super::*;
124
125    #[test]
126    fn test_to_metadata_region_id() {
127        let region_id = RegionId::new(1, 2);
128        let expected_region_id = RegionId::with_group_and_seq(1, METRIC_METADATA_REGION_GROUP, 2);
129        assert_eq!(to_metadata_region_id(region_id), expected_region_id);
130
131        let region_id = RegionId::with_group_and_seq(1, 243, 2);
132        let expected_region_id = RegionId::with_group_and_seq(1, METRIC_METADATA_REGION_GROUP, 2);
133        assert_eq!(to_metadata_region_id(region_id), expected_region_id);
134    }
135
136    #[test]
137    fn test_to_data_region_id() {
138        let region_id = RegionId::new(1, 2);
139        let expected_region_id = RegionId::with_group_and_seq(1, METRIC_DATA_REGION_GROUP, 2);
140        assert_eq!(to_data_region_id(region_id), expected_region_id);
141
142        let region_id = RegionId::with_group_and_seq(1, 243, 2);
143        let expected_region_id = RegionId::with_group_and_seq(1, METRIC_DATA_REGION_GROUP, 2);
144        assert_eq!(to_data_region_id(region_id), expected_region_id);
145    }
146
147    #[test]
148    fn merge_region_statistic_uses_data_region_query_stats() {
149        let metadata_stat = RegionStatistic {
150            query_cpu_time: 100,
151            query_scanned_bytes: 200,
152            manifest: RegionManifestInfo::mito(1, 2, 0),
153            ..Default::default()
154        };
155        let data_stat = RegionStatistic {
156            query_cpu_time: 10,
157            query_scanned_bytes: 20,
158            manifest: RegionManifestInfo::mito(3, 4, 0),
159            ..Default::default()
160        };
161
162        let statistic = merge_region_statistic(&metadata_stat, &data_stat);
163
164        assert_eq!(statistic.query_cpu_time, 10);
165        assert_eq!(statistic.query_scanned_bytes, 20);
166    }
167}
metric_engine/utils.rs

metric_engine/
utils.rs
