AppSignal Elixir configuration options

Configure AppSignal to be active or not for a given environment. Most commonly used in the file configuration per environment.

The environment of the app to be reported to AppSignal. This option is set by default by our installer, to Mix.env. To override it, change the value in config/appsignal.exs (or your config file of choice).

# config/appsignal.exs
# or config/config.exs
config :appsignal, :config,
  env: Mix.env # Installer default

# Set your own value
config :appsignal, :config,
  env: :staging

To override the config option in the system environment, use the APPSIGNAL_APP_ENV environment variable.

# The method of setting environment variables may differ on your system
export APPSIGNAL_APP_ENV=staging
mix run

The environment variable option is commonly used on platforms, such as Heroku, where apps run in the production environment by default. This setting allows an override to set the environment to staging, for example.

heroku config:set APPSIGNAL_APP_ENV=staging

The organization-level authentication key to authenticate with our Push API.

Read more about the AppSignal Push API key.

Enable debug logging, this is usually only needed on request from support. With this option enabled AppSignal will log a lot more information about decisions that are made during metrics collection and when data is sent to AppSignal.com servers.

Enabling debug logging could have a slight impact on the disk usage and IO, especially on high-traffic sites. CPU overhead is minimal with the debug option enabled.

Configure DNS servers for the AppSignal agent to use.

# config/config.exs
config :appsignal, :config,
  dns_servers: ["8.8.8.8", "8.8.4.4"]

# In the host environment
export APPSIGNAL_DNS_SERVERS="8.8.8.8,8.8.4.4"

If you're affected by our DNS timeouts, try setting a DNS server manually using this option that doesn't use more than 4 dots in the server name.

• Acceptable values: 8.8.8.8, my.custom.local.server.
• Not acceptable values: foo, my.awesome.custom.local.dns.server.

If the DNS server cannot be reached the agent will fall back on the host's DNS configuration and output a message in the appsignal.log file: A problem occurred while setting DNS servers.

Configure which Ecto repos to instrument queries for. If unset, AppSignal will automatically find your repos through your application configuration.

# config/config.exs
config :appsignal, :config,
  ecto_repos: [AppsignalPhoenixExample.Repo, AppsignalPhoenixExample.AnotherRepo]

# In the host environment
export APPSIGNAL_ECTO_REPOS="AppsignalPhoenixExample.Repo,AppsignalPhoenixExample.AnotherRepo"

Set this option to false to disable host metrics collection.

On Heroku and Dokku host metrics are disabled by default. This is done because these systems will report inaccurate metrics from within the containers. Host metrics collection on these systems cannot be enabled. For Heroku, use the Heroku log drain instead.

List of parameter keys that should be ignored using AppSignal filtering. Their values will be replaced with [FILTERED] when transmitted to AppSignal. You can configure this with a list of keys in the configuration file.

# config/appsignal.exs
config :appsignal, :config,
  filter_parameters: ["password", "secret"]

Read more about parameter filtering.

List of session data keys that should be ignored using AppSignal filtering. Their values will be replaced with [FILTERED] when transmitted to AppSignal. You can configure this with a list of keys in the configuration file.

# config/appsignal.exs
config :appsignal, :config,
  filter_session_data: ["name", "email", "api_token", "token"]

Read more about session data filtering.

List of actions that will be ignored, everything that happens including exceptions will not be transmitted to AppSignal.

Read more about ignoring actions.

Select which logger the AppSignal integration will use. Accepted values are file and stdout. See also the log_path configuration.

• file (default)
  • Write all AppSignal logs to the file system.
• stdout (default on Heroku)
  • Print AppSignal logs in the parent process' STDOUT instead of to a file. Useful with hosting solutions such as container systems and Heroku.

Set the severity level of AppSignal's internal logger. If it is configured to "info" it will log all error, warning and info messages, but not log the debug messages.

Setting it to the levels "debug" or "trace" is usually only needed on request from support. Setting the level to "debug"/"trace" could have a slight impact on the disk usage and IO, especially on high-traffic sites. CPU overhead is minimal with the debug option enabled.

Accepted values:

• error
• warning
• info
• debug
• trace

Override the location of the path (directory) where the appsignal.log file can be written to.

When to report errors received by the Oban package integration's exception event handler while processing a job. Possible values are:

• "none": do not report errors.
• "all": always report errors.
• "discard": only report errors when the job is discarded due to the error.

The request_headers config option contains a list of HTTP request headers which are read and stored by the AppSignal Elixir package.

This request_headers config option is an allowlist, which means that it will only take headers as specified by this config option. If this config option is unset it will use the AppSignal default.

Following list is the AppSignal package default.

# config/appsignal.exs
config :appsignal, :config,
  request_headers: ~w(
    accept accept-charset accept-encoding accept-language cache-control
    connection content-length path-info range request-method
    request-uri server-name server-port server-protocol
  )

To configure AppSignal to not store any HTTP request headers on AppSignal transactions, configure the option with an empty list.

# config/appsignal.exs
config :appsignal, :config,
  request_headers: []

Set the app revision to report the currently running version of your app. AppSignal will create a deploy marker when this value changes, and tag all incoming data with the current revision.

When your application is deployed to Render, or when it is deployed to Heroku and the Heroku Labs: Dyno Metadata feature is enabled, the AppSignal integration will automatically detect the Git commit of the current deployment and use it as the revision.

You can overwrite the automatically detected revisions in Heroku or Render by manually setting the revision config option to a custom value.

Read more about deploy markers on the deploy markers.

AppSignal expects to be running on the same machine between different deploys. Set this key to true if the application or agent is running in a container, such as with Docker.

Newer versions of the AppSignal integration automatically detect its container environment, so no manual configuration is necessary. If you're having trouble with the automatic detection, please contact support.

This option is set to true automatically on Heroku.

Send environment metadata about the app.

For more information please read about environment metadata.

Whether to skip sending request parameters to AppSignal.

For more information please read about send_params in filtering request parameters.

Enable transaction debug mode. This enables very detailed logging of transactions and events which is useful when developing integrations or when events aren not tracked as expected. The log is only written if the general debug option is on as well.

Override the location where AppSignal for Elixir can store temporary files. Use this option if the default location is not suitable. See our how AppSignal operates page for more information about the purpose of this working directory.

If you are running multiple applications using AppSignal on the same server, use this configuration option to select different working directories for every AppSignal instance, otherwise the two instances could conflict with one another. For more information on this scenario see our running multiple applications on one host documentation.

# config/config.exs
config :appsignal, :config,
  working_dir_path: "/tmp/project_1/"

Override the location where AppSignal for Elixir can store temporary files. Use this option if the default location is not suitable. See our how AppSignal operates page for more information about the purpose of this working directory.

If you are running multiple applications using AppSignal on the same server, use this configuration option to select different working directories for every AppSignal instance, otherwise the two instances could conflict with one another. For more information on this scenario see our running multiple applications on one host documentation.

# config/appsignal.exs
config :appsignal, :config,
  working_directory_path: "/tmp/project_1/"