greptimedb/common_cache/metrics/index.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 `common_cache`."><title>common_cache::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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_cache" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.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-417ebf0a.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="../../common_cache/index.html">common_<wbr>cache</a><span class="version">1.4.0-alpha.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></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate common_<wbr>cache</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">common_cache</a></div><h1>Module <span>metrics</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/common_cache/metrics.rs.html#15-194">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.CacheMetrics.html" title="struct common_cache::metrics::CacheMetrics">Cache<wbr>Metrics</a></dt><dd>Caller-bound metrics for native cache loading. No collectors are registered here.
Requests count only <code>try_get_with</code> calls, including its cache hits and callers sharing
another request’s load. Plain <code>get</code> calls are not counted. Loads count
only loader futures actually polled by the backend; their difference is not a waiter count.</dd><dt><a class="struct" href="struct.CacheSizeMetric.html" title="struct common_cache::metrics::CacheSizeMetric">Cache<wbr>Size<wbr>Metric</a></dt><dd>A byte metric with labels bound for one or more cache instances.</dd><dt><a class="struct" href="struct.CacheSizeMetrics.html" title="struct common_cache::metrics::CacheSizeMetrics">Cache<wbr>Size<wbr>Metrics</a></dt><dd>Cache byte metrics combining manually maintained gauges and sampled cache weights.
Sampling does not force backend maintenance or include pending loader values.</dd><dt><a class="struct" href="struct.CacheSizeRegistration.html" title="struct common_cache::metrics::CacheSizeRegistration">Cache<wbr>Size<wbr>Registration</a></dt><dd>Keeps a cache instance registered for size sampling while any owner remains.</dd><dt><a class="struct" href="struct.CacheSizeSource.html" title="struct common_cache::metrics::CacheSizeSource">Cache<wbr>Size<wbr>Source</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="struct" href="struct.OperationGuard.html" title="struct common_cache::metrics::OperationGuard">Operation<wbr>Guard</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Tracks an operation, recording cancellation if dropped before completion.</dd><dt><a class="struct" href="struct.OperationMetrics.html" title="struct common_cache::metrics::OperationMetrics">Operation<wbr>Metrics</a></dt><dd>Metrics for one operation, with labels bound once when constructing a cache.
Completion counters are mutually exclusive. Dropping an unfinished future is cancellation.</dd></dl></section></div></main></body></html>