Files
greptimedb/metric_engine/index.html
2026-01-07 12:00:35 +00:00

32 lines
7.1 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Metric Engine is a region engine to store timeseries data in metric monitoring scenario. It is something like a multiplexer over the Mito 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."><title>metric_engine - Rust</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-e56847b5.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.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.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 mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Crate metric_engine</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../metric_engine/index.html">metric_<wbr>engine</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>metric_<wbr>engine</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/metric_engine/lib.rs.html#15-65">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Metric Engine is a region engine to store timeseries data in metric monitoring
scenario. It is something like a multiplexer over the <a href="../mito2/engine/struct.MitoEngine.html" title="struct mito2::engine::MitoEngine">Mito</a>
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.</p>
<p>For more details about implementation, please refer to <a href="engine/struct.MetricEngine.html" title="struct metric_engine::engine::MetricEngine">MetricEngine</a>.</p>
<p>This new engine doesnt 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:</p>
<div class="example-wrap"><pre class="language-plaintext"><code>┌───────────────┐ ┌───────────────┐ ┌───────────────┐
│ Metric Engine │ │ Metric Engine │ │ Metric Engine │
│ Region 1 │ │ Region 2 │ │ Region 3 │
└───────────────┘ └───────────────┘ └───────────────┘
▲ ▲ ▲
│ │ │
└───────────────┼───────────────────┘
┌─────────┴────────┐
│ Metric Region │
│ Engine │
│ ┌─────────────┤
│ │ Mito Region │
│ │ Engine │
└────▲─────────────┘
┌─────┴───────────────┐
│ │
│ Mito Engine Regions │
│ │
└─────────────────────┘</code></pre></div></div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="config/index.html" title="mod metric_engine::config">config</a></dt><dt><a class="mod" href="data_region/index.html" title="mod metric_engine::data_region">data_<wbr>region</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="engine/index.html" title="mod metric_engine::engine">engine</a></dt><dt><a class="mod" href="error/index.html" title="mod metric_engine::error">error</a></dt><dt><a class="mod" href="metadata_region/index.html" title="mod metric_engine::metadata_region">metadata_<wbr>region</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="metrics/index.html" title="mod metric_engine::metrics">metrics</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Internal metrics for observability.</dd><dt><a class="mod" href="repeated_task/index.html" title="mod metric_engine::repeated_task">repeated_<wbr>task</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="row_modifier/index.html" title="mod metric_engine::row_modifier">row_<wbr>modifier</a></dt><dt><a class="mod" href="utils/index.html" title="mod metric_engine::utils">utils</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>