Improve query tracing (#3704)

* Enable breakdown property tracing for event:goal

This is currently overwritten by event:name. The queries for event:name
will still be tracked if queried specifically.

* Add filters tracing to Query.trace/1

* make sure breakdown metrics are sorted and joined

* check opts skip tracing directly without passing it
pull/3712/head r2024.01.22-322
RobertJoonas 3 years ago committed by GitHub
parent 8965ac40a7
commit 6ca4eaf5e2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -16,14 +16,16 @@ defmodule Plausible.Stats.Breakdown do
@event_props Plausible.Stats.Props.event_props()
def breakdown(site, query, "event:goal" = property, metrics, pagination) do
def breakdown(site, query, property, metrics, pagination, opts \\ [])
def breakdown(site, query, "event:goal" = property, metrics, pagination, opts) do
site = Plausible.Repo.preload(site, :goals)
{event_goals, pageview_goals} = Enum.split_with(site.goals, & &1.event_name)
events = Enum.map(event_goals, & &1.event_name)
event_query = %Query{query | filters: Map.put(query.filters, "event:name", {:member, events})}
trace(query, property, metrics)
if !Keyword.get(opts, :skip_tracing), do: trace(query, property, metrics)
event_results =
if Enum.any?(event_goals) do
@ -33,7 +35,7 @@ defmodule Plausible.Stats.Breakdown do
end
site
|> breakdown(event_query, "event:name", metrics, pagination)
|> breakdown(event_query, "event:name", metrics, pagination, skip_tracing: true)
|> transform_keys(%{name: :goal})
|> cast_revenue_metrics_to_money(revenue_goals)
else
@ -74,7 +76,7 @@ defmodule Plausible.Stats.Breakdown do
zip_results(event_results, page_results, :goal, metrics)
end
def breakdown(site, query, "event:props:" <> custom_prop = property, metrics, pagination) do
def breakdown(site, query, "event:props:" <> custom_prop = property, metrics, pagination, opts) do
{currency, metrics} =
on_full_build do
Plausible.Stats.Goal.Revenue.get_revenue_tracking_currency(site, query, metrics)
@ -99,7 +101,7 @@ defmodule Plausible.Stats.Breakdown do
[]
end
trace(query, property, metrics)
if !Keyword.get(opts, :skip_tracing), do: trace(query, property, metrics)
breakdown_events(site, query, "event:props:" <> custom_prop, metrics, pagination)
|> Kernel.++(none_result)
@ -107,7 +109,7 @@ defmodule Plausible.Stats.Breakdown do
|> Enum.sort_by(& &1[sorting_key(metrics)], :desc)
end
def breakdown(site, query, "event:page" = property, metrics, pagination) do
def breakdown(site, query, "event:page" = property, metrics, pagination, opts) do
event_metrics = Enum.filter(metrics, &(&1 in @event_metrics))
session_metrics = Enum.filter(metrics, &(&1 in @session_metrics))
@ -134,7 +136,7 @@ defmodule Plausible.Stats.Breakdown do
Query.put_filter(query, "visit:entry_page", {:member, Enum.map(pages, & &1[:page])})
end
trace(new_query, property, metrics)
if !Keyword.get(opts, :skip_tracing), do: trace(new_query, property, metrics)
if Enum.any?(event_metrics) && Enum.empty?(event_result) do
[]
@ -157,13 +159,13 @@ defmodule Plausible.Stats.Breakdown do
end
end
def breakdown(site, query, property, metrics, pagination) when property in @event_props do
trace(query, property, metrics)
def breakdown(site, query, property, metrics, pagination, opts) when property in @event_props do
if !Keyword.get(opts, :skip_tracing), do: trace(query, property, metrics)
breakdown_events(site, query, property, metrics, pagination)
end
def breakdown(site, query, property, metrics, pagination) do
trace(query, property, metrics)
def breakdown(site, query, property, metrics, pagination, opts) do
if !Keyword.get(opts, :skip_tracing), do: trace(query, property, metrics)
breakdown_sessions(site, query, property, metrics, pagination)
end
@ -684,6 +686,8 @@ defmodule Plausible.Stats.Breakdown do
defp trace(query, property, metrics) do
Query.trace(query)
metrics = Enum.sort(metrics) |> Enum.join(";")
Tracer.set_attributes([
{"plausible.query.breakdown_property", property},
{"plausible.query.breakdown_metrics", metrics}

@ -252,10 +252,13 @@ defmodule Plausible.Stats.Query do
@spec trace(%__MODULE__{}) :: %__MODULE__{}
def trace(%__MODULE__{} = query) do
filter_keys = Map.keys(query.filters) |> Enum.sort() |> Enum.join(";")
Tracer.set_attributes([
{"plausible.query.interval", query.interval},
{"plausible.query.period", query.period},
{"plausible.query.include_imported", query.include_imported}
{"plausible.query.include_imported", query.include_imported},
{"plausible.query.filter_keys", filter_keys}
])
query

Loading…
Cancel
Save