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.
Loading...| Config file key | active |
|---|---|
| System environment key | APPSIGNAL_ACTIVE |
| Required | yes |
| Type | Boolean (true / false) |
| Default value | false / detected by system |
| Available since version | 0.1.0 |
Configure AppSignal to be active or not for a given environment. Most commonly used in the file configuration per environment.
| Config file key | env |
|---|---|
| System environment key | APPSIGNAL_APP_ENV |
| Required | yes |
| Type | Atom |
| Default value | dev |
| Available since version | 0.1.0 |
0.9.2: The environment variable name for this configuration option was renamed from APPSIGNAL_ENVIRONMENT to APPSIGNAL_APP_ENV. |
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: :stagingTo 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 runThe 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| Config file key | name |
|---|---|
| System environment key | APPSIGNAL_APP_NAME |
| Required | yes |
| Type | Atom |
| Default value | nil (This is unset by default) |
Name of your application as it should be displayed on AppSignal.com.
| Config file key | otp_app |
|---|---|
| System environment key | APPSIGNAL_OTP_APP |
| Required | yes |
| Type | String |
| Default value | nil (This is unset by default) |
| Available since version | 2.0.0 |
The OTP app name of your application, to be used for automatic configuration of instrumentation for libraries like Ecto.
| Config file key | push_api_key |
|---|---|
| System environment key | APPSIGNAL_PUSH_API_KEY |
| Required | yes |
| Type | String |
| Default value | nil (This is unset by default) |
| Available since version | 0.1.0 |
The organization-level authentication key to authenticate with our Push API.
Read more about the AppSignal Push API key.
| Config file key | ca_file_path |
|---|---|
| System environment key | APPSIGNAL_CA_FILE_PATH |
| Required | no |
| Type | String |
| Default value | Packaged cacert.pem file path. |
| Available since version | 0.12.0 |
Configure the path of the SSL certificate file. By default this points to the AppSignal vendored cacert.pem file in the package itself.
| Config file key | debug |
|---|---|
| System environment key | APPSIGNAL_DEBUG |
| Required | no |
| Type | Boolean (true / false) |
| Default value | false |
| Available since version | 1.0.0 |
Deprecated since version 2.2.8 in favor of the log_level config option. |
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.
| Config file key | dns_servers |
|---|---|
| System environment key | APPSIGNAL_DNS_SERVERS |
| Required | no |
| Type | list(String) |
| Default value | [] |
| Available since version | 1.3.0.beta.2 |
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.
8.8.8.8, my.custom.local.server.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.
| Config file key | ecto_repos |
|---|---|
| System environment key | APPSIGNAL_ECTO_REPOS |
| Required | no |
| Type | list(String) |
| Default value | nil |
| Available since version | 2.0.0 |
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: []| Config file key | enable_host_metrics |
|---|---|
| System environment key | APPSIGNAL_ENABLE_HOST_METRICS |
| Required | no |
| Type | Boolean (true / false) |
| Default value | |
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.
| Config file key | enable_minutely_probes |
|---|---|
| System environment key | APPSIGNAL_ENABLE_MINUTELY_PROBES |
| Required | no |
| Type | Boolean (true / false) |
| Default value | true |
| Available since version | 1.10.1 |
Enables the minutely probes system.
| Config file key | enable_statsd |
|---|---|
| System environment key | APPSIGNAL_ENABLE_STATSD |
| Required | no |
| Type | Boolean (true / false) |
| Default value | false |
| Available since version | 2.2.6 |
Enables the StatsD server in the AppSignal agent.
| Config file key | endpoint |
|---|---|
| System environment key | APPSIGNAL_PUSH_API_ENDPOINT |
| Required | no |
| Type | String |
| Default value | https://push.appsignal.com |
Configure the endpoint to send data to AppSignal. This setting will not have to be changed.
| Config file key | files_world_accessible |
|---|---|
| System environment key | APPSIGNAL_FILES_WORLD_ACCESSIBLE |
| Required | no |
| Type | Boolean (true / false) |
| Default value | true |
| Available since version | 1.3.4 |
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).
| Config file key | filter_parameters |
|---|---|
| System environment key | APPSIGNAL_FILTER_PARAMETERS |
| Required | no |
| Type | list(String) |
| Default value | [] |
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.
| Config file key | filter_session_data |
|---|---|
| System environment key | APPSIGNAL_FILTER_SESSION_DATA |
| Required | no |
| Type | list(String) |
| Default value | [] |
| Available since version | 1.6.0 |
An upgrade to version 1.6.3 or higher is recommended. |
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.
| Config file key | hostname |
|---|---|
| System environment key | APPSIGNAL_HOSTNAME |
| Required | no |
| Type | String |
| Default value | detected from system |
| Available since version | 0.12.0 |
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.
| Config file key | http_proxy |
|---|---|
| System environment key | APPSIGNAL_HTTP_PROXY |
| Required | no |
| Type | String |
| Default value | nil (This is unset by default) |
If you require the agent to connect to the Internet via a proxy set the complete proxy URL in this configuration key.
| Config file key | ignore_actions |
|---|---|
| System environment key | APPSIGNAL_IGNORE_ACTIONS |
| Required | no |
| Type | list(String) |
| Default value | [] |
List of actions that will be ignored, everything that happens including exceptions will not be transmitted to AppSignal.
Read more about ignoring actions.
| Config file key | ignore_errors |
|---|---|
| System environment key | APPSIGNAL_IGNORE_ERRORS |
| Required | no |
| Type | list(String) |
| Default value | [] |
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.
| Config file key | ignore_namespaces |
|---|---|
| System environment key | APPSIGNAL_IGNORE_NAMESPACES |
| Required | no |
| Type | list(String) |
| Default value | [] |
| Available since version | 1.3.0 |
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.
| Config file key | log |
|---|---|
| System environment key | APPSIGNAL_LOG |
| Required | no |
| Type | Atom |
| Default value | :file |
Select which logger to the AppSignal agent should use. Accepted values are
file and stdout. See also the log_path configuration.
file (default)
stdout (default on Heroku)
| Config file key | log_level |
|---|---|
| System environment key | APPSIGNAL_LOG_LEVEL |
| Required | no |
| Type | String |
| Default value | info |
| Available since version | 2.2.8 |
Set the severity level of the AppSignal 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:
| Config file key | log_path |
|---|---|
| System environment key | APPSIGNAL_LOG_PATH |
| Required | no |
| Type | String |
| Default value | /tmp |
| Available since version | 1.0.0 |
1.9.0: The default log path was changed from /tmp/appsignal/ to /tmp/. |
Override the location of the path (directory) where the appsignal.log file can be written to.
| Config file key | request_headers |
|---|---|
| System environment key | APPSIGNAL_REQUEST_HEADERS |
| Required | no |
| Type | list(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 version | 1.6.0 |
Upgrade to 1.6.3 or higher is recommend. |
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: []| Config file key | revision |
|---|---|
| System environment key | APP_REVISION |
| Required | no |
| Type | String |
| Default value | nil (This is unset by default) |
| Available since version | 1.5.0 |
1.10.12: Auto detection for Heroku deploys with the Dyno Metadata labs feature enabled. |
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.
| Config file key | running_in_container |
|---|---|
| System environment key | APPSIGNAL_RUNNING_IN_CONTAINER |
| Required | no |
| Type | Boolean (true / false) |
| Default value | false |
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.
| Config file key | send_environment_metadata |
|---|---|
| System environment key | APPSIGNAL_SEND_ENVIRONMENT_METADATA |
| Required | no |
| Type | Boolean (true / false) |
| Default value | true |
| Available since version | 2.2.8 |
Send environment metadata about the app.
For more information please read about environment metadata.
| Config file key | send_params |
|---|---|
| System environment key | APPSIGNAL_SEND_PARAMS |
| Required | no |
| Type | Boolean (true / false) |
| Default value | true |
| Available since version | 1.10.0 |
Whether to skip sending request parameters to AppSignal.
For more information please read about send_params in filtering request parameters.
| Config file key | send_session_data |
|---|---|
| System environment key | APPSIGNAL_SEND_SESSION_DATA |
| Required | no |
| Type | Boolean (true / false) |
| Default value | true |
| Available since version | 2.2.10 |
Set this option to false to not send any session data with exception traces and performance issue samples.
| Config file key | skip_session_data |
|---|---|
| System environment key | APPSIGNAL_SKIP_SESSION_DATA |
| Required | no |
| Type | Boolean (true / false) |
| Default value | false |
| Config file key | transaction_debug_mode |
|---|---|
| System environment key | APPSIGNAL_TRANSACTION_DEBUG_MODE |
| Required | no |
| Type | Boolean (true / false) |
| Default value | false |
| Available since version | 1.11.4 |
Deprecated since version 2.2.9 in favor of the log_level config option. |
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.
| Config file key | working_dir_path |
|---|---|
| System environment key | APPSIGNAL_WORKING_DIR_PATH |
| Required | no |
| Type | String |
| Default value | detected by agent |
| Available since version | 1.8.0 |
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/"| Config file key | working_directory_path |
|---|---|
| System environment key | APPSIGNAL_WORKING_DIRECTORY_PATH |
| Required | no |
| Type | String |
| Default value | detected by agent |
| Available since version | 1.8.0 |
Please use the working_dir_path option on earlier versions. |
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/"