AppSignal v1.6.6-beta.1 Appsignal.TransactionRegistry View Source

Internal module which keeps a registry of the transaction handles linked to their originating process.

This is used on various places to link a calling process to its transaction. For instance, the Appsignal.ErrorHandler module uses it to be able to complete the transaction in case the originating process crashed.

The transactions are stored in an ETS table (with {:write_concurrency, true}, so no bottleneck is created); and the originating process is monitored to clean up the ETS table when the process has finished.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Given a process ID, return its associated transaction

Register the current process as the owner of the given transaction

Unregister the current process as the owner of the given transaction

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be (re)started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Given a process ID, return its associated transaction.

Link to this function register(transaction) View Source
register(Appsignal.Transaction.t()) :: :ok

Register the current process as the owner of the given transaction.

Link to this function remove_transaction(transaction) View Source
remove_transaction(Appsignal.Transaction.t()) ::
  :ok | {:error, :not_found} | {:error, :no_registry}

Unregister the current process as the owner of the given transaction.

Link to this function start_link() View Source
start_link() :: {:ok, pid()}