Logo of AppSignal

Menu
Docs navigation

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 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

Description

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

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

env

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.

Description

The environment of the app to be reported to AppSignal.

This option will also be used to load the configuration from the config files in which the AppSignal configuration is stored.

Setting this option overrides the app's default environment as reported to AppSignal.

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.

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

name

Config file key name
System environment key APPSIGNAL_APP_NAME
Required yes
Type Atom
Default value nil (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.

push_api_key

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

Description

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

Read more about the AppSignal Push API key.

ca_file_path

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

Description

Configure the path of the SSL certificate file. By default this points 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 an malformed path.

debug

Config file key debug
System environment key APPSIGNAL_DEBUG
Required no
Type Boolean (true / false)
Default value false

Description

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.

dns_servers

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

Description

Configure DNS servers for the AppSignal agent to use.

1
2
3
# config/config.exs
config :appsignal, :config,
  dns_servers: ["8.8.8.8", "8.8.4.4"]
1
2
# 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 occured while setting DNS servers.

enable_host_metrics

Config file key enable_host_metrics
System environment key APPSIGNAL_ENABLE_HOST_METRICS
Required no
Type Boolean (true / false)
Default value true

Description

Set this option to false to disable host metrics collection.

endpoint

Config file key endpoint
System environment key APPSIGNAL_PUSH_API_ENDPOINT
Required no
Type String
Default value "https://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 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

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 key filter_parameters
System environment key APPSIGNAL_FILTER_PARAMETERS
Required no
Type list(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.

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

Read more about parameter filtering.

filter_session_data

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 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.

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

Read more about session data filtering.

hostname

Config file key hostname
System environment key APPSIGNAL_HOSTNAME
Required no
Type String
Default value detected from system
Available since version 0.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 key http_proxy
System environment key APPSIGNAL_HTTP_PROXY
Required no
Type String
Default value nil (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 key ignore_actions
System environment key APPSIGNAL_IGNORE_ACTIONS
Required no
Type list(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 key ignore_errors
System environment key APPSIGNAL_IGNORE_ERRORS
Required no
Type list(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 key ignore_namespaces
System environment key APPSIGNAL_IGNORE_NAMESPACES
Required no
Type list(String)
Default value []
Available since version 1.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 key log
System environment key APPSIGNAL_LOG
Required no
Type Atom
Default value :file

Description

Select which logger to the AppSignal agent should 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.

Note: At this time only the AppSignal integration supports this feature and the AppSignal agent, which is used by the integration, does not yet support this.

log_path

Config file key log_path
System environment key APPSIGNAL_LOG_PATH
Required no
Type String
Default value "/tmp/appsignal/appsignal.log"

Description

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

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

request_headers

Config file key request_headers
System environment key APPSIGNAL_REQUEST_HEADERS
Required no
Type list(String)
Default value []
Available since version 1.6.0
Upgrade to 1.6.3 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.

1
2
3
4
5
6
7
# 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 array.

1
2
3
# config/appsignal.exs
config :appsignal, :config,
  request_headers: []

revision

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

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.

Read more about deploy markers on the deploy markers.

running_in_container

Config file key running_in_container
System environment key APPSIGNAL_RUNNING_IN_CONTAINER
Required no
Type Boolean (true / false)
Default value false

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.

skip_session_data

Config file key skip_session_data
System environment key APPSIGNAL_SKIP_SESSION_DATA
Required no
Type Boolean (true / false)
Default value false

Description

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

working_dir_path

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

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.

1
2
3
# 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 an malformed path.

working_directory_path

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.

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.

1
2
3
# 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 an malformed path.

We'd like to set cookies, read why.