mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-15 12:30:38 +00:00
2 lines
8.4 KiB
HTML
2 lines
8.4 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="API documentation for the Rust `metrics` mod in crate `query`."><title>query::metrics - 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-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="query" 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="../sidebar-items.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 mod"><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]--><rustdoc-topbar><h2><a href="#">Module metrics</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../query/index.html">query</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module metrics</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate query</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">query</a></div><h1>Module <span>metrics</span> <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/query/metrics.rs.html#15-506">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CREATE_PHYSICAL_ELAPSED.html" title="struct query::metrics::CREATE_PHYSICAL_ELAPSED">CREATE_<wbr>PHYSICAL_<wbr>ELAPSED</a></dt><dt><a class="struct" href="struct.EXEC_PLAN_ELAPSED.html" title="struct query::metrics::EXEC_PLAN_ELAPSED">EXEC_<wbr>PLAN_<wbr>ELAPSED</a></dt><dt><a class="struct" href="struct.MERGE_SCAN_ERRORS_TOTAL.html" title="struct query::metrics::MERGE_SCAN_ERRORS_TOTAL">MERGE_<wbr>SCAN_<wbr>ERRORS_<wbr>TOTAL</a></dt><dt><a class="struct" href="struct.MERGE_SCAN_POLL_ELAPSED.html" title="struct query::metrics::MERGE_SCAN_POLL_ELAPSED">MERGE_<wbr>SCAN_<wbr>POLL_<wbr>ELAPSED</a></dt><dt><a class="struct" href="struct.MERGE_SCAN_REGIONS.html" title="struct query::metrics::MERGE_SCAN_REGIONS">MERGE_<wbr>SCAN_<wbr>REGIONS</a></dt><dt><a class="struct" href="struct.OPTIMIZE_LOGICAL_ELAPSED.html" title="struct query::metrics::OPTIMIZE_LOGICAL_ELAPSED">OPTIMIZE_<wbr>LOGICAL_<wbr>ELAPSED</a></dt><dt><a class="struct" href="struct.OPTIMIZE_PHYSICAL_ELAPSED.html" title="struct query::metrics::OPTIMIZE_PHYSICAL_ELAPSED">OPTIMIZE_<wbr>PHYSICAL_<wbr>ELAPSED</a></dt><dt><a class="struct" href="struct.OnDone.html" title="struct query::metrics::OnDone">OnDone</a></dt><dd>A stream to call the callback once a RecordBatch stream is done.</dd><dt><a class="struct" href="struct.PARSE_PROMQL_ELAPSED.html" title="struct query::metrics::PARSE_PROMQL_ELAPSED">PARSE_<wbr>PROMQL_<wbr>ELAPSED</a></dt><dt><a class="struct" href="struct.PARSE_SQL_ELAPSED.html" title="struct query::metrics::PARSE_SQL_ELAPSED">PARSE_<wbr>SQL_<wbr>ELAPSED</a></dt><dt><a class="struct" href="struct.PUSH_DOWN_FALLBACK_ERRORS_TOTAL.html" title="struct query::metrics::PUSH_DOWN_FALLBACK_ERRORS_TOTAL">PUSH_<wbr>DOWN_<wbr>FALLBACK_<wbr>ERRORS_<wbr>TOTAL</a></dt><dt><a class="struct" href="struct.QUERY_MEMORY_POOL_REJECTED_TOTAL.html" title="struct query::metrics::QUERY_MEMORY_POOL_REJECTED_TOTAL">QUERY_<wbr>MEMORY_<wbr>POOL_<wbr>REJECTED_<wbr>TOTAL</a></dt><dt><a class="struct" href="struct.QUERY_MEMORY_POOL_USAGE_BYTES.html" title="struct query::metrics::QUERY_MEMORY_POOL_USAGE_BYTES">QUERY_<wbr>MEMORY_<wbr>POOL_<wbr>USAGE_<wbr>BYTES</a></dt><dt><a class="struct" href="struct.QUERY_STAGE_ELAPSED.html" title="struct query::metrics::QUERY_STAGE_ELAPSED">QUERY_<wbr>STAGE_<wbr>ELAPSED</a></dt><dd>Timer of different stages in query.</dd><dt><a class="struct" href="struct.RegionWatermarkMetricsStream.html" title="struct query::metrics::RegionWatermarkMetricsStream">Region<wbr>Watermark<wbr>Metrics<wbr>Stream</a></dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.MergeState.html" title="enum query::metrics::MergeState">Merge<wbr>State</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Intermediate merge state for one participating region while collecting
|
|
terminal correctness watermarks across merge-scan sub-stages.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.collect_region_watermarks.html" title="fn query::metrics::collect_region_watermarks">collect_<wbr>region_<wbr>watermarks</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.finalize_region_watermarks.html" title="fn query::metrics::finalize_region_watermarks">finalize_<wbr>region_<wbr>watermarks</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.maybe_attach_region_watermark_metrics.html" title="fn query::metrics::maybe_attach_region_watermark_metrics">maybe_<wbr>attach_<wbr>region_<wbr>watermark_<wbr>metrics</a></dt><dd>Attaches terminal region watermark metrics to <code>stream</code> when collection is requested.</dd><dt><a class="fn" href="fn.merge_merge_scan_region_watermarks.html" title="fn query::metrics::merge_merge_scan_region_watermarks">merge_<wbr>merge_<wbr>scan_<wbr>region_<wbr>watermarks</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.merge_region_watermark_entries.html" title="fn query::metrics::merge_region_watermark_entries">merge_<wbr>region_<wbr>watermark_<wbr>entries</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Merge a batch of per-region watermark entries into the global merged state.</dd><dt><a class="fn" href="fn.should_collect_region_watermark_from_query_ctx.html" title="fn query::metrics::should_collect_region_watermark_from_query_ctx">should_<wbr>collect_<wbr>region_<wbr>watermark_<wbr>from_<wbr>query_<wbr>ctx</a></dt><dd>Returns whether terminal region watermark metrics should be collected for the query context.</dd><dt><a class="fn" href="fn.terminal_recordbatch_metrics_from_plan.html" title="fn query::metrics::terminal_recordbatch_metrics_from_plan">terminal_<wbr>recordbatch_<wbr>metrics_<wbr>from_<wbr>plan</a></dt><dt><a class="fn" href="fn.terminal_recordbatch_metrics_from_plan_if_requested.html" title="fn query::metrics::terminal_recordbatch_metrics_from_plan_if_requested">terminal_<wbr>recordbatch_<wbr>metrics_<wbr>from_<wbr>plan_<wbr>if_<wbr>requested</a></dt><dd>Collects terminal record-batch metrics from <code>plan</code> only when requested.</dd></dl></section></div></main></body></html> |