Logo of AppSignal

Menu
Docs navigation

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.

APPSIGNAL_ACTIVE / :active

  • Available since gem version 0.3.0.
  • Environment option available since gem version 0.11.6.
  • Value: Boolean true/false. Default: false

Whether AppSignal is active for this environment, can be true or false.

When the APPSIGNAL_PUSH_API_KEY environment variable is set, this defaults to true.

APPSIGNAL_APP_ENV

  • Available since gem version 0.11.8 for Rails.
  • Available since gem version 1.3.0 for Padrino.
  • Available since gem version 1.3.6 for Sinatra.
  • Available since gem version 2.0.4 standardizes the behavior for all configuration.
  • Value: String

This overrides the app's environment. Mostly used on Heroku where all apps run the production environment by default. This setting allows an override to set it to staging for example.

APPSIGNAL_APP_NAME / :name

  • Available since gem version 1.0.0.
  • Value: String

This app's display name. If you use Rails the gem will auto-detect the name and you can leave this empty. For other frameworks setting this is mandatory.

APPSIGNAL_CA_FILE_PATH / :ca_file_path

  • Available since gem version 1.3.5.
  • Value: String. Default: gem packaged cacert.pem file path.

Configure the path of the SSL certificate file. Default points to the AppSignal gem 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 an malformed path.

APPSIGNAL_DEBUG / :debug

  • Available since gem version 1.0.0.
  • Value: Boolean true/false. Default: false

Enable debug logging, this is usually only needed on request from support.

APPSIGNAL_DNS_SERVERS / :dns_servers

  • Available since gem version 2.2.0.beta.1.
  • Value: Array<String>. Default: []

Configure DNS servers for the AppSignal agent to use.

1
2
3
4
5
# config/appsignal.yml
default: &defaults
  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.

APPSIGNAL_LOG / :log

  • Available since gem version 2.0.0.
  • Value: String. Default: file

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 Ruby library supports this feature and the AppSignal agent, which is used by the Ruby library, does not yet support this.

APPSIGNAL_LOG_PATH / :log_path

  • Available since gem version 1.0.0.
  • Value: String. Default: ./log

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.

APPSIGNAL_ENABLE_ALLOCATION_TRACKING / :enable_allocation_tracking

  • Available since gem version 1.0.0.
  • Value: Boolean true/false. Default: true

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

APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING / :enable_frontend_error_catching

  • Available since gem version 1.0.0.
  • Value: Boolean true/false. Default: false

Enable the experimental frontend 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 APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH or :frontend_error_catching_path.

APPSIGNAL_ENABLE_GC_INSTRUMENTATION / :enable_gc_instrumentation

  • Available since gem version 1.0.0.
  • Value: Boolean true/false. Default: false

Set this to false to disable garbage collection instrumentation.

APPSIGNAL_ENABLE_HOST_METRICS / :enable_host_metrics

  • Available since gem version 1.2.0.
  • Value: Boolean true/false. Default: true

Set this to false to disable host metrics.

APPSIGNAL_PUSH_API_ENDPOINT / :endpoint

  • Available since gem version 0.1.0.
  • Environment variable available since gem version 1.0.0.
  • Value: String. Default: https://push.appsignal.com

Configure the endpoint to send data to AppSignal.

APPSIGNAL_FILES_WORLD_ACCESSIBLE / :files_world_accessible

  • Available since gem version 2.3.6.
  • Value: Boolean true/false. Default: true

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

APPSIGNAL_FILTER_PARAMETERS / :filter_parameters

  • Available since gem version 1.3.0.
  • Value: Array<String>. Default: []

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
4
5
6
7
# config/appsignal.yml
default: &defaults
  filter_parameters:
    - password
    - email
    - api_token
    - token

Read more about parameter filtering.

APPSIGNAL_FILTER_SESSION_DATA / :filter_session_data

  • Available since gem version 2.6.0 (upgrade to 2.6.1 is recommend).
  • Value: Array<String>. Default: []

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
4
5
6
7
# config/appsignal.yml
default: &defaults
  filter_session_data:
    - name
    - email
    - api_token
    - token

Read more about session data filtering.

APPSIGNAL_HOSTNAME / :hostname

  • Available since gem version 1.3.6.
  • Value: String. Default: detected from system.

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.

APPSIGNAL_HTTP_PROXY / :http_proxy

  • Available since gem version 0.11.13.
  • Value: String. Default: "".

If you require the agent to connect to the Internet via a proxy set the complete proxy URL in this configuration key.

APPSIGNAL_IGNORE_ACTIONS / :ignore_actions

  • Available since gem version 0.10.0.
  • Value: Array<String>. Default: [].

List of actions that will be ignored, everything that happens including exceptions will not be transmitted to AppSignal.

Read more about ignoring actions.

APPSIGNAL_IGNORE_ERRORS / :ignore_errors

  • Available since gem version 0.1.0.
  • Value: Array<String>. Default: [].

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.

APPSIGNAL_IGNORE_NAMESPACES / :ignore_namespaces

  • Available since gem version 2.3.0.
  • Value: Array<String>. Default: [].

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.

APPSIGNAL_INSTRUMENT_NET_HTTP/ :instrument_net_http

  • Available since gem version 0.9.0.
  • Value: Boolean true/false. Default: true

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

APPSIGNAL_INSTRUMENT_REDIS/ :instrument_redis

  • Available since gem version 1.0.0.
  • Value: Boolean true/false. Default: true

Whether to add instrumentation for redis queries using the Redis gem, can be true or false. Default is true.

APPSIGNAL_INSTRUMENT_SEQUEL/ :instrument_sequel

  • Available since gem version 1.0.0.
  • Value: Boolean true/false. Default: true

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

APPSIGNAL_PUSH_API_KEY / :push_api_key

  • Available since gem version 0.1.0.
  • Value: String. Default: ""

The key to authenticate with our push API.

Read more about the AppSignal Push API key.

APPSIGNAL_REQUEST_HEADERS / :request_headers

  • Available since gem version 2.6.0 (upgrade to 2.6.1 is recommend).
  • Value: Array<String>. Default: [].

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 a whitelist, 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 gem default.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# config/appsignal.yml
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_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.yml
default: &defaults
  request_headers: []

APPSIGNAL_RUNNING_IN_CONTAINER / :running_in_container

  • Available since gem version 1.0.0.
  • Value: Boolean true/false. Default: detected by Ruby gem.

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.

Since appsignal gem version 2.0 this setting is automatically detected and no manual configuration is necessary. If you're having trouble with the automatic detection, please contact support.

APPSIGNAL_SEND_PARAMS / :send_params

  • Available since gem version 0.9.0.
  • The environment variable option is available since gem version 1.3.0.
  • Value: Boolean true/false. Default: true

Whether to skip sending request parameters to AppSignal.

For more information please read about send_params in filtering request parameters.

APPSIGNAL_SKIP_SESSION_DATA / :skip_session_data

  • Available since gem version 0.11.0.
  • Value: Boolean true/false. Default: false

Whether to skip adding session data to exception traces and performance issue samples.

APPSIGNAL_WORKING_DIR_PATH / :working_dir_path

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.

  • Value: String. Default: detected by agent

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 an malformed path.

APPSIGNAL_WORKING_DIRECTORY_PATH / :working_directory_path

  • Available since gem version 2.7.0. (Please use the working_dir_path option on earlier versions.)
  • Value: String. Default: detected by agent

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.

1
2
3
# config/appsignal.yml
default: &defaults
  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.

APP_REVISION / :revision

  • Available since gem version 2.6.0 (upgrade to 2.6.1 is recommended).
  • Value: String. Default: "".

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.

We'd like to set cookies, read why.