rust/greptimedb
1
0
Fork 0
mirror of https://github.com/GreptimeTeam/greptimedb.git synced 2025-12-25 07:30:02 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
greptimedb/common_stat/index.html
github-merge-queue[bot] 9613e13ecd Deploying to gh-pages from @ GreptimeTeam/greptimedb@be530ac1de 🚀
2025-12-25 05:03:15 +00:00

3 lines
9.2 KiB
HTML
Raw Permalink Blame History

<!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 `common_stat` crate."><title>common_stat - 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="common_stat" 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 common_stat</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_stat/index.html">common_<wbr>stat</a><span class="version">1.0.0-beta.3</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><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</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>common_<wbr>stat</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_stat/lib.rs.html#15-19">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="cgroups/index.html" title="mod common_stat::cgroups">cgroups</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="resource/index.html" title="mod common_stat::resource">resource</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CgroupsMetricsCollector.html" title="struct common_stat::CgroupsMetricsCollector">Cgroups<wbr>Metrics<wbr>Collector</a></dt><dd>A collector that collects cgroups metrics.</dd><dt><a class="struct" href="struct.ResourceStatImpl.html" title="struct common_stat::ResourceStatImpl">Resource<wbr>Stat<wbr>Impl</a></dt><dd>A implementation of <code>ResourceStat</code> trait.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.ResourceStat.html" title="trait common_stat::ResourceStat">Resource<wbr>Stat</a></dt><dd>A trait for getting resource statistics.</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.get_cpu_limit_from_cgroups.html" title="fn common_stat::get_cpu_limit_from_cgroups">get_<wbr>cpu_<wbr>limit_<wbr>from_<wbr>cgroups</a></dt><dd>Get the limit of cpu in millicores from cgroups filesystem.</dd><dt><a class="fn" href="fn.get_cpu_usage_from_cgroups.html" title="fn common_stat::get_cpu_usage_from_cgroups">get_<wbr>cpu_<wbr>usage_<wbr>from_<wbr>cgroups</a></dt><dd>Get the usage of cpu in millicores from cgroups filesystem.</dd><dt><a class="fn" href="fn.get_memory_limit_from_cgroups.html" title="fn common_stat::get_memory_limit_from_cgroups">get_<wbr>memory_<wbr>limit_<wbr>from_<wbr>cgroups</a></dt><dd>Get the limit of memory in bytes from cgroups filesystem.</dd><dt><a class="fn" href="fn.get_memory_usage_from_cgroups.html" title="fn common_stat::get_memory_usage_from_cgroups">get_<wbr>memory_<wbr>usage_<wbr>from_<wbr>cgroups</a></dt><dd>Get the usage of memory in bytes from cgroups filesystem.</dd><dt><a class="fn" href="fn.get_total_cpu_cores.html" title="fn common_stat::get_total_cpu_cores">get_<wbr>total_<wbr>cpu_<wbr>cores</a></dt><dd>Get the total CPU cores. The result will be rounded up to the next integer (ceiling).
For example, if the total CPU is 1.1 cores (1100 millicores) or 1.5 cores (1500 millicores), the result will be 2.</dd><dt><a class="fn" href="fn.get_total_cpu_millicores.html" title="fn common_stat::get_total_cpu_millicores">get_<wbr>total_<wbr>cpu_<wbr>millicores</a></dt><dd>Get the total CPU in millicores. If the CPU limit is unset, it will return the total CPU cores from host system.</dd><dt><a class="fn" href="fn.get_total_memory_bytes.html" title="fn common_stat::get_total_memory_bytes">get_<wbr>total_<wbr>memory_<wbr>bytes</a></dt><dd>Get the total memory in bytes. If the memory limit is unset, it will return the total memory from host system.
If the system is not supported to get the total host memory, it will return 0.</dd><dt><a class="fn" href="fn.get_total_memory_readable.html" title="fn common_stat::get_total_memory_readable">get_<wbr>total_<wbr>memory_<wbr>readable</a></dt><dd>Get the total memory in readable size.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.ResourceStatRef.html" title="type common_stat::ResourceStatRef">Resource<wbr>Stat<wbr>Ref</a></dt><dd>A reference to a <code>ResourceStat</code> implementation.</dd></dl><script type="text/json" id="notable-traits-data">{"<Arc<S> as Service<Request>>::Future":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div>","<Arc<W> as MakeWriter<'a>>::Writer":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a>&lt;<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>&gt;</div>"}</script></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink