Minimal required configuration
The minimal required configuration needed by AppSignal for Elixir are the following items. If they are not present, AppSignal will not send any data to AppSignal.com.- A valid Push API Key
- The application’s OTP app name
- An application name
- An application environment (
dev/prod/test) - The application environment to be set to
active: true
APPSIGNAL_PUSH_API_KEY
environment variable is set.
Configuration options
Read about all the configuration options on the options page.Application environments
An application can have multiple environments such as “development”/“dev”, “test”, “staging” and “production”. To separate the errors and performance issues that occur in the “development” environment and those in “production”, it’s possible to set the environment in which the application is running with theenv configuration option.
A typical environment configuration file would contain the following.
active: true in the
config/{env}.exs file, the active option is not required in the main
config/config.exs file.
Disable AppSignal for tests
If you put your entire AppSignal configuration in theconfig/config.exs
instead of config/prod.exs (e.g. for having AppSignal enabled during
development), make sure to put active: false in your test configuration
unless you want to submit all your test results.
active: false, AppSignal does not start its agent. It still attaches its telemetry handlers for Ecto, Finch, Oban, Tesla, Absinthe, and Broadway when your application starts, and those handlers still run on every event they receive.
To stop a handler from attaching at all, also set its instrument_* config option to false. For example, to skip the Ecto, Finch, and Oban handlers in your tests: