analytics/Plausible.Ingestion.Counters.Buffer.html
2024-01-09 14:58:54 +00:00

504 lines
16 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.30.3">
<meta name="project" content="Plausible v0.0.1">
<title>Plausible.Ingestion.Counters.Buffer — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-P5GXSCHE.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-NBND3S2D.js"></script>
<script src="dist/sidebar_items-5B076C9F.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-CGDDOCMI.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<a href="readme.html">
<img src="assets/logo.png" alt="Plausible" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
<li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">Plausible.Ingestion.Counters.Buffer</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="moduledoc">
<p>A buffer aggregating counters for internal metrics, within 10 seconds time buckets.</p><p>See <a href="Plausible.Ingestion.Counters.html"><code class="inline">Plausible.Ingestion.Counters</code></a> for integration.</p><p>Flushing is by default possible only once the 10s bucket is complete
(its window has moved). This is to avoid race conditions
when clearing up the buffer on dequeue - because there is no atomic &quot;get and delete&quot;,
and items are buffered concurrently, there is a gap between get and delete
in which items written may disappear otherwise.</p><p><code class="inline">aggregate_bucket_fn</code> and <code class="inline">flush_boundary_fn</code> control that semantics and
are configurable only for test purposes.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
Summary
</a>
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:bucket_fn_opt/0" translate="no">bucket_fn_opt()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:t/0" translate="no">t()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:unix_timestamp/0" translate="no">unix_timestamp()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#aggregate/4" translate="no">aggregate(buffer, metric, domain, timestamp)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#bucket_10s/1" translate="no">bucket_10s(datetime)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#flush/2" translate="no">flush(buffer, now \\ DateTime.utc_now())</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#new/2" translate="no">new(buffer_name, opts \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#previous_10s/1" translate="no">previous_10s(datetime)</a>
</div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="ri-link-m" aria-hidden="true"></i>
Types
</a>
</h1>
<div class="types-list">
<section class="detail" id="t:bucket_fn_opt/0">
<div class="detail-header">
<a href="#t:bucket_fn_opt/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">bucket_fn_opt()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L23" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> bucket_fn_opt() ::
{:aggregate_bucket_fn, (<a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>() -&gt; <a href="#t:unix_timestamp/0">unix_timestamp</a>())}
| {:flush_boundary_fn, (<a href="https://hexdocs.pm/elixir/DateTime.html#t:t/0">DateTime.t</a>() -&gt; <a href="#t:unix_timestamp/0">unix_timestamp</a>())}</pre>
</div>
</section>
</section>
<section class="detail" id="t:t/0">
<div class="detail-header">
<a href="#t:t/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">t()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L21" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> t() :: %Plausible.Ingestion.Counters.Buffer{
aggregate_bucket_fn: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
buffer_name: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
flush_boundary_fn: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
}</pre>
</div>
</section>
</section>
<section class="detail" id="t:unix_timestamp/0">
<div class="detail-header">
<a href="#t:unix_timestamp/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">unix_timestamp()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L22" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@type</span> unix_timestamp() :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">pos_integer</a>()</pre>
</div>
</section>
</section>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
Functions
</a>
</h1>
<div class="functions-list">
<section class="detail" id="aggregate/4">
<div class="detail-header">
<a href="#aggregate/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">aggregate(buffer, metric, domain, timestamp)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L49" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> aggregate(<a href="#t:t/0">t</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">binary</a>(), timestamp :: <a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>()) :: <a href="#t:t/0">t</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="bucket_10s/1">
<div class="detail-header">
<a href="#bucket_10s/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">bucket_10s(datetime)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L92" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> bucket_10s(<a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>()) :: <a href="#t:unix_timestamp/0">unix_timestamp</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="flush/2">
<span id="flush/1"></span>
<div class="detail-header">
<a href="#flush/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">flush(buffer, now \\ DateTime.utc_now())</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L68" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> flush(<a href="#t:t/0">t</a>(), now :: <a href="https://hexdocs.pm/elixir/DateTime.html#t:t/0">DateTime.t</a>()) :: [<a href="Plausible.Ingestion.Counters.Record.html#t:t/0">Plausible.Ingestion.Counters.Record.t</a>()]</pre>
</div>
</section>
</section>
<section class="detail" id="new/2">
<span id="new/1"></span>
<div class="detail-header">
<a href="#new/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">new(buffer_name, opts \\ [])</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L35" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> new(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>(), [<a href="#t:bucket_fn_opt/0">bucket_fn_opt</a>()]) :: <a href="#t:t/0">t</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="previous_10s/1">
<div class="detail-header">
<a href="#previous_10s/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">previous_10s(datetime)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/counters/buffer.ex#L101" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> previous_10s(<a href="https://hexdocs.pm/elixir/DateTime.html#t:t/0">DateTime.t</a>()) :: <a href="#t:unix_timestamp/0">unix_timestamp</a>()</pre>
</div>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Plausible.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.30.3) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad: true})</script>
</body>
</html>