From 2d2ea1a2a3005c0ade617ad1aa3c6414356e6439 Mon Sep 17 00:00:00 2001 From: Adrian Gruntkowski Date: Thu, 9 Nov 2023 12:24:50 +0100 Subject: [PATCH] Implement trace ID ratio-based sampling for OpenTelemetry (#3499) * Implement trace ID ratio-based sampling for OpenTelemetry * Make `decide` more resilient --- lib/plausible/open_telemetry.ex | 36 --------------- lib/plausible/open_telemetry/sampler.ex | 59 +++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 36 deletions(-) create mode 100644 lib/plausible/open_telemetry/sampler.ex diff --git a/lib/plausible/open_telemetry.ex b/lib/plausible/open_telemetry.ex index 0bba30447..2673e6e36 100644 --- a/lib/plausible/open_telemetry.ex +++ b/lib/plausible/open_telemetry.ex @@ -46,39 +46,3 @@ defmodule Plausible.OpenTelemetry do ] end end - -defmodule Plausible.OpenTelemetry.Sampler do - @moduledoc """ - [Custom OpenTelemetry sampler](https://hexdocs.pm/opentelemetry/readme.html#samplers) - implementation that ignores particular traces to reduce noise. Ingestion - HTTP requests and queries to Oban tables are ignored, for example. - """ - - @behaviour :otel_sampler - require OpenTelemetry.Tracer, as: Tracer - - @routes_to_ignore ["/api/event", "/api/event/"] - @tables_to_ignore ["oban_jobs"] - - @impl true - def setup(_sampler_opts), do: [] - - @impl true - def description(_sampler_config), do: inspect(__MODULE__) - - @impl true - def should_sample(context, _trace_id, _links, _name, _kind, attributes, _config) do - tracestate = context |> Tracer.current_span_ctx() |> OpenTelemetry.Span.tracestate() - - case attributes do - %{"db.instance": _db, source: source} when source in @tables_to_ignore -> - {:drop, [], tracestate} - - %{"http.target": http_target} when http_target in @routes_to_ignore -> - {:drop, [], tracestate} - - _any -> - {:record_and_sample, [], tracestate} - end - end -end diff --git a/lib/plausible/open_telemetry/sampler.ex b/lib/plausible/open_telemetry/sampler.ex new file mode 100644 index 000000000..53571159e --- /dev/null +++ b/lib/plausible/open_telemetry/sampler.ex @@ -0,0 +1,59 @@ +defmodule Plausible.OpenTelemetry.Sampler do + @moduledoc """ + [Custom OpenTelemetry sampler](https://hexdocs.pm/opentelemetry/readme.html#samplers) + implementation that ignores particular traces to reduce noise. Ingestion + HTTP requests and queries to Oban tables are ignored, for example. + + For non-ignored traces, implements trace ID ratio-based sampling following the method + from [built-in sampler](https://github.com/open-telemetry/opentelemetry-erlang/blob/main/apps/opentelemetry/src/otel_sampler_trace_id_ratio_based.erl). + """ + + import Bitwise, only: [&&&: 2] + + # effective sampling ratio for non-ignored traces + @ratio 0.5 + # 2^63 - 1 + @max_value 9_223_372_036_854_775_807 + + @id_upper_bound @ratio * @max_value + + @behaviour :otel_sampler + require OpenTelemetry.Tracer, as: Tracer + + @routes_to_ignore ["/api/event", "/api/event/"] + @tables_to_ignore ["oban_jobs"] + + @impl true + def setup(_sampler_opts), do: [] + + @impl true + def description(_sampler_config), do: inspect(__MODULE__) + + @impl true + def should_sample(context, trace_id, _links, _name, _kind, attributes, _config) do + tracestate = context |> Tracer.current_span_ctx() |> OpenTelemetry.Span.tracestate() + + case attributes do + %{"db.instance": _db, source: source} when source in @tables_to_ignore -> + {:drop, [], tracestate} + + %{"http.target": http_target} when http_target in @routes_to_ignore -> + {:drop, [], tracestate} + + _any -> + {decide(trace_id), [], tracestate} + end + end + + defp decide(trace_id) when is_integer(trace_id) and trace_id > 0 do + lower_64_bits = trace_id &&& @max_value + + if abs(lower_64_bits) < @id_upper_bound do + :record_and_sample + else + :drop + end + end + + defp decide(_), do: :drop +end