Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore (sync service): add logger metadata as Sentry tags #2122

Merged
merged 1 commit into from
Dec 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/sync-service/lib/electric/connection/manager.ex
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ defmodule Electric.Connection.Manager do

Process.set_label({:connection_manager, opts[:stack_id]})
Logger.metadata(stack_id: opts[:stack_id])
Electric.Telemetry.Sentry.set_tags_context(stack_id: opts[:stack_id])

connection_opts =
opts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ defmodule Electric.Connection.Supervisor do
def init(opts) do
Process.set_label({:connection_supervisor, opts[:stack_id]})
Logger.metadata(stack_id: opts[:stack_id])
Electric.Telemetry.Sentry.set_tags_context(stack_id: opts[:stack_id])
Supervisor.init([{Electric.Connection.Manager, opts}], strategy: :rest_for_one)
end

Expand Down
1 change: 1 addition & 0 deletions packages/sync-service/lib/electric/plug/router.ex
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ defmodule Electric.Plug.Router do

def add_stack_id_to_metadata(conn, _) do
Logger.metadata(stack_id: conn.assigns.config[:stack_id])
Electric.Telemetry.Sentry.set_tags_context(stack_id: conn.assigns.config[:stack_id])
conn
end
end
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ defmodule Electric.Postgres.Inspector.EtsInspector do

Process.set_label({:ets_inspector, opts.stack_id})
Logger.metadata(stack_id: opts.stack_id)
Electric.Telemetry.Sentry.set_tags_context(stack_id: opts.stack_id)

# Name needs to be an atom but we don't want to dynamically create atoms.
# Instead, we will use the reference to the table that is returned by `:ets.new`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,13 @@ defmodule Electric.Postgres.LockConnection do
def init(opts) do
send(self(), :acquire_lock)

Logger.metadata(
metadata = [
lock_name: Keyword.fetch!(opts, :lock_name),
stack_id: Keyword.fetch!(opts, :stack_id)
)
]

Logger.metadata(metadata)
Electric.Telemetry.Sentry.set_tags_context(metadata)

{:ok,
%State{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ defmodule Electric.Postgres.ReplicationClient do
Process.set_label(:replication_client)
state = State.new(replication_opts)
Logger.metadata(stack_id: state.stack_id)
Electric.Telemetry.Sentry.set_tags_context(stack_id: state.stack_id)

{:ok, state}
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ defmodule Electric.Replication.ShapeLogCollector do
def init(opts) do
Process.set_label({:shape_log_collector, opts.stack_id})
Logger.metadata(stack_id: opts.stack_id)
Electric.Telemetry.Sentry.set_tags_context(stack_id: opts.stack_id)
state = Map.merge(opts, %{producer: nil, subscriptions: {0, MapSet.new()}})
# start in demand: :accumulate mode so that the ShapeCache is able to start
# all active consumers before we start sending transactions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ defmodule Electric.Replication.Supervisor do
def init(opts) do
Process.set_label({:replication_supervisor, opts[:stack_id]})
Logger.metadata(stack_id: opts[:stack_id])
Electric.Telemetry.Sentry.set_tags_context(stack_id: opts[:stack_id])
Logger.info("Starting shape replication pipeline")

# TODO: weird to have these without defaults but `consumer_supervisor` with a default
Expand Down
1 change: 1 addition & 0 deletions packages/sync-service/lib/electric/shape_cache.ex
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ defmodule Electric.ShapeCache do

Process.set_label({:shape_cache, stack_id})
Logger.metadata(stack_id: stack_id)
Electric.Telemetry.Sentry.set_tags_context(stack_id: stack_id)

{:ok, shape_status_state} =
opts.shape_status.initialise(
Expand Down
4 changes: 3 additions & 1 deletion packages/sync-service/lib/electric/shapes/consumer.ex
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ defmodule Electric.Shapes.Consumer do
%{log_producer: producer, storage: storage, shape_status: {shape_status, shape_status_state}} =
config

Logger.metadata(shape_handle: config.shape_handle, stack_id: config.stack_id)
metadata = [shape_handle: config.shape_handle, stack_id: config.stack_id]
Logger.metadata(metadata)
Electric.Telemetry.Sentry.set_tags_context(metadata)

Process.flag(:trap_exit, true)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ defmodule Electric.Shapes.Consumer.Snapshotter do

def init(config) do
Process.set_label({:snapshotter, config.shape_handle})
Logger.metadata(stack_id: config.stack_id, shape_handle: config.shape_handle)
metadata = [stack_id: config.stack_id, shape_handle: config.shape_handle]
Logger.metadata(metadata)
Electric.Telemetry.Sentry.set_tags_context(metadata)

{:ok, config, {:continue, :start_snapshot}}
end
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@ defmodule Electric.Shapes.ConsumerSupervisor do
config

Process.set_label({:consumer_supervisor, shape_handle})
Logger.metadata(stack_id: config.stack_id, shape_handle: shape_handle)
metadata = [stack_id: config.stack_id, shape_handle: shape_handle]
Logger.metadata(metadata)
Electric.Telemetry.Sentry.set_tags_context(metadata)

shape_storage = Electric.ShapeCache.Storage.for_shape(shape_handle, storage)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ defmodule Electric.Shapes.DynamicConsumerSupervisor do
def init(stack_id: stack_id) do
Process.set_label({:dynamic_consumer_supervisor, stack_id})
Logger.metadata(stack_id: stack_id)
Electric.Telemetry.Sentry.set_tags_context(stack_id: stack_id)
Logger.debug(fn -> "Starting #{__MODULE__}" end)
DynamicSupervisor.init(strategy: :one_for_one)
end
Expand Down
1 change: 1 addition & 0 deletions packages/sync-service/lib/electric/stack_supervisor.ex
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@ defmodule Electric.StackSupervisor do
def init(%{stack_id: stack_id} = config) do
Process.set_label({:stack_supervisor, stack_id})
Logger.metadata(stack_id: stack_id)
Electric.Telemetry.Sentry.set_tags_context(stack_id: stack_id)

inspector =
Access.get(
Expand Down
5 changes: 5 additions & 0 deletions packages/sync-service/lib/electric/telemetry/sentry.ex
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,9 @@ defmodule Electric.Telemetry.Sentry do
config: %{metadata: :all}
})
end

@spec set_tags_context(keyword()) :: :ok
def set_tags_context(tags) do
Sentry.Context.set_tags_context(Map.new(tags))
end
end
Loading