Configuration. Important, because without it the AppSignal Elixir package won't know which application it's instrumenting or in which environment.
On this topic we'll explain how to configure AppSignal, what can be configured in the Elixir package and what the minimal configuration needed is.
- Minimal required configuration
- Configuration options
- Disable AppSignal for tests
1 2 3 4
# config/config.exs config :appsignal, :config, name: :my_app, push_api_key: "your-hex-appsignal-key"
Alternatively, you can configure the agent using OS environment variables.
export APPSIGNAL_PUSH_API_KEY=your-hex-appsignal-key export APPSIGNAL_APP_NAME=my_app
Read about all the configuration options on the options page.
Running your application you want to let AppSignal know what state your application is in.
This includes information about the version (revision) of your application and what environment it's running in.
A typical environment configuration file would contain the following.
1 2 3 4 5 6
# config/prod.exs config :appsignal, :config, name: :my_app, push_api_key: "your-hex-appsignal-key", env: :prod, revision: Mix.Project.config[:version]
If you put your entire AppSignal configuration in the
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.
1 2 3
# config/test.exs config :appsignal, :config, active: false
Want to help us improve this documentation page? Create a pull request