You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
analytics/lib/plausible/stats/base.ex

438 lines
12 KiB
Elixir

defmodule Plausible.Stats.Base do
use Plausible.ClickhouseRepo
alias Plausible.Stats.{Query, Filters}
import Ecto.Query
@no_ref "Direct / None"
def base_event_query(site, query) do
events_q = query_events(site, query)
if Enum.any?(Filters.visit_props() ++ ["goal", "page"], &query.filters["visit:" <> &1]) do
sessions_q =
from(
s in query_sessions(site, query),
select: %{session_id: s.session_id}
)
from(
e in events_q,
join: sq in subquery(sessions_q),
on: e.session_id == sq.session_id
)
else
events_q
end
end
def query_events(site, query) do
{first_datetime, last_datetime} = utc_boundaries(query, site.timezone)
q =
from(
e in "events",
where: e.domain == ^site.domain,
where: e.timestamp >= ^first_datetime and e.timestamp < ^last_datetime
)
|> add_sample_hint(query)
q =
case query.filters["event:page"] do
{:is, page} ->
from(e in q, where: e.pathname == ^page)
{:is_not, page} ->
from(e in q, where: e.pathname != ^page)
{:matches, glob_expr} ->
regex = page_regex(glob_expr)
from(e in q, where: fragment("match(?, ?)", e.pathname, ^regex))
{:does_not_match, glob_expr} ->
regex = page_regex(glob_expr)
from(e in q, where: fragment("not(match(?, ?))", e.pathname, ^regex))
{:member, list} ->
from(e in q, where: e.pathname in ^list)
nil ->
q
end
q =
case query.filters["event:name"] do
{:is, name} ->
from(e in q, where: e.name == ^name)
{:member, list} ->
from(e in q, where: e.name in ^list)
nil ->
q
end
q =
case query.filters["event:goal"] do
{:is, :page, path} ->
from(e in q, where: e.pathname == ^path)
{:matches, :page, expr} ->
regex = page_regex(expr)
from(e in q, where: fragment("match(?, ?)", e.pathname, ^regex))
{:is, :event, event} ->
from(e in q, where: e.name == ^event)
nil ->
q
end
q =
case Query.get_filter_by_prefix(query, "event:props") do
{"event:props:" <> prop_name, {:is, value}} ->
if value == "(none)" do
from(
e in q,
where: fragment("not has(?, ?)", field(e, :"meta.key"), ^prop_name)
)
else
from(
e in q,
inner_lateral_join: meta in "meta",
as: :meta,
where: meta.key == ^prop_name and meta.value == ^value
)
end
{"event:props:" <> prop_name, {:is_not, value}} ->
if value == "(none)" do
from(
e in q,
where: fragment("has(?, ?)", field(e, :"meta.key"), ^prop_name)
)
else
from(
e in q,
left_lateral_join: meta in "meta",
as: :meta,
where:
(meta.key == ^prop_name and meta.value != ^value) or
fragment("not has(?, ?)", field(e, :"meta.key"), ^prop_name)
)
end
_ ->
q
end
q
end
@api_prop_name_to_db %{
"source" => "referrer_source",
"device" => "screen_size",
"screen" => "screen_size",
"os" => "operating_system",
"os_version" => "operating_system_version",
"country" => "country_code",
"region" => "subdivision1_code",
"city" => "city_geoname_id"
}
def query_sessions(site, query) do
{first_datetime, last_datetime} = utc_boundaries(query, site.timezone)
sessions_q =
from(
s in "sessions",
where: s.domain == ^site.domain,
where: s.start >= ^first_datetime and s.start < ^last_datetime
)
|> add_sample_hint(query)
sessions_q =
case {query.filters["visit:goal"], query.filters["visit:page"]} do
{nil, nil} ->
sessions_q
{goal_filter, page_filter} ->
events_query =
Query.put_filter(query, "event:goal", goal_filter)
|> Query.put_filter("event:name", nil)
|> Query.put_filter("event:page", page_filter)
events_q =
from(
s in query_events(site, events_query),
select: %{session_id: fragment("DISTINCT ?", s.session_id)}
)
from(
s in sessions_q,
join: sq in subquery(events_q),
on: s.session_id == sq.session_id
)
end
sessions_q =
case Query.get_filter_by_prefix(query, "visit:entry_props:") do
nil ->
sessions_q
{"visit:entry_props:" <> prop_name, filter_value} ->
case filter_value do
{:is, "(none)"} ->
from(
s in sessions_q,
where: fragment("not has(?, ?)", field(s, :"entry_meta.key"), ^prop_name)
)
{:is, value} ->
from(
s in sessions_q,
inner_lateral_join: meta in "entry_meta",
as: :meta,
where: meta.key == ^prop_name and meta.value == ^value
)
{:is_not, "(none)"} ->
from(
s in sessions_q,
where: fragment("has(?, ?)", field(s, :"entry_meta.key"), ^prop_name)
)
{:is_not, value} ->
from(
s in sessions_q,
left_lateral_join: meta in "entry_meta",
as: :meta,
where:
(meta.key == ^prop_name and meta.value != ^value) or
fragment("not has(?, ?)", field(s, :"entry_meta.key"), ^prop_name)
)
_ ->
sessions_q
end
end
Enum.reduce(Filters.visit_props(), sessions_q, fn prop_name, sessions_q ->
filter = query.filters["visit:" <> prop_name]
prop_name =
Map.get(@api_prop_name_to_db, prop_name, prop_name)
|> String.to_existing_atom()
case filter do
{:is, value} ->
value = db_prop_val(prop_name, value)
from(s in sessions_q, where: fragment("? = ?", field(s, ^prop_name), ^value))
{:is_not, value} ->
value = db_prop_val(prop_name, value)
from(s in sessions_q, where: fragment("? != ?", field(s, ^prop_name), ^value))
{:member, values} ->
list = Enum.map(values, &db_prop_val(prop_name, &1))
from(s in sessions_q, where: fragment("? in tuple(?)", field(s, ^prop_name), ^list))
{:matches, expr} ->
regex = page_regex(expr)
from(s in sessions_q, where: fragment("match(?, ?)", field(s, ^prop_name), ^regex))
{:does_not_match, expr} ->
regex = page_regex(expr)
from(s in sessions_q, where: fragment("not(match(?, ?))", field(s, ^prop_name), ^regex))
nil ->
sessions_q
_ ->
raise "Unknown filter type"
end
end)
end
def select_event_metrics(q, []), do: q
def select_event_metrics(q, [:pageviews | rest]) do
from(e in q,
select_merge: %{
pageviews:
fragment("toUInt64(round(countIf(? = 'pageview') * any(_sample_factor)))", e.name)
}
)
|> select_event_metrics(rest)
end
def select_event_metrics(q, [:events | rest]) do
from(e in q,
select_merge: %{events: fragment("toUInt64(round(count(*) * any(_sample_factor)))")}
)
|> select_event_metrics(rest)
end
def select_event_metrics(q, [:visitors | rest]) do
from(e in q,
select_merge: %{
visitors: fragment("toUInt64(round(uniq(?) * any(_sample_factor)))", e.user_id)
}
)
|> select_event_metrics(rest)
end
def select_event_metrics(q, [:sample_percent | rest]) do
from(e in q,
select_merge: %{
sample_percent:
fragment("if(any(_sample_factor) > 1, round(100 / any(_sample_factor)), 100)")
}
)
|> select_event_metrics(rest)
end
def select_event_metrics(_, [unknown | _]), do: raise("Unknown metric " <> unknown)
def select_session_metrics(q, []), do: q
def select_session_metrics(q, [:bounce_rate | rest]) do
from(s in q,
select_merge: %{
bounce_rate:
fragment("toUInt32(ifNotFinite(round(sum(is_bounce * sign) / sum(sign) * 100), 0))"),
visits: fragment("toUInt32(sum(sign))")
}
)
|> select_session_metrics(rest)
end
def select_session_metrics(q, [:visits | rest]) do
from(s in q,
select_merge: %{
visits: fragment("toUInt64(round(uniq(?) * any(_sample_factor)))", s.session_id)
}
)
|> select_session_metrics(rest)
end
def select_session_metrics(q, [:pageviews | rest]) do
from(s in q,
select_merge: %{
pageviews:
fragment("toUInt64(round(sum(? * ?) * any(_sample_factor)))", s.sign, s.pageviews)
}
)
|> select_session_metrics(rest)
end
def select_session_metrics(q, [:events | rest]) do
from(s in q,
select_merge: %{
events: fragment("toUInt64(round(sum(? * ?) * any(_sample_factor)))", s.sign, s.events)
}
)
|> select_session_metrics(rest)
end
def select_session_metrics(q, [:visitors | rest]) do
from(s in q,
select_merge: %{
visitors: fragment("toUInt64(round(uniq(?) * any(_sample_factor)))", s.user_id)
}
)
|> select_session_metrics(rest)
end
def select_session_metrics(q, [:visit_duration | rest]) do
from(s in q,
select_merge: %{
:visit_duration =>
fragment("toUInt32(ifNotFinite(round(sum(duration * sign) / sum(sign)), 0))"),
visits: fragment("toUInt32(sum(sign))")
}
)
|> select_session_metrics(rest)
end
def select_session_metrics(q, [:sample_percent | rest]) do
from(e in q,
select_merge: %{
sample_percent:
fragment("if(any(_sample_factor) > 1, round(100 / any(_sample_factor)), 100)")
}
)
|> select_event_metrics(rest)
end
def filter_converted_sessions(db_query, site, query) do
if Query.has_event_filters?(query) do
converted_sessions =
from(e in query_events(site, query),
select: %{session_id: fragment("DISTINCT ?", e.session_id)}
)
from(s in db_query,
join: cs in subquery(converted_sessions),
on: s.session_id == cs.session_id
)
else
db_query
end
end
defp db_prop_val(:referrer_source, @no_ref), do: ""
defp db_prop_val(:referrer, @no_ref), do: ""
defp db_prop_val(:utm_medium, @no_ref), do: ""
defp db_prop_val(:utm_source, @no_ref), do: ""
defp db_prop_val(:utm_campaign, @no_ref), do: ""
defp db_prop_val(:utm_content, @no_ref), do: ""
defp db_prop_val(:utm_term, @no_ref), do: ""
defp db_prop_val(_, val), do: val
def utc_boundaries(%Query{period: "realtime"}, _timezone) do
last_datetime = NaiveDateTime.utc_now() |> Timex.shift(seconds: 5)
first_datetime = NaiveDateTime.utc_now() |> Timex.shift(minutes: -5)
{first_datetime, last_datetime}
end
def utc_boundaries(%Query{period: "30m"}, _timezone) do
last_datetime = NaiveDateTime.utc_now() |> Timex.shift(seconds: 5)
first_datetime = NaiveDateTime.utc_now() |> Timex.shift(minutes: -30)
{first_datetime, last_datetime}
end
def utc_boundaries(%Query{date_range: date_range}, timezone) do
{:ok, first} = NaiveDateTime.new(date_range.first, ~T[00:00:00])
first_datetime =
Timex.to_datetime(first, timezone)
|> Timex.Timezone.convert("UTC")
{:ok, last} = NaiveDateTime.new(date_range.last |> Timex.shift(days: 1), ~T[00:00:00])
last_datetime =
Timex.to_datetime(last, timezone)
|> Timex.Timezone.convert("UTC")
{first_datetime, last_datetime}
end
def page_regex(expr) do
"^#{expr}$"
|> String.replace(~r/\*\*/, ".*")
|> String.replace(~r/(?<!\.)\*/, "[^/]*")
end
defp add_sample_hint(db_q, query) do
case query.sample_threshold do
"infinite" ->
db_q
threshold ->
from(e in db_q, hints: [sample: threshold])
end
end
end