Available options
- Required options
- Options
bind_addressca_file_pathcpu_countdebugdns_serversecto_reposenable_error_backendenable_host_metricsenable_minutely_probesenable_nginx_metricsenable_statsdendpointfiles_world_accessiblefilter_parametersfilter_session_datahost_rolehostnamehttp_proxyignore_actionsignore_errorsignore_logsignore_namespacesinstrument_absintheinstrument_ectoinstrument_finchinstrument_obaninstrument_teslaloglog_levellog_pathnginx_portreport_oban_errorsrequest_headersrevisionrunning_in_containersend_environment_metadatasend_paramssend_session_dataskip_session_datastatsd_porttransaction_debug_modeworking_dir_pathworking_directory_path
active
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.env
Description
The environment of the app to be reported to AppSignal. This option is set by default by our installer, toMix.env. To override it, change the value in config/appsignal.exs (or your config file of choice).
Elixir
APPSIGNAL_APP_ENV environment variable.
Shell
production environment by default. This setting allows an override to set the environment to staging, for example.
Shell
Note: Changing the name or environment of an existing app
will create a new app on AppSignal.com.
Note: Changing the name or environment of an existing app
will create a new app on AppSignal.com.
name
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
Description
The OTP app name of your application, to be used for automatic configuration of instrumentation for libraries like Ecto.push_api_key
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.bind_address
Description
A valid IPv4 address the AppSignal agent uses as a binding for its TCP and UDP servers. Use a specific address if you only want the agent to listen to requests made to that address. Set this option to0.0.0.0 to allow to receive requests from hosts using any IP address. By default it only listens to requests made on the same host. This option is applied to all the agent servers (StatsD, OpenTelemetry and NGINX).
ca_file_path
Description
Configure the path of the SSL certificate file. By default this points to the AppSignal vendoredcacert.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.cpu_count
Description
The available CPU capacity of the host, in number of CPUs. This is used to calculate the CPU usage percentage in the host metrics. If not set, the agent will attempt to automatically detect this from cgroups. The number of CPUs can be a fraction, e.g.0.5.
debug
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. 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
Description
Configure DNS servers for the AppSignal agent to use.- Acceptable values:
8.8.8.8,my.custom.local.server. - Not acceptable values:
foo,my.awesome.custom.local.dns.server.
appsignal.log file: A problem occurred while setting DNS servers.
ecto_repos
Description
Configure which Ecto repos to instrument queries for. If unset, AppSignal will automatically find your repos through your application configuration.enable_error_backend
Description
Enables the error backend in the Elixir integration.enable_host_metrics
Description
Set this option tofalse 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
Description
Enables the minutely probes system.enable_nginx_metrics
Description
Set totrue to enable the NGINX metrics server. See the NGINX metrics documentation for details.
When enabled, the AppSignal agent will listen to a localhost-bound server on port 27649. If you’re running several AppSignal-instrumented applications in the same server, this configuration option can only be enabled in one of them.
enable_statsd
Description
Enables the StatsD server in the AppSignal agent. When enabled, the AppSignal agent will listen to alocalhost-bound server on port 8125. If you’re running several AppSignal-instrumented applications in the same server, this configuration option can only be enabled in one of them.
endpoint
Description
Configure the endpoint to send data to AppSignal. This setting will not have to be changed.files_world_accessible
Description
If this is set totrue 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
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.
Elixir
filter_session_data
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.
Elixir
host_role
Description
Group hosts by role and generate metrics based on this role. One such metric is thereporting_hosts counter metric. A good role indicates what the main role of the server is, like “webserver”, “processor”, “api”, “database”, “loadbalancer”, etc.
hostname
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
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
Description
With this config option you can specify a list of actions that will be ignored by AppSignal. Everything that happens including exceptions will not be transmitted to AppSignal. This can be useful to ignore health check endpoints or other actions that you don’t want to monitor. Read more about ignoring actions.ignore_errors
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_logs
Description
List of log messages that will be ignored. Any log message containing any of the elements of the list will not be transmitted to AppSignal. A small subset of regex syntax is supported, read more about it in our Ignore Logs guide.ignore_namespaces
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.instrument_absinthe
Description
Whether to automatically instrument Telemetry events for the Absinthe package integration, can betrue or false.
instrument_ecto
Description
Whether to automatically instrument Telemetry events for the Ecto package integration, can betrue or false.
instrument_finch
Description
Whether to automatically instrument Telemetry events for the Finch package integration, can betrue or false.
instrument_oban
Description
Whether to automatically instrument Telemetry events for the Oban package integration, can betrue or false.
instrument_tesla
Description
Whether to automatically instrument Telemetry events for the Tesla package integration, can betrue or false.
log
Description
This option configures what logger that AppSignal’s internal logging
functionality will use and does not affect the logging feature.Note: The AppSignal agent,
which is used by the integration, will always write to the “appsignal.log” file.
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
Description
This option sets the severity level of AppSignal’s internal logger and does
not affect the logging feature.
- error
- warning
- info
- debug
- trace
log_path
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
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.appsignal.log file can
be written to.
nginx_port
Description
Configure the port on which the NGINX metrics server is exposed. When AppSignal receives NGINX metrics, it listens on alocalhost-bound server, by default on port 27649. If you’re running several AppSignal-instrumented applications in the same server with NGINX metrics enabled, use this option to configure each application to listen on a different port.
report_oban_errors
Description
When to report errors received by the Oban package integration’s exception event handler while processing a job. Possible values are:all: Report all errors for every execution of jobs, including retries.discard: Report errors when the job is discarded due to the error. Use this option to only report errors when all job retries have been exhausted.none: Report no errors for jobs, including retries.
request_headers
Description
Therequest_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.
Elixir
Elixir
revision
Description
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 using Kamal, or when it 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, Render or Kamal by manually setting therevision config option to a custom value.
Read more about deploy markers in the deploy markers topic.
running_in_container
Description
AppSignal expects to be running on the same machine between different deploys. Set this key totrue if the application 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
Description
Send environment metadata about the app. For more information please read about environment metadata.send_params
Description
Whether to skip sending request parameters to AppSignal. For more information please read about send_params in filtering request parameters.send_session_data
Description
Set this option tofalse to not send any session data with exception traces and performance issue samples.
For more information please read about request session data filtering.
skip_session_data
Description
statsd_port
Description
Set this option to configure the StatsD HTTP server port of the AppSignal agent process. Configure this port if another process is already running on the machine that is also using this port to avoid conflicts.transaction_debug_mode
Description
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 generaldebug 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
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.Elixir
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
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.Elixir
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.