AppSignal Elixir configuration options

The following list includes all configuration options with the name of the environment variable and the name of the key in the configuration file.

For more information on how to configure AppSignal with a configuration file or system environment variables, see our Configuration topic.

Available options

active

Config file keyactive
System environment keyAPPSIGNAL_ACTIVE
Requiredyes
TypeBoolean (true / false)
Default valuefalse / detected by system
Available since version0.1.0

Description

Note: When the APPSIGNAL_PUSH_API_KEY environment variable is set, this defaults to true. This can be overridden by setting the APPSIGNAL_ACTIVE system environment variable to false: APPSIGNAL_ACTIVE=false.

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

env

Config file keyenv
System environment keyAPPSIGNAL_APP_ENV
Requiredyes
TypeAtom
Default valuedev
Available since version0.1.0
0.9.2: The environment variable name for this configuration option was renamed from APPSIGNAL_ENVIRONMENT to APPSIGNAL_APP_ENV.

Description

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
Note: Changing the name or environment of an existing app will create a new app on AppSignal.com.

name

Config file keyname
System environment keyAPPSIGNAL_APP_NAME
Requiredyes
TypeString
Default valuenil (This is unset by default)

Description

Name of your application as it should be displayed on AppSignal.com.

Note: Changing the name or environment of an existing app will create a new app on AppSignal.com.

otp_app

Config file keyotp_app
System environment keyAPPSIGNAL_OTP_APP
Requiredyes
TypeAtom
Default valuenil (This is unset by default)
Available since version2.0.0

Description

The OTP app name of your application, to be used for automatic configuration of instrumentation for libraries like Ecto.

push_api_key

Config file keypush_api_key
System environment keyAPPSIGNAL_PUSH_API_KEY
Requiredyes
TypeString
Default valuenil (This is unset by default)
Available since version0.1.0

Description

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

Read more about the AppSignal Push API key.

Note: When the APPSIGNAL_PUSH_API_KEY system environment variable is set, the active option will default to true instead of false. This means AppSignal will be consider active for the loaded environment even if active is set to false in the config file. For more information see the active option.

ca_file_path

Config file keyca_file_path
System environment keyAPPSIGNAL_CA_FILE_PATH
Requiredno
TypeString
Default valuePackaged cacert.pem file path.
Available since version0.12.0

Description

Configure the path of the SSL certificate file. By default this points to the AppSignal vendored cacert.pem file in the package itself.

  • Use this option to point to another certificate file if there's a problem connecting to our API.
  • Note: The specified path cannot contain Operating Specific file system abstractions, such as the homedir symbol ~ for *NIX systems. This will be seen as a malformed path.

debug

Config file keydebug
System environment keyAPPSIGNAL_DEBUG
Requiredno
TypeBoolean (true / false)
Default valuefalse
Available since version1.0.0
Deprecated since version 2.2.8 in favor of the log_level config option.

Description

Warning: This config option is deprecated in Elixir package 2.2.8. Please use the log_level option instead for Elixir package 2.2.8 and newer.

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.

This option sets the severity level of AppSignal's internal logger. This configuration option does not affect the logging feature.

dns_servers

Config file keydns_servers
System environment keyAPPSIGNAL_DNS_SERVERS
Requiredno
Typelist(String)
Default value[]
Available since version1.3.0.beta.2

Description

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.

ecto_repos

Config file keyecto_repos
System environment keyAPPSIGNAL_ECTO_REPOS
Requiredno
Typelist(String)
Default valuenil
Available since version2.0.0

Description

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"

To turn off all Ecto instrumentation, configure :ecto_repos as an empty list:

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

enable_error_backend

Config file keyenable_error_backend
System environment keyAPPSIGNAL_ENABLE_ERROR_BACKEND
Requiredno
TypeBoolean (true / false)
Default valuetrue
Available since version2.4.1

Description

Enables the error backend in the Elixir integration.

enable_host_metrics

Config file keyenable_host_metrics
System environment keyAPPSIGNAL_ENABLE_HOST_METRICS
Requiredno
TypeBoolean (true / false)
Default valuetrue / detected by system

Description

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.

enable_minutely_probes

Config file keyenable_minutely_probes
System environment keyAPPSIGNAL_ENABLE_MINUTELY_PROBES
Requiredno
TypeBoolean (true / false)
Default valuetrue
Available since version1.10.1

Description

Enables the minutely probes system.

enable_statsd

Config file keyenable_statsd
System environment keyAPPSIGNAL_ENABLE_STATSD
Requiredno
TypeBoolean (true / false)
Default valuefalse
Available since version2.2.6

Description

Enables the StatsD server in the AppSignal agent.

endpoint

Config file keyendpoint
System environment keyAPPSIGNAL_PUSH_API_ENDPOINT
Requiredno
TypeString
Default valuehttps://push.appsignal.com

Description

Configure the endpoint to send data to AppSignal. This setting will not have to be changed.

files_world_accessible

Config file keyfiles_world_accessible
System environment keyAPPSIGNAL_FILES_WORLD_ACCESSIBLE
Requiredno
TypeBoolean (true / false)
Default valuetrue
Available since version1.3.4

Description

If this is set to true the AppSignal working directory that is created is accessible for all users (Unix permissions 0666). This is often necessary because processes for the same app run under a different user. Set to false to disable this behaviour (Unix permissions 0644).

filter_parameters

Config file keyfilter_parameters
System environment keyAPPSIGNAL_FILTER_PARAMETERS
Requiredno
Typelist(String)
Default value[]

Description

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.

filter_session_data

Config file keyfilter_session_data
System environment keyAPPSIGNAL_FILTER_SESSION_DATA
Requiredno
Typelist(String)
Default value[]
Available since version1.6.0
An upgrade to version 1.6.3 or higher is recommended.

Description

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.

hostname

Config file keyhostname
System environment keyAPPSIGNAL_HOSTNAME
Requiredno
TypeString
Default valuedetected from system
Available since version0.12.0

Description

This overrides the server's hostname. Useful for when you're unable to set a custom hostname or when a nondescript id is generated for you on hosting services.

http_proxy

Config file keyhttp_proxy
System environment keyAPPSIGNAL_HTTP_PROXY
Requiredno
TypeString
Default valuenil (This is unset by default)

Description

If you require the agent to connect to the Internet via a proxy set the complete proxy URL in this configuration key.

ignore_actions

Config file keyignore_actions
System environment keyAPPSIGNAL_IGNORE_ACTIONS
Requiredno
Typelist(String)
Default value[]

Description

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

Read more about ignoring actions.

ignore_errors

Config file keyignore_errors
System environment keyAPPSIGNAL_IGNORE_ERRORS
Requiredno
Typelist(String)
Default value[]

Description

List of error classes that will be ignored. Any exception raised with this error class will not be transmitted to AppSignal. Read more about ignoring errors.

ignore_namespaces

Config file keyignore_namespaces
System environment keyAPPSIGNAL_IGNORE_NAMESPACES
Requiredno
Typelist(String)
Default value[]
Available since version1.3.0

Description

List of namespaces that will be ignored. Any error raised or slow request that occurs in this namespace will not be send to AppSignal. Read more about namespaces.

log

Config file keylog
System environment keyAPPSIGNAL_LOG
Requiredno
TypeAtom
Default value:file

Description

This option configures what logger that AppSignal's internal logging functionality will use and does not affect the logging feature.


Note: At this time only the AppSignal integration supports the "stdout" log output feature. The AppSignal agent, which is used by the integration, does not support "stdout" log output. It will always write to the "appsignal.log" file.

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.

log_level

Config file keylog_level
System environment keyAPPSIGNAL_LOG_LEVEL
Requiredno
TypeString
Default valueinfo
Available since version2.2.8

Description

This option sets the severity level of AppSignal's internal logger and does not affect the logging feature.

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

log_path

Config file keylog_path
System environment keyAPPSIGNAL_LOG_PATH
Requiredno
TypeString
Default value/tmp
Available since version1.0.0
1.9.0: The default log path was changed from /tmp/appsignal/ to /tmp/.

Description

This option configures the location of AppSignal's internal logging file and does not affect the logging feature.


Note: The specified path cannot contain Operating Specific file system abstractions, such as the homedir symbol ~ for *NIX systems. This will be seen as a malformed path.

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

request_headers

Config file keyrequest_headers
System environment keyAPPSIGNAL_REQUEST_HEADERS
Requiredno
Typelist(String)
Default value["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"]
Available since version1.6.0
Upgrade to 1.6.3 or higher is recommend.

Description

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: []

revision

Config file keyrevision
System environment keyAPP_REVISION
Requiredno
TypeString
Default valuenil (This is unset by default)
Available since version1.5.0
1.10.12: Auto detection for Heroku deploys with the Dyno Metadata labs feature enabled.

Description

Set the app revision for the currently running version of your app. Used to create deploy markers and tag all incoming data to a certain deploy for the host.

When using Heroku with the Heroku Labs: Dyno Metadata enabled it will automatically set the revision config option to to the HEROKU_SLUG_COMMIT system environment variable. This will automatically report new deploys when the Heroku app gets deployed. The revision can still be overwritten by setting the revision config option yourself.

Read more about deploy markers on the deploy markers.

running_in_container

Config file keyrunning_in_container
System environment keyAPPSIGNAL_RUNNING_IN_CONTAINER
Requiredno
TypeBoolean (true / false)
Default valuefalse

Description

AppSignal expects to be running on the same machine between different deploys. Set this key to true if you use a container based deployment system such as 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

Config file keysend_environment_metadata
System environment keyAPPSIGNAL_SEND_ENVIRONMENT_METADATA
Requiredno
TypeBoolean (true / false)
Default valuetrue
Available since version2.2.8

Description

Send environment metadata about the app.

For more information please read about environment metadata.

send_params

Config file keysend_params
System environment keyAPPSIGNAL_SEND_PARAMS
Requiredno
TypeBoolean (true / false)
Default valuetrue
Available since version1.10.0

Description

Whether to skip sending request parameters to AppSignal.

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

send_session_data

Config file keysend_session_data
System environment keyAPPSIGNAL_SEND_SESSION_DATA
Requiredno
TypeBoolean (true / false)
Default valuetrue
Available since version2.2.10

Description

Set this option to false to not send any session data with exception traces and performance issue samples.

skip_session_data

Config file keyskip_session_data
System environment keyAPPSIGNAL_SKIP_SESSION_DATA
Requiredno
TypeBoolean (true / false)
Default valuefalse

Description

Warning: This config option is deprecated in the Elixir package 2.2.10. Please use the send_session_data option instead for newer versions of the Elixir package.

transaction_debug_mode

Config file keytransaction_debug_mode
System environment keyAPPSIGNAL_TRANSACTION_DEBUG_MODE
Requiredno
TypeBoolean (true / false)
Default valuefalse
Available since version1.11.4
Deprecated since version 2.2.9 in favor of the log_level config option.

Description

Warning: This config option is deprecated in Elixir package 2.2.9. Please use the log_level option instead for Elixir package 2.2.9 and newer.

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.

This option sets the severity level of AppSignal's internal logger and does not affect the logging feature.

working_dir_path

Config file keyworking_dir_path
System environment keyAPPSIGNAL_WORKING_DIR_PATH
Requiredno
TypeString
Default valuedetected by agent
Available since version1.8.0

Description

Warning: This config option is deprecated in Elixir package 1.8.0. Please use the working_directory_path option instead for Elixir package 1.8.0 and newer.

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/"
Note: The specified path cannot contain Operating Specific file system abstractions, such as the homedir symbol ~ for *NIX systems. This will be seen as a malformed path.

working_directory_path

Config file keyworking_directory_path
System environment keyAPPSIGNAL_WORKING_DIRECTORY_PATH
Requiredno
TypeString
Default valuedetected by agent
Available since version1.8.0
Please use the working_dir_path option on earlier versions.

Description

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/"
Note: The specified path cannot contain Operating Specific file system abstractions, such as the homedir symbol ~ for *NIX systems. This will be seen as a malformed path.

Need more help?

Contact us and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.

Contact us

Start a trial - 30 days free

AppSignal is a great way to monitor your Ruby, Elixir & Node.js applications. Works great with Rails, Phoenix, Express and other frameworks, with support for background jobs too. Let's improve your apps together.

Start a trial