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

• Required options
  • active
  • APPSIGNAL_APP_ENV
  • name
  • push_api_key
• Options
  • activejob_report_errors
  • bind_address
  • ca_file_path
  • cpu_count
  • debug
  • dns_servers
  • enable_allocation_tracking
  • enable_at_exit_hook
  • enable_at_exit_reporter
  • enable_frontend_error_catching
  • enable_gvl_global_timer
  • enable_gvl_waiting_threads
  • enable_host_metrics
  • enable_minutely_probes
  • enable_nginx_metrics
  • enable_rails_error_reporter
  • enable_rake_performance_instrumentation
  • enable_statsd
  • endpoint
  • files_world_accessible
  • filter_metadata
  • filter_parameters
  • filter_session_data
  • host_role
  • hostname
  • http_proxy
  • ignore_actions
  • ignore_errors
  • ignore_logs
  • ignore_namespaces
  • instrument_http_rb
  • instrument_net_http
  • instrument_ownership
  • instrument_redis
  • instrument_sequel
  • log
  • log_level
  • log_path
  • ownership_set_namespace
  • request_headers
  • revision
  • running_in_container
  • send_environment_metadata
  • send_params
  • send_session_data
  • sidekiq_report_errors
  • skip_session_data
  • statsd_port
  • transaction_debug_mode
  • working_dir_path
  • working_directory_path

active

Description

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

APPSIGNAL_APP_ENV

Description

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.

export APPSIGNAL_APP_ENV=staging
rackup

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.

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.

Custom environments in config file

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.

# config/appsignal.yml
<%= ENV["APPSIGNAL_APP_ENV"] %>:
  active: true

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.

name

Description

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.

push_api_key

Description

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

Read more about the AppSignal Push API key.

activejob_report_errors

Description

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.

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

ca_file_path

Description

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.

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.

dns_servers

Description

Configure DNS servers for the AppSignal agent to use.

Appsignal.configure do |config|
  config.dns_servers = ["8.8.8.8", "8.8.4.4"]
end

default: &defaults
  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.

enable_allocation_tracking

Description

Set this option to false to disable tracking of the number of allocated objects in Ruby.

enable_at_exit_hook

Description

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.

For more information, see our instrumentation for scripts and background jobs page.

enable_at_exit_reporter

Description

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.

at_exit { sleep 5 }

enable_frontend_error_catching

Description

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.

enable_gvl_global_timer

Description

Set this option to false to disable the GVL global timer instrumentation. This configuration option has no effect if GVLTools is not installed.

enable_gvl_waiting_threads

Description

Set this option to false to disable the GVL waiting threads instrumentation. This configuration option has no effect if GVLTools is not installed.

enable_host_metrics

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

Description

Enables the minutely probes system.

enable_nginx_metrics

Description

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.

enable_rails_error_reporter

Description

Set to false to disable the Rails error reporter subscriber. See the Rails documentation for details.

enable_rake_performance_instrumentation

Description

Enable performance instrumentation for Rake tasks. By default, the Rake instrumentation only reports errors.

enable_statsd

Description

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.

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

Description

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

default: &defaults
  filter_metadata:
    - path
    - request_id

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.

Appsignal.configure do |config|
  config.filter_parameters += ["password", "email", "api_token", "token"]
end

# config/appsignal.yml
default: &defaults
  filter_parameters:
    - password
    - email
    - api_token
    - token

Read more about parameter filtering.

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.

Appsignal.configure do |config|
  config.filter_session_data += ["name", "email", "api_token", "token"]
end

# config/appsignal.yml
default: &defaults
  filter_session_data:
    - name
    - email
    - api_token
    - token

Read more about session data filtering.

host_role

Description

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.

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_http_rb

Description

Enable or disable the instrumentation for the http.rb Ruby gem. Enabled by default.

instrument_net_http

Description

Whether to add instrumentation for net/http calls, can be true or false.

instrument_ownership

Description

Whether to automatically instrument the Ownership gem, can be true or false.

instrument_redis

Description

Whether to enable the instrumentation for Redis queries using the Redis gem, can be true or false.

instrument_sequel

Description

Whether to add instrumentation for sequel queries using the Sequel gem integration, can be true or false.

log

Description

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

Description

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

Description

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

ownership_set_namespace

Description

Whether the Ownership gem instrumentation should set the namespace of a sample to its owner, can be true or false.

request_headers

Description

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

# To add an additional request header it's necessary to list all default headers too
default: &defaults
  request_headers:
    - HTTP_ACCEPT
    - HTTP_ACCEPT_CHARSET
    - HTTP_ACCEPT_ENCODING
    - HTTP_ACCEPT_LANGUAGE
    - HTTP_CACHE_CONTROL
    - HTTP_CONNECTION
    - CONTENT_LENGTH
    - PATH_INFO
    - HTTP_RANGE
    - REQUEST_METHOD
    - REQUEST_PATH
    - SERVER_NAME
    - SERVER_PORT
    - SERVER_PROTOCOL

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

default: &defaults
  request_headers: []

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

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

sidekiq_report_errors

Description

Configure the reporting of errors that occur in Sidekiq jobs.

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. Useful for custom error reporting.

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 general debug option is on as well.

working_dir_path

Description

working_directory_path

Description

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

default: &defaults
  working_directory_path: "/tmp/project_1/"