Files
2025-12-22 06:16:12 +00:00

2 lines
7.0 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 `common_greptimedb_telemetry` crate."><title>common_greptimedb_telemetry - 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_greptimedb_telemetry" 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_greptimedb_telemetry</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_greptimedb_telemetry/index.html">common_<wbr>greptimedb_<wbr>telemetry</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="#structs">Crate 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="#constants" title="Constants">Constants</a></li><li><a href="#statics" title="Statics">Statics</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</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>greptimedb_<wbr>telemetry</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_greptimedb_telemetry/lib.rs.html#15-525">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.GreptimeDBTelemetry.html" title="struct common_greptimedb_telemetry::GreptimeDBTelemetry">GreptimeDB<wbr>Telemetry</a></dt><dd>Report version info to GreptimeDB.</dd><dt><a class="struct" href="struct.StatisticData.html" title="struct common_greptimedb_telemetry::StatisticData">Statistic<wbr>Data</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Telemetry data to report</dd></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.GreptimeDBTelemetryTask.html" title="enum common_greptimedb_telemetry::GreptimeDBTelemetryTask">GreptimeDB<wbr>Telemetry<wbr>Task</a></dt><dt><a class="enum" href="enum.Mode.html" title="enum common_greptimedb_telemetry::Mode">Mode</a></dt></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.GREPTIMEDB_TELEMETRY_CLIENT_CONNECT_TIMEOUT.html" title="constant common_greptimedb_telemetry::GREPTIMEDB_TELEMETRY_CLIENT_CONNECT_TIMEOUT">GREPTIMEDB_<wbr>TELEMETRY_<wbr>CLIENT_<wbr>CONNECT_<wbr>TIMEOUT</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The default connect timeout to greptime cloud.</dd><dt><a class="constant" href="constant.GREPTIMEDB_TELEMETRY_CLIENT_REQUEST_TIMEOUT.html" title="constant common_greptimedb_telemetry::GREPTIMEDB_TELEMETRY_CLIENT_REQUEST_TIMEOUT">GREPTIMEDB_<wbr>TELEMETRY_<wbr>CLIENT_<wbr>REQUEST_<wbr>TIMEOUT</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The default request timeout to greptime cloud.</dd><dt><a class="constant" href="constant.TELEMETRY_URL.html" title="constant common_greptimedb_telemetry::TELEMETRY_URL">TELEMETRY_<wbr>URL</a></dt><dd>The URL to report telemetry data.</dd><dt><a class="constant" href="constant.UUID_FILE_NAME.html" title="constant common_greptimedb_telemetry::UUID_FILE_NAME">UUID_<wbr>FILE_<wbr>NAME</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The local installation uuid cache file</dd></dl><h2 id="statics" class="section-header">Statics<a href="#statics" class="anchor">§</a></h2><dl class="item-table"><dt><a class="static" href="static.START_TIME.html" title="static common_greptimedb_telemetry::START_TIME">START_<wbr>TIME</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>System start time for uptime calculation</dd><dt><a class="static" href="static.TELEMETRY_INTERVAL.html" title="static common_greptimedb_telemetry::TELEMETRY_INTERVAL">TELEMETRY_<wbr>INTERVAL</a></dt><dd>The default interval of reporting telemetry data to greptime cloud</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.Collector.html" title="trait common_greptimedb_telemetry::Collector">Collector</a></dt></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.default_get_uuid.html" title="fn common_greptimedb_telemetry::default_get_uuid">default_<wbr>get_<wbr>uuid</a></dt><dt><a class="fn" href="fn.format_uptime.html" title="fn common_greptimedb_telemetry::format_uptime">format_<wbr>uptime</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Format uptime duration into a general time range string
Returns privacy-friendly descriptions like “hours”, “days”, etc.</dd><dt><a class="fn" href="fn.print_anonymous_usage_data_disclaimer.html" title="fn common_greptimedb_telemetry::print_anonymous_usage_data_disclaimer">print_<wbr>anonymous_<wbr>usage_<wbr>data_<wbr>disclaimer</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>