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.
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.
The environment of the app to be reported to AppSignal. This config option will be automatically detected in Rails apps. For Rails apps the RAILS_ENV variable is used to detect the environment. For apps using other frameworks or none at all, the RACK_ENV environment variable is used.To override this automatic detection, set the APPSIGNAL_APP_ENV environment variable.
Shell
export APPSIGNAL_APP_ENV=stagingrackup
This option will be used to load the configuration from the config files in which the AppSignal configuration is stored.The environment variable option is commonly used on platforms where apps run in the production environment by default, such as Heroku. This setting allows an override to set the environment to staging, for example.
Shell
heroku config:set APPSIGNAL_APP_ENV=staging
If the environment is set using the Appsignal.configure helper, it will override the APPSIGNAL_APP_ENV environment variable.
Note: Changing the name or environment of an existing app
will create a new app on AppSignal.com.
Note: This config option has no config file key equivalent. To set the
environment on AppSignal initialization, you’ll need to initialize the
configuration
manually.
There is no env key available in the config/appsignal.yml file. If you wish
to dynamically set the environment name for an app in the config file it’s
possible to customize your config file to use the environment to create an
environment.
If you use another environment variable than APPSIGNAL_APP_ENV make sure that matches the value is any of the auto detected environment variable names (RAILS_ENV and RACK_ENV) or the value given to Appsignal.configure.
Note: Changing the name or environment of an existing app
will create a new app on AppSignal.com.
Name of your application as it should be displayed on AppSignal.com. If you use Ruby on Rails the gem will auto-detect the name and you can leave this empty. For other frameworks setting this is mandatory.
Note: Changing the name or environment of an existing app
will create a new app on AppSignal.com.
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.
Configure the reporting of errors that occur in Active Job jobs. This option allows the disabling of error reporting for Active Job jobs, to allow for custom error reporting to be added.Accepted values:
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.
Note: The discard option only works on Active Job 7.1 and newer. On
lower versions discard is read as all.
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 to 0.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).
Configure the path of the SSL certificate file. By default this points to the AppSignal vendored cacert.pem file in the gem 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.
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.
Warning: This config option is deprecated in Ruby gem 3.0.16. Please use
the log_level option instead for Ruby gem 3.0.16 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.
Default tags that will be added to all transactions. Transaction-specific tags set with Appsignal.add_tags will override default tags with the same key.
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.
Enables the ActiveSupport::EventReporterstructured event reporting integration.When enabled, the AppSignal integration subscribes to events emitted by ActiveSupport::EventReporter, and report them as logs.
Configure how AppSignal shuts down when the application shuts down. This will determine if it calls Appsignal.stop automatically, which will flush the data to the extension and the agent.This option has three possible values:
always: Always call Appsignal.stop when the program exits. On (Docker) containers it’s automatically set to this value.
never: Never call Appsignal.stop when the program exits. The default value when the program doesn’t run on a (Docker) container.
on_error: Call Appsignal.stop when the program exits with an error.
Set to true to report the last error that caused the process to quit. The reported error is usually the error that crashes the process. If the Ruby gem already reported the error, it will not report it again.Errors reported via this mechanism are added to the “unhandled” namespace.Add this code to the start of the application on short-lived containers and serverless functions to ensure the error gets flushed before the system shuts down.
Enable the experimental front-end error catching system. This will add a route to your app on /appsignal_error_catcher that can be used to catch JavaScript error and send them to AppSignal. You can configure this route with frontend_error_catching_path.
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.
Set to true 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.
Enables the StatsD server in the AppSignal agent.When enabled, the AppSignal agent will listen to a localhost-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.
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).
The AppSignal Ruby gem stores metadata about requests and background jobs on samples by default, like request path, request method, request id, background queue, job id and job retry count. These metadata values will be shown in the tags box. If any of these metadata values contain PII or other senstive data, use this config option to filter out metadata by key.Set the filter_metadata option to a list of metadata keys that should be filtered out. You can configure this with a list of keys in the configuration file. When filtered the metadata will not be visible in the AppSignal UI.
Appsignal.configure do |config| config.filter_metadata += ["path", "request_id"]end
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.
Appsignal.configure do |config| config.filter_parameters += ["password", "email", "api_token", "token"]end
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.
Appsignal.configure do |config| config.filter_session_data += ["name", "email", "api_token", "token"]end
Group hosts by role and generate metrics based on this role. One such metric is the reporting_hosts counter metric. A good role indicates what the main role of the server is, like “webserver”, “processor”, “api”, “database”, “loadbalancer”, etc.
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.
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.
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.
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.
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.
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.
Select which logger the AppSignal integration will use. Accepted values are
file and stdout. See also the log_path configuration.
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:
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.
Configure the port on which the NGINX metrics server is exposed.When AppSignal receives NGINX metrics, it listens on a localhost-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.
The request_headers config option contains a list of HTTP request headers which are read and stored by the AppSignal Ruby gem.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.
Appsignal.configure do |config| # Add a request header config.request_headers << "PATH_INFO" # Remove a request header config.request_headers.delete("PATH_INFO")end
Note that AppSignal reads the headers from your app and they may not match 1 to 1 with what is being sent in the browser/client. In Rack apps (Rails, Sinatra, etc) all custom headers are prefixed with the HTTP_ string, all header names are uppercased and dashes (-) are replaced with underscores (_).For example, the X-Hub-Signature header can be access by your app and AppSignal with the HTTP_X_HUB_SIGNATURE name.To configure AppSignal to not store any HTTP request headers on AppSignal transactions, configure the option with an empty array.
Appsignal.configure do |config| config.request_headers = []end
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 the revision config option to a custom value.Read more about deploy markers in the deploy markers topic.
AppSignal expects to be running on the same machine between different deploys. Set this key to true 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.
Set this option to false to not send any session data with exception traces and performance issue samples.For more information please read about request session data filtering.
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.
Warning: This config option is deprecated in Ruby gem 3.0.16. Please use
the log_level option instead for Ruby gem 3.0.16 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.
Warning: This config option is deprecated in Ruby gem 2.7.0. Please use
the working_directory_path option instead
for Ruby gem 2.7.0 and newer.
Override the location where AppSignal for Ruby creates a working directory.
See
working_directory_path
for the behavior it is applicable. This config option appends /appsignal to
the specified path, where
working_directory_path
does not.
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 where AppSignal for Ruby 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.
Appsignal.configure do |config| config.working_directory_path = "/tmp/project_1/"end
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.
