Sage v0.6.3

View Source Sage.CompensationErrorHandler behaviour (Sage v0.6.3)

This module provides behaviour for compensation error handling.

Few solutions you might want to try:

  • Send notification to a Slack channel about need of manual resolution;
  • Retry compensation;
  • Spin off a new supervised process that would retry compensation and return an error in the Sage. (Useful when you have connection issues that would be resolved at some point in future.)

For more information see "Critical Error Handling" in Sage module doc.

Link to this section Summary

Types

compensations_to_run()
error()

Callbacks

handle_error(error, compensations_to_run, opts)

Handler for critical errors for compensation execution.

Link to this section Types

Link to this type

compensations_to_run()

View Source 
@type compensations_to_run() :: [
  {name :: Sage.stage_name(), compensation :: Sage.compensation(),
   effect_to_compensate :: any()}
]
Link to this type

error()

View Source 
@type error() ::
  {:exception, exception :: Exception.t(), stacktrace :: Exception.stacktrace()}
  | {:exit, reason :: any()}
  | {:throw, error :: any()}

Link to this section Callbacks

Link to this callback

handle_error(error, compensations_to_run, opts)

View Source 
@callback handle_error(
  error :: error(),
  compensations_to_run :: compensations_to_run(),
  opts :: any()
) ::
  {:error, reason :: any()}

Handler for critical errors for compensation execution.

It should return only {:error, reason} which would be returned by the Sage itself.