Files
greptimedb/src/metric_engine/utils.rs.html
2026-04-02 04:05:08 +00:00

136 lines
16 KiB
HTML

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/metric-engine/src/utils.rs`."><title>utils.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="metric_engine" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">metric_engine/</div>utils.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
<a href=#2 id=2 data-nosnippet>2</a>//
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
<a href=#6 id=6 data-nosnippet>6</a>//
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
<a href=#8 id=8 data-nosnippet>8</a>//
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
<a href=#14 id=14 data-nosnippet>14</a>
<a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">use </span>std::collections::HashMap;
<a href=#16 id=16 data-nosnippet>16</a>
<a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>common_telemetry::{info, warn};
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>mito2::engine::MitoEngine;
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>snafu::ResultExt;
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>store_api::metric_engine_consts::{
<a href=#21 id=21 data-nosnippet>21</a> MANIFEST_INFO_EXTENSION_KEY, METRIC_DATA_REGION_GROUP, METRIC_METADATA_REGION_GROUP,
<a href=#22 id=22 data-nosnippet>22</a>};
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>store_api::region_engine::{RegionEngine, RegionManifestInfo, RegionStatistic};
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>store_api::storage::RegionId;
<a href=#25 id=25 data-nosnippet>25</a>
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span><span class="kw">crate</span>::error::{<span class="prelude-ty">Result</span>, SerializeRegionManifestInfoSnafu};
<a href=#27 id=27 data-nosnippet>27</a>
<a href=#28 id=28 data-nosnippet>28</a><span class="doccomment">/// Change the given [RegionId]'s region group to [METRIC_METADATA_REGION_GROUP].
<a href=#29 id=29 data-nosnippet>29</a></span><span class="kw">pub fn </span>to_metadata_region_id(region_id: RegionId) -&gt; RegionId {
<a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>table_id = region_id.table_id();
<a href=#31 id=31 data-nosnippet>31</a> <span class="kw">let </span>region_sequence = region_id.region_sequence();
<a href=#32 id=32 data-nosnippet>32</a> RegionId::with_group_and_seq(table_id, METRIC_METADATA_REGION_GROUP, region_sequence)
<a href=#33 id=33 data-nosnippet>33</a>}
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a><span class="doccomment">/// Change the given [RegionId]'s region group to [METRIC_DATA_REGION_GROUP].
<a href=#36 id=36 data-nosnippet>36</a></span><span class="kw">pub fn </span>to_data_region_id(region_id: RegionId) -&gt; RegionId {
<a href=#37 id=37 data-nosnippet>37</a> <span class="kw">let </span>table_id = region_id.table_id();
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">let </span>region_sequence = region_id.region_sequence();
<a href=#39 id=39 data-nosnippet>39</a> RegionId::with_group_and_seq(table_id, METRIC_DATA_REGION_GROUP, region_sequence)
<a href=#40 id=40 data-nosnippet>40</a>}
<a href=#41 id=41 data-nosnippet>41</a>
<a href=#42 id=42 data-nosnippet>42</a><span class="doccomment">/// Get the region statistic of the given [RegionId].
<a href=#43 id=43 data-nosnippet>43</a></span><span class="kw">pub fn </span>get_region_statistic(mito: <span class="kw-2">&amp;</span>MitoEngine, region_id: RegionId) -&gt; <span class="prelude-ty">Option</span>&lt;RegionStatistic&gt; {
<a href=#44 id=44 data-nosnippet>44</a> <span class="kw">let </span>metadata_region_id = to_metadata_region_id(region_id);
<a href=#45 id=45 data-nosnippet>45</a> <span class="kw">let </span>data_region_id = to_data_region_id(region_id);
<a href=#46 id=46 data-nosnippet>46</a>
<a href=#47 id=47 data-nosnippet>47</a> <span class="kw">let </span>metadata_stat = mito.region_statistic(metadata_region_id);
<a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>data_stat = mito.region_statistic(data_region_id);
<a href=#49 id=49 data-nosnippet>49</a>
<a href=#50 id=50 data-nosnippet>50</a> <span class="kw">match </span>(<span class="kw-2">&amp;</span>metadata_stat, <span class="kw-2">&amp;</span>data_stat) {
<a href=#51 id=51 data-nosnippet>51</a> (<span class="prelude-val">Some</span>(metadata_stat), <span class="prelude-val">Some</span>(data_stat)) =&gt; <span class="prelude-val">Some</span>(RegionStatistic {
<a href=#52 id=52 data-nosnippet>52</a> num_rows: metadata_stat.num_rows + data_stat.num_rows,
<a href=#53 id=53 data-nosnippet>53</a> memtable_size: metadata_stat.memtable_size + data_stat.memtable_size,
<a href=#54 id=54 data-nosnippet>54</a> wal_size: metadata_stat.wal_size + data_stat.wal_size,
<a href=#55 id=55 data-nosnippet>55</a> manifest_size: metadata_stat.manifest_size + data_stat.manifest_size,
<a href=#56 id=56 data-nosnippet>56</a> sst_size: metadata_stat.sst_size + data_stat.sst_size,
<a href=#57 id=57 data-nosnippet>57</a> sst_num: metadata_stat.sst_num + data_stat.sst_num,
<a href=#58 id=58 data-nosnippet>58</a> index_size: metadata_stat.index_size + data_stat.index_size,
<a href=#59 id=59 data-nosnippet>59</a> manifest: RegionManifestInfo::Metric {
<a href=#60 id=60 data-nosnippet>60</a> data_flushed_entry_id: data_stat.manifest.data_flushed_entry_id(),
<a href=#61 id=61 data-nosnippet>61</a> data_manifest_version: data_stat.manifest.data_manifest_version(),
<a href=#62 id=62 data-nosnippet>62</a> metadata_flushed_entry_id: metadata_stat.manifest.data_flushed_entry_id(),
<a href=#63 id=63 data-nosnippet>63</a> metadata_manifest_version: metadata_stat.manifest.data_manifest_version(),
<a href=#64 id=64 data-nosnippet>64</a> },
<a href=#65 id=65 data-nosnippet>65</a> written_bytes: metadata_stat.written_bytes + data_stat.written_bytes,
<a href=#66 id=66 data-nosnippet>66</a> data_topic_latest_entry_id: data_stat.data_topic_latest_entry_id,
<a href=#67 id=67 data-nosnippet>67</a> metadata_topic_latest_entry_id: metadata_stat.metadata_topic_latest_entry_id,
<a href=#68 id=68 data-nosnippet>68</a> }),
<a href=#69 id=69 data-nosnippet>69</a> <span class="kw">_ </span>=&gt; {
<a href=#70 id=70 data-nosnippet>70</a> <span class="macro">warn!</span>(
<a href=#71 id=71 data-nosnippet>71</a> <span class="string">"Failed to get region statistic for region {}, metadata_stat: {:?}, data_stat: {:?}"</span>,
<a href=#72 id=72 data-nosnippet>72</a> region_id, metadata_stat, data_stat
<a href=#73 id=73 data-nosnippet>73</a> );
<a href=#74 id=74 data-nosnippet>74</a> <span class="prelude-val">None
<a href=#75 id=75 data-nosnippet>75</a> </span>}
<a href=#76 id=76 data-nosnippet>76</a> }
<a href=#77 id=77 data-nosnippet>77</a>}
<a href=#78 id=78 data-nosnippet>78</a>
<a href=#79 id=79 data-nosnippet>79</a><span class="doccomment">/// Appends the given [RegionId]'s manifest info to the given list.
<a href=#80 id=80 data-nosnippet>80</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>append_manifest_info(
<a href=#81 id=81 data-nosnippet>81</a> mito: <span class="kw-2">&amp;</span>MitoEngine,
<a href=#82 id=82 data-nosnippet>82</a> region_id: RegionId,
<a href=#83 id=83 data-nosnippet>83</a> manifest_infos: <span class="kw-2">&amp;mut </span>Vec&lt;(RegionId, RegionManifestInfo)&gt;,
<a href=#84 id=84 data-nosnippet>84</a>) {
<a href=#85 id=85 data-nosnippet>85</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(statistic) = get_region_statistic(mito, region_id) {
<a href=#86 id=86 data-nosnippet>86</a> manifest_infos.push((region_id, statistic.manifest));
<a href=#87 id=87 data-nosnippet>87</a> }
<a href=#88 id=88 data-nosnippet>88</a>}
<a href=#89 id=89 data-nosnippet>89</a>
<a href=#90 id=90 data-nosnippet>90</a><span class="doccomment">/// Encodes the given list of ([RegionId], [RegionManifestInfo]) to extensions(key: MANIFEST_INFO_EXTENSION_KEY).
<a href=#91 id=91 data-nosnippet>91</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>encode_manifest_info_to_extensions(
<a href=#92 id=92 data-nosnippet>92</a> manifest_infos: <span class="kw-2">&amp;</span>[(RegionId, RegionManifestInfo)],
<a href=#93 id=93 data-nosnippet>93</a> extensions: <span class="kw-2">&amp;mut </span>HashMap&lt;String, Vec&lt;u8&gt;&gt;,
<a href=#94 id=94 data-nosnippet>94</a>) -&gt; <span class="prelude-ty">Result</span>&lt;()&gt; {
<a href=#95 id=95 data-nosnippet>95</a> extensions.insert(
<a href=#96 id=96 data-nosnippet>96</a> MANIFEST_INFO_EXTENSION_KEY.to_string(),
<a href=#97 id=97 data-nosnippet>97</a> RegionManifestInfo::encode_list(manifest_infos)
<a href=#98 id=98 data-nosnippet>98</a> .context(SerializeRegionManifestInfoSnafu)<span class="question-mark">?</span>,
<a href=#99 id=99 data-nosnippet>99</a> );
<a href=#100 id=100 data-nosnippet>100</a> <span class="kw">for </span>(region_id, manifest_info) <span class="kw">in </span>manifest_infos {
<a href=#101 id=101 data-nosnippet>101</a> <span class="macro">info!</span>(
<a href=#102 id=102 data-nosnippet>102</a> <span class="string">"Added manifest info: {:?} to extensions, region_id: {:?}"</span>,
<a href=#103 id=103 data-nosnippet>103</a> manifest_info, region_id
<a href=#104 id=104 data-nosnippet>104</a> );
<a href=#105 id=105 data-nosnippet>105</a> }
<a href=#106 id=106 data-nosnippet>106</a> <span class="prelude-val">Ok</span>(())
<a href=#107 id=107 data-nosnippet>107</a>}
<a href=#108 id=108 data-nosnippet>108</a>
<a href=#109 id=109 data-nosnippet>109</a><span class="attr">#[cfg(test)]
<a href=#110 id=110 data-nosnippet>110</a></span><span class="kw">mod </span>tests {
<a href=#111 id=111 data-nosnippet>111</a>
<a href=#112 id=112 data-nosnippet>112</a> <span class="kw">use </span>super::<span class="kw-2">*</span>;
<a href=#113 id=113 data-nosnippet>113</a>
<a href=#114 id=114 data-nosnippet>114</a> <span class="attr">#[test]
<a href=#115 id=115 data-nosnippet>115</a> </span><span class="kw">fn </span>test_to_metadata_region_id() {
<a href=#116 id=116 data-nosnippet>116</a> <span class="kw">let </span>region_id = RegionId::new(<span class="number">1</span>, <span class="number">2</span>);
<a href=#117 id=117 data-nosnippet>117</a> <span class="kw">let </span>expected_region_id = RegionId::with_group_and_seq(<span class="number">1</span>, METRIC_METADATA_REGION_GROUP, <span class="number">2</span>);
<a href=#118 id=118 data-nosnippet>118</a> <span class="macro">assert_eq!</span>(to_metadata_region_id(region_id), expected_region_id);
<a href=#119 id=119 data-nosnippet>119</a>
<a href=#120 id=120 data-nosnippet>120</a> <span class="kw">let </span>region_id = RegionId::with_group_and_seq(<span class="number">1</span>, <span class="number">243</span>, <span class="number">2</span>);
<a href=#121 id=121 data-nosnippet>121</a> <span class="kw">let </span>expected_region_id = RegionId::with_group_and_seq(<span class="number">1</span>, METRIC_METADATA_REGION_GROUP, <span class="number">2</span>);
<a href=#122 id=122 data-nosnippet>122</a> <span class="macro">assert_eq!</span>(to_metadata_region_id(region_id), expected_region_id);
<a href=#123 id=123 data-nosnippet>123</a> }
<a href=#124 id=124 data-nosnippet>124</a>
<a href=#125 id=125 data-nosnippet>125</a> <span class="attr">#[test]
<a href=#126 id=126 data-nosnippet>126</a> </span><span class="kw">fn </span>test_to_data_region_id() {
<a href=#127 id=127 data-nosnippet>127</a> <span class="kw">let </span>region_id = RegionId::new(<span class="number">1</span>, <span class="number">2</span>);
<a href=#128 id=128 data-nosnippet>128</a> <span class="kw">let </span>expected_region_id = RegionId::with_group_and_seq(<span class="number">1</span>, METRIC_DATA_REGION_GROUP, <span class="number">2</span>);
<a href=#129 id=129 data-nosnippet>129</a> <span class="macro">assert_eq!</span>(to_data_region_id(region_id), expected_region_id);
<a href=#130 id=130 data-nosnippet>130</a>
<a href=#131 id=131 data-nosnippet>131</a> <span class="kw">let </span>region_id = RegionId::with_group_and_seq(<span class="number">1</span>, <span class="number">243</span>, <span class="number">2</span>);
<a href=#132 id=132 data-nosnippet>132</a> <span class="kw">let </span>expected_region_id = RegionId::with_group_and_seq(<span class="number">1</span>, METRIC_DATA_REGION_GROUP, <span class="number">2</span>);
<a href=#133 id=133 data-nosnippet>133</a> <span class="macro">assert_eq!</span>(to_data_region_id(region_id), expected_region_id);
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a>}
</code></pre></div></section></main></body></html>