Skip to content

Commit

Permalink
deploy: 1c49b90
Browse files Browse the repository at this point in the history
  • Loading branch information
@jjbayer
jjbayer committed Jul 22, 2024
1 parent d3aad7d commit d458bca
Show file tree
Hide file tree
Showing 34 changed files with 599 additions and 190 deletions.
4 changes: 2 additions & 2 deletions relay_config/aggregator/struct.AggregatorServiceConfig.html
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<!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="Parameters used for metric aggregation."><title>AggregatorServiceConfig in relay_config::aggregator - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-081576b923113409.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="relay_config" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0 (129f3b996 2024-06-10)" data-channel="1.79.0" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-e32f0c247825364d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-09095024cf37855e.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/getsentry/relay/master/artwork/relay-icon.png"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../relay_config/index.html"><img src="https://raw.githubusercontent.com/getsentry/relay/master/artwork/relay-icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../relay_config/index.html"><img src="https://raw.githubusercontent.com/getsentry/relay/master/artwork/relay-icon.png" alt="logo"></a><h2><a href="../../relay_config/index.html">relay_config</a><span class="version">24.7.0</span></h2></div><h2 class="location"><a href="#">AggregatorServiceConfig</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Fields</a></h3><ul class="block structfield"><li><a href="#structfield.aggregator">aggregator</a></li><li><a href="#structfield.flush_interval_ms">flush_interval_ms</a></li><li><a href="#structfield.max_flush_bytes">max_flush_bytes</a></li><li><a href="#structfield.max_total_bucket_bytes">max_total_bucket_bytes</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-AggregatorServiceConfig">Clone</a></li><li><a href="#impl-Debug-for-AggregatorServiceConfig">Debug</a></li><li><a href="#impl-Default-for-AggregatorServiceConfig">Default</a></li><li><a href="#impl-Deserialize%3C'de%3E-for-AggregatorServiceConfig">Deserialize&lt;&#x27;de&gt;</a></li><li><a href="#impl-Serialize-for-AggregatorServiceConfig">Serialize</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-AggregatorServiceConfig">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-AggregatorServiceConfig">RefUnwindSafe</a></li><li><a href="#impl-Send-for-AggregatorServiceConfig">Send</a></li><li><a href="#impl-Sync-for-AggregatorServiceConfig">Sync</a></li><li><a href="#impl-Unpin-for-AggregatorServiceConfig">Unpin</a></li><li><a href="#impl-UnwindSafe-for-AggregatorServiceConfig">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-DeserializeOwned-for-T">DeserializeOwned</a></li><li><a href="#impl-DynClone-for-T">DynClone</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Instrument-for-T">Instrument</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-Same-for-T">Same</a></li><li><a href="#impl-ToOwned-for-T">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-T">VZip&lt;V&gt;</a></li><li><a href="#impl-WithSubscriber-for-T">WithSubscriber</a></li></ul></section><h2><a href="index.html">In relay_config::aggregator</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../relay_config/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">relay_config</a>::<wbr><a href="index.html">aggregator</a>::<wbr><a class="struct" href="#">AggregatorServiceConfig</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/relay_config/aggregator.rs.html#10-37">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct AggregatorServiceConfig {
pub aggregator: <a class="struct" href="../../relay_metrics/aggregator/struct.AggregatorConfig.html" title="struct relay_metrics::aggregator::AggregatorConfig">AggregatorConfig</a>,
pub aggregator: AggregatorConfig,
pub max_total_bucket_bytes: <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.79.0/std/primitive.usize.html">usize</a>&gt;,
pub max_flush_bytes: <a class="primitive" href="https://doc.rust-lang.org/1.79.0/std/primitive.usize.html">usize</a>,
pub flush_interval_ms: <a class="primitive" href="https://doc.rust-lang.org/1.79.0/std/primitive.u64.html">u64</a>,
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parameters used for metric aggregation.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.aggregator" class="structfield section-header"><a href="#structfield.aggregator" class="anchor field">§</a><code>aggregator: <a class="struct" href="../../relay_metrics/aggregator/struct.AggregatorConfig.html" title="struct relay_metrics::aggregator::AggregatorConfig">AggregatorConfig</a></code></span><div class="docblock"><p>The config used by the internal aggregator.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.aggregator" class="structfield section-header"><a href="#structfield.aggregator" class="anchor field">§</a><code>aggregator: AggregatorConfig</code></span><div class="docblock"><p>The config used by the internal aggregator.</p>
</div><span id="structfield.max_total_bucket_bytes" class="structfield section-header"><a href="#structfield.max_total_bucket_bytes" class="anchor field">§</a><code>max_total_bucket_bytes: <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.79.0/std/primitive.usize.html">usize</a>&gt;</code></span><div class="docblock"><p>Maximum amount of bytes used for metrics aggregation.</p>
<p>When aggregating metrics, Relay keeps track of how many bytes a metric takes in memory.
This is only an approximation and does not take into account things such as pre-allocation
Expand Down
2 changes: 1 addition & 1 deletion relay_config/struct.Config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@
</div></details><details class="toggle method-toggle" open><summary><section id="method.cogs_granularity" class="method"><a class="src rightside" href="../src/relay_config/config.rs.html#2355-2357">source</a><h4 class="code-header">pub fn <a href="#method.cogs_granularity" class="fn">cogs_granularity</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.79.0/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a></h4></section></summary><div class="docblock"><p>Granularity for COGS measurements.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.cogs_max_queue_size" class="method"><a class="src rightside" href="../src/relay_config/config.rs.html#2360-2362">source</a><h4 class="code-header">pub fn <a href="#method.cogs_max_queue_size" class="fn">cogs_max_queue_size</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.79.0/std/primitive.u64.html">u64</a></h4></section></summary><div class="docblock"><p>Maximum amount of COGS measurements buffered in memory.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.cogs_relay_resource_id" class="method"><a class="src rightside" href="../src/relay_config/config.rs.html#2365-2367">source</a><h4 class="code-header">pub fn <a href="#method.cogs_relay_resource_id" class="fn">cogs_relay_resource_id</a>(&amp;self) -&gt; &amp;<a class="primitive" href="https://doc.rust-lang.org/1.79.0/std/primitive.str.html">str</a></h4></section></summary><div class="docblock"><p>Resource ID to use for Relay COGS measurements.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.permissive_aggregator_config" class="method"><a class="src rightside" href="../src/relay_config/config.rs.html#2373-2421">source</a><h4 class="code-header">pub fn <a href="#method.permissive_aggregator_config" class="fn">permissive_aggregator_config</a>(&amp;self) -&gt; <a class="struct" href="../relay_metrics/aggregator/struct.AggregatorConfig.html" title="struct relay_metrics::aggregator::AggregatorConfig">AggregatorConfig</a></h4></section></summary><div class="docblock"><p>Creates an <a href="../relay_metrics/aggregator/struct.AggregatorConfig.html" title="struct relay_metrics::aggregator::AggregatorConfig"><code>AggregatorConfig</code></a> that is compatible with every other aggregator.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.permissive_aggregator_config" class="method"><a class="src rightside" href="../src/relay_config/config.rs.html#2373-2421">source</a><h4 class="code-header">pub fn <a href="#method.permissive_aggregator_config" class="fn">permissive_aggregator_config</a>(&amp;self) -&gt; AggregatorConfig</h4></section></summary><div class="docblock"><p>Creates an [<code>AggregatorConfig</code>] that is compatible with every other aggregator.</p>
<p>A lossless aggregator can be put in front of any of the configured aggregators without losing data that the configured aggregator would keep.
This is useful for pre-aggregating metrics together in a single aggregator instance.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.default_aggregator_config" class="method"><a class="src rightside" href="../src/relay_config/config.rs.html#2424-2426">source</a><h4 class="code-header">pub fn <a href="#method.default_aggregator_config" class="fn">default_aggregator_config</a>(&amp;self) -&gt; &amp;<a class="struct" href="aggregator/struct.AggregatorServiceConfig.html" title="struct relay_config::aggregator::AggregatorServiceConfig">AggregatorServiceConfig</a></h4></section></summary><div class="docblock"><p>Returns configuration for the default metrics aggregator.</p>
Expand Down
Loading

0 comments on commit d458bca

Please sign in to comment.