Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Add Custom telemetry for Plausible.Event.WriteBuffer, Plausible.Event.WriteBuffer and Cachex (#2095)
Manu S Ajithc0c36646e2f6
diff --git a/lib/telemetry.ex b/lib/oban_error_reporter.exsimilarity index 97%rename from lib/telemetry.exrename to lib/oban_error_reporter.exindex ea052ad173..a8fd6f91dd 100644--- a/lib/telemetry.ex+++ b/lib/oban_error_reporter.ex@@ -1,4 +1,4 @@-defmodule ErrorReporter do+defmodule ObanErrorReporter dodef handle_event([:oban, :job, :exception], measure, %{job: job} = meta, _) doextra =jobdiff --git a/lib/plausible/application.ex b/lib/plausible/application.exindex d3288711ba..b5a6a3fc7b 100644--- a/lib/plausible/application.ex+++ b/lib/plausible/application.ex@@ -70,7 +70,7 @@ defmodule Plausible.Application do:telemetry.attach_many("oban-errors",[[:oban, :job, :exception], [:oban, :notifier, :exception], [:oban, :plugin, :exception]],- &ErrorReporter.handle_event/4,+ &ObanErrorReporter.handle_event/4,%{})enddiff --git a/lib/plausible/prom_ex.ex b/lib/plausible/prom_ex.exindex 0900964323..550b5c05ae 100644--- a/lib/plausible/prom_ex.ex+++ b/lib/plausible/prom_ex.ex@@ -10,7 +10,8 @@ defmodule Plausible.PromEx doPlugins.Beam,{Plugins.Phoenix, router: PlausibleWeb.Router, endpoint: PlausibleWeb.Endpoint},Plugins.Ecto,- Plugins.Oban+ Plugins.Oban,+ Plausible.PromEx.Plugins.PlausibleMetrics]enddiff --git a/lib/plausible/telemetry/plausible_metrics.ex b/lib/plausible/telemetry/plausible_metrics.exnew file mode 100644index 0000000000..3f1aa8b700--- /dev/null+++ b/lib/plausible/telemetry/plausible_metrics.ex@@ -0,0 +1,112 @@+defmodule Plausible.PromEx.Plugins.PlausibleMetrics do+ @moduledoc """+ Custom PromEx plugin for instrumenting code within Plausible app.+ """+ use PromEx.Plugin++ @impl true+ def polling_metrics(opts) do+ poll_rate = Keyword.get(opts, :poll_rate, 5_000)+ otp_app = Keyword.fetch!(opts, :otp_app)++ metric_prefix =+ Keyword.get(opts, :metric_prefix, PromEx.metric_prefix(otp_app, :plausible_metrics))++ [+ write_buffer_metrics(metric_prefix, poll_rate),+ cache_metrics(metric_prefix, poll_rate)+ ]+ end++ @doc """+ Add telemetry events for Session and Event write buffers+ """+ def execute_write_buffer_metrics do+ event_write_buffer_pid = GenServer.whereis(Plausible.Event.WriteBuffer)++ {:message_queue_len, events_message_queue_len} =+ if is_pid(event_write_buffer_pid),+ do: Process.info(event_write_buffer_pid, :message_queue_len),+ else: {:message_queue_len, 0}++ session_write_buffer_pid = GenServer.whereis(Plausible.Event.WriteBuffer)++ {:message_queue_len, sessions_message_queue_len} =+ if is_pid(session_write_buffer_pid),+ do: Process.info(session_write_buffer_pid, :message_queue_len),+ else: {:message_queue_len, 0}++ :telemetry.execute([:prom_ex, :plugin, :write_buffer_metrics, :events_message_queue_len], %{+ count: events_message_queue_len+ })++ :telemetry.execute([:prom_ex, :plugin, :write_buffer_metrics, :sessions_message_queue_len], %{+ count: sessions_message_queue_len+ })+ end++ @doc """+ Add telemetry events for Cachex user agents and sessions+ """+ def execute_cache_metrics do+ user_agents_count =+ case Cachex.stats(:user_agents) do+ {:ok, stats} -> stats+ _ -> 0+ end++ sessions_count =+ case Cachex.stats(:sessions) do+ {:ok, stats} -> stats+ _ -> 0+ end++ :telemetry.execute([:prom_ex, :plugin, :cachex, :user_agents_count], %{+ count: user_agents_count+ })++ :telemetry.execute([:prom_ex, :plugin, :cachex, :sessions_count], %{+ count: sessions_count+ })+ end++ defp write_buffer_metrics(metric_prefix, poll_rate) do+ Polling.build(+ :write_buffer_metrics,+ poll_rate,+ {__MODULE__, :execute_write_buffer_metrics, []},+ [+ last_value(+ metric_prefix ++ [:events, :message_queue_len, :count],+ event_name: [:prom_ex, :plugin, :write_buffer_metrics, :events_message_queue_len],+ measurement: :count+ ),+ last_value(+ metric_prefix ++ [:sessions, :message_queue_len, :count],+ event_name: [:prom_ex, :plugin, :write_buffer_metrics, :sessions_message_queue_len],+ measurement: :count+ )+ ]+ )+ end++ defp cache_metrics(metric_prefix, poll_rate) do+ Polling.build(+ :cache_metrics,+ poll_rate,+ {__MODULE__, :execute_cache_metrics, []},+ [+ last_value(+ metric_prefix ++ [:events, :cache_size, :count],+ event_name: [:prom_ex, :plugin, :cachex, :sessions_count],+ measurement: :count+ ),+ last_value(+ metric_prefix ++ [:sessions, :cache_size, :count],+ event_name: [:prom_ex, :plugin, :cachex, :user_agents_count],+ measurement: :count+ )+ ]+ )+ end+end