Getting Started

Installation

Adding axn to your Gemfile is enough to start using include Action.

Global Configuration

A few configuration steps are highly recommended to get the full benefits (e.g. making sure all your swallowed exceptions are getting reported to your error tracking service).

The full set of available configuration settings is documented over here, but there are two worth calling out specifically:

Error Tracking

By default any swallowed errors are noted in the logs, but it's highly recommended to wire up an on_exception handler.

Metrics / Tracing

If you're using an APM provider, observability can be greatly enhanced by configuring OpenTelemetry tracing and metrics hooks. Axn automatically creates OpenTelemetry spans when OpenTelemetry is available.

Rails Integration (Optional)

When using Axn in a Rails application, you can configure how actions are autoloaded from the app/actions directory. By default, actions are loaded without any namespace, but you can configure a namespace to help differentiate them from existing service objects:

# config/initializers/axn.rb
Axn.configure do |c|
  # Use :Actions namespace to differentiate from existing service objects
  c.rails.app_actions_autoload_namespace = :Actions
end

This is particularly useful when migrating from existing service object patterns, as it makes it easy to distinguish between new Axn actions and legacy service objects when you see action.call in your codebase.

Code Quality (Optional)

For teams using RuboCop, Axn provides custom cops to enforce best practices. See the RuboCop Integration guide for setup instructions.