View Source Sentry.Test.Config (Sentry v13.0.1)

Provides per-test configuration isolation for the Sentry SDK.

When test_mode: true is configured, the SDK automatically uses this module as the :namespace resolver, enabling tests to override Sentry configuration on a per-test basis without affecting other tests, even when running with async: true.

Usage

Use put/1 in your test setup blocks to set per-test configuration overrides:

setup do
  Sentry.Test.Config.put(dsn: "http://public:secret@localhost:#{bypass.port}/1")
end

How It Works

Each test's overrides live in a Sentry.Test.Scope struct stored in :persistent_term under {:sentry_test_scope, test_pid}. The namespace/1 function asks Sentry.Test.Scope.Registry to resolve a scope for the current process by trying three strategies in order:

  1. Walking [self() | Process.get(:"$callers", [])].

  2. Walking the :"$ancestors" chain transitively against each scope's allowed_pids (populated via allow/2 and by the auto-allow of globally-supervised pids on the first put/1 call).
  3. Walking the :"$ancestors" chain against each scope's owner pid — covers GenServers started via start_supervised/1.

Globally-supervised processes (:logger, :logger_sup, Sentry.Supervisor) have no caller/ancestor link back to any test. put/1 auto-soft-allows them onto the calling scope so strategy 2 routes their config queries to the right test transparently, without requiring downstream suites to call allow/2 themselves.

Overrides are automatically cleaned up when the test exits via ExUnit.Callbacks.on_exit/1.

Summary

Functions

allow(owner_pid, allowed_pid)

Allows allowed_pid to read the configuration of owner_pid's test scope.

maybe_activate()

Activates per-test configuration isolation if test_mode: true is configured and no custom :namespace resolver has been explicitly set.

namespace(key)

Resolves config namespace for the current process.

put(config)

Sets per-test configuration overrides for the current test process.

Functions

Link to this function

allow(owner_pid, allowed_pid)

View Source 
@spec allow(pid(), pid() | nil) :: :ok

Allows allowed_pid to read the configuration of owner_pid's test scope.

Use this when a supervised process (such as a GenServer started via start_supervised!/1) does not inherit the test process's $callers chain and cannot be reached via the $ancestors walk (for example, a globally-registered process started at application boot).

The mapping is automatically cleaned up when the test exits.

Example 

scheduler_pid = Sentry.TelemetryProcessor.get_scheduler(processor_name)
Sentry.Test.Config.allow(self(), scheduler_pid)
Link to this function

maybe_activate()

View Source 
@spec maybe_activate() :: :ok

Activates per-test configuration isolation if test_mode: true is configured and no custom :namespace resolver has been explicitly set.

Called automatically by Sentry.Application on startup. You do not need to call this manually.

Link to this function

namespace(key)

View Source 
@spec namespace(atom()) :: {:ok, term()} | :default

Resolves config namespace for the current process.

Returns {:ok, value} if an override is found, or :default to fall back to global configuration.

Link to this function

put(config)

View Source 
@spec put(keyword()) :: :ok

Sets per-test configuration overrides for the current test process.

Each key-value pair is validated through Sentry.Config.validate!/1 before being stored. Overrides are automatically cleaned up when the test exits.

Example 

setup do
  Sentry.Test.Config.put(
    dsn: "http://public:secret@localhost:#{bypass.port}/1",
    send_result: :sync
  )
end