2023-07-12 11:28:07 +03:00
|
|
|
<!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">
|
2024-01-16 10:41:49 +03:00
|
|
|
<meta name="generator" content="ExDoc v0.31.1">
|
2023-07-12 11:28:07 +03:00
|
|
|
<meta name="project" content="Plausible v0.0.1">
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
<title>Plausible.Ingestion.Event — Plausible v0.0.1</title>
|
2024-01-16 10:41:49 +03:00
|
|
|
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
|
2024-01-11 10:50:44 +03:00
|
|
|
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
|
2024-05-09 09:59:57 +03:00
|
|
|
<script src="dist/sidebar_items-6D5BFF0C.js"></script>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<script src="docs_config.js"></script>
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<script async src="dist/html-L4O5OK2K.js"></script>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</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">
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
|
2023-07-12 11:28:07 +03:00
|
|
|
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
|
|
|
|
|
</button>
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<div class="background-layer"></div>
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<nav id="sidebar" class="sidebar">
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<div class="sidebar-header">
|
2024-01-11 10:50:44 +03:00
|
|
|
<div class="sidebar-projectInfo">
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<a href="readme.html" class="sidebar-projectImage">
|
|
|
|
|
<img src="assets/logo.png" alt="Plausible" />
|
|
|
|
|
</a>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div>
|
|
|
|
|
<a href="readme.html" class="sidebar-projectName" translate="no">
|
2023-07-12 11:28:07 +03:00
|
|
|
Plausible
|
2024-01-11 10:50:44 +03:00
|
|
|
</a>
|
|
|
|
|
<div class="sidebar-projectVersion" translate="no">
|
|
|
|
|
v0.0.1
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
|
|
|
|
|
<li>
|
|
|
|
|
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
|
|
|
|
|
Pages
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
|
|
|
|
|
Modules
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li>
|
|
|
|
|
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
|
|
|
|
|
<span translate="no">Mix</span> Tasks
|
|
|
|
|
</button>
|
|
|
|
|
</li>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
</ul>
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
|
|
|
|
|
<ul id="extras-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
|
|
|
|
|
<ul id="modules-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
|
|
|
|
|
<ul id="tasks-full-list" class="full-list"></ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</nav>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<main class="content">
|
2023-07-12 11:28:07 +03:00
|
|
|
<output role="status" id="toast"></output>
|
|
|
|
|
<div class="content-outer">
|
|
|
|
|
<div id="content" class="content-inner">
|
2024-01-11 10:50:44 +03:00
|
|
|
<div class="top-search">
|
|
|
|
|
<div class="search-settings">
|
|
|
|
|
<form class="search-bar" action="search.html">
|
|
|
|
|
<label class="search-label">
|
|
|
|
|
<span class="sr-only">Search documentation of Plausible</span>
|
|
|
|
|
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
|
|
|
|
|
</label>
|
|
|
|
|
<button type="submit" class="search-button" aria-label="Submit Search">
|
|
|
|
|
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
|
|
|
|
|
</button>
|
|
|
|
|
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
|
|
|
|
|
<i class="ri-close-line ri-lg" title="Cancel search"></i>
|
|
|
|
|
</button>
|
|
|
|
|
</form>
|
2024-01-16 10:41:49 +03:00
|
|
|
<div class="autocomplete">
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
<button class="icon-settings display-settings">
|
|
|
|
|
<i class="ri-settings-3-line"></i>
|
|
|
|
|
<span class="sr-only">Settings</span>
|
|
|
|
|
</button>
|
|
|
|
|
</div>
|
2024-01-16 10:41:49 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
</div>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.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.Event</span>
|
|
|
|
|
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
|
|
|
|
|
|
|
|
|
|
</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="moduledoc">
|
|
|
|
|
<p>This module exposes the <a href="#build_and_buffer/1"><code class="inline">build_and_buffer/1</code></a> function capable of
|
|
|
|
|
turning %Plausible.Ingestion.Request{} into a series of events that in turn
|
|
|
|
|
are uniformly either buffered in batches (to Clickhouse) or dropped
|
|
|
|
|
(e.g. due to spam blocklist) from the processing pipeline.</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>
|
|
|
|
|
</a>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Summary</span>
|
2023-07-12 11:28:07 +03:00
|
|
|
</h1>
|
|
|
|
|
<div class="summary-types summary">
|
|
|
|
|
<h2>
|
|
|
|
|
<a href="#types">Types</a>
|
|
|
|
|
</h2>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#t:drop_reason/0" translate="no">drop_reason()</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#t:t/0" translate="no">t()</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="#build_and_buffer/1" translate="no">build_and_buffer(request)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#emit_telemetry_buffered/1" translate="no">emit_telemetry_buffered(event)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#emit_telemetry_dropped/2" translate="no">emit_telemetry_dropped(event, reason)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#telemetry_event_buffered/0" translate="no">telemetry_event_buffered()</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#telemetry_event_dropped/0" translate="no">telemetry_event_dropped()</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2024-03-26 11:43:26 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#telemetry_pipeline_step_duration/0" translate="no">telemetry_pipeline_step_duration()</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
</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>
|
2023-07-25 10:58:48 +03:00
|
|
|
</a>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Types</span>
|
2023-07-12 11:28:07 +03:00
|
|
|
</h1>
|
|
|
|
|
<div class="types-list">
|
|
|
|
|
<section class="detail" id="t:drop_reason/0">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#t:drop_reason/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">drop_reason()</h1>
|
|
|
|
|
|
2024-03-01 11:54:34 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.ex#L24" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<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> drop_reason() ::
|
2024-02-12 16:55:58 +03:00
|
|
|
:bot
|
|
|
|
|
| :spam_referrer
|
|
|
|
|
| <a href="Plausible.Site.GateKeeper.html#t:policy/0">Plausible.Site.GateKeeper.policy</a>()
|
|
|
|
|
| :invalid
|
|
|
|
|
| :dc_ip
|
2024-02-27 14:08:56 +03:00
|
|
|
| :site_ip_blocklist
|
2024-03-25 12:37:02 +03:00
|
|
|
| :site_country_blocklist
|
2024-04-16 21:30:58 +03:00
|
|
|
| :site_page_blocklist
|
|
|
|
|
| :site_hostname_allowlist</pre>
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
|
2024-04-16 21:30:58 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.ex#L35" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<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.Event{
|
|
|
|
|
changeset: %Ecto.Changeset{
|
|
|
|
|
action: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
changes: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
constraints: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
data: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
empty_values: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
errors: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
filters: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
params: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
prepare: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
repo: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
repo_opts: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
required: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
types: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
valid?: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
validations: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
|
|
|
|
|
},
|
|
|
|
|
clickhouse_event:
|
|
|
|
|
%Plausible.ClickhouseEventV2{
|
|
|
|
|
__meta__: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-03-06 12:00:07 +03:00
|
|
|
browser: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
browser_version: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
city_geoname_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
country_code: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
hostname: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
"meta.key": <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
"meta.value": <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
name: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-03-06 12:00:07 +03:00
|
|
|
operating_system: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
operating_system_version: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
pathname: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-03-06 12:00:07 +03:00
|
|
|
referrer: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
referrer_source: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
revenue_reporting_amount: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
revenue_reporting_currency: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
revenue_source_amount: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
revenue_source_currency: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-03-06 12:00:07 +03:00
|
|
|
screen_size: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
session_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
site_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-03-06 12:00:07 +03:00
|
|
|
subdivision1_code: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
subdivision2_code: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
timestamp: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-03-06 12:00:07 +03:00
|
|
|
user_id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
utm_campaign: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
utm_content: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
utm_medium: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
utm_source: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
utm_term: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
|
2023-07-12 11:28:07 +03:00
|
|
|
}
|
|
|
|
|
| nil,
|
|
|
|
|
clickhouse_event_attrs: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>(),
|
2024-03-01 11:54:34 +03:00
|
|
|
clickhouse_session_attrs: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
domain: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>() | nil,
|
|
|
|
|
drop_reason: <a href="#t:drop_reason/0">drop_reason</a>(),
|
|
|
|
|
dropped?: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>(),
|
|
|
|
|
request: <a href="Plausible.Ingestion.Request.html#t:t/0">Plausible.Ingestion.Request.t</a>(),
|
|
|
|
|
salts: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>(),
|
|
|
|
|
site:
|
|
|
|
|
%Plausible.Site{
|
|
|
|
|
__meta__: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
allowed_event_props: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-02-14 11:33:22 +03:00
|
|
|
complete_import_ids: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
conversions_enabled: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
domain: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
domain_changed_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
domain_changed_from: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-02-14 11:33:22 +03:00
|
|
|
earliest_import_start_date: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-11-13 11:09:08 +03:00
|
|
|
entry_type: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
from_cache?: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
funnels_enabled: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
goals: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
google_auth: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
id: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-02-14 11:33:22 +03:00
|
|
|
import_data_loaded: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
imported_data: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
ingest_rate_limit_scale_seconds: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
ingest_rate_limit_threshold: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
inserted_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
invitations: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2024-04-02 13:54:06 +03:00
|
|
|
latest_import_end_date: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
locked: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
members: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
memberships: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
monthly_report: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
native_stats_start_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-10-11 15:41:12 +03:00
|
|
|
owner: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
ownership: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-11-13 11:09:08 +03:00
|
|
|
pinned_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
2023-07-12 11:28:07 +03:00
|
|
|
props_enabled: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
public: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
revenue_goals: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
spike_notification: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
stats_start_date: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
timezone: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
updated_at: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
|
|
|
|
|
weekly_report: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()
|
|
|
|
|
}
|
|
|
|
|
| nil
|
|
|
|
|
}</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>
|
2023-07-25 10:58:48 +03:00
|
|
|
</a>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Functions</span>
|
2023-07-12 11:28:07 +03:00
|
|
|
</h1>
|
|
|
|
|
<div class="functions-list">
|
|
|
|
|
<section class="detail" id="build_and_buffer/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#build_and_buffer/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">build_and_buffer(request)</h1>
|
|
|
|
|
|
2024-04-16 21:30:58 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.ex#L49" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<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> build_and_buffer(<a href="Plausible.Ingestion.Request.html#t:t/0">Plausible.Ingestion.Request.t</a>()) ::
|
|
|
|
|
{:ok, %{buffered: [<a href="#t:t/0">t</a>()], dropped: [<a href="#t:t/0">t</a>()]}}</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="emit_telemetry_buffered/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#emit_telemetry_buffered/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">emit_telemetry_buffered(event)</h1>
|
|
|
|
|
|
2024-04-16 21:30:58 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.ex#L89" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<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> emit_telemetry_buffered(<a href="#t:t/0">t</a>()) :: :ok</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="emit_telemetry_dropped/2">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#emit_telemetry_dropped/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">emit_telemetry_dropped(event, reason)</h1>
|
|
|
|
|
|
2024-04-16 21:30:58 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.ex#L97" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<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> emit_telemetry_dropped(<a href="#t:t/0">t</a>(), <a href="#t:drop_reason/0">drop_reason</a>()) :: :ok</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="telemetry_event_buffered/0">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#telemetry_event_buffered/0" 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">telemetry_event_buffered()</h1>
|
|
|
|
|
|
2024-04-16 21:30:58 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.ex#L75" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<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> telemetry_event_buffered() :: [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()]</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="telemetry_event_dropped/0">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#telemetry_event_dropped/0" 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">telemetry_event_dropped()</h1>
|
|
|
|
|
|
2024-04-16 21:30:58 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.ex#L80" class="icon-action" rel="help" title="View Source">
|
2023-07-12 11:28:07 +03:00
|
|
|
<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> telemetry_event_dropped() :: [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()]</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
2024-03-26 11:43:26 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="telemetry_pipeline_step_duration/0">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#telemetry_pipeline_step_duration/0" 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">telemetry_pipeline_step_duration()</h1>
|
|
|
|
|
|
2024-04-16 21:30:58 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/ingestion/event.ex#L84" class="icon-action" rel="help" title="View Source">
|
2024-03-26 11:43:26 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
|
2023-07-12 11:28:07 +03:00
|
|
|
</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
|
2024-01-16 10:41:49 +03:00
|
|
|
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.1) for the
|
2023-07-12 11:28:07 +03:00
|
|
|
|
|
|
|
|
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
</footer>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
</main>
|
2023-07-12 11:28:07 +03:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
|
|
|
|
<script>mermaid.initialize({startOnLoad: true})</script>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
