Node.js package 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
  • apiKey
  • environment
  • name
  • pushApiKey
• Options
  • caFilePath
  • debug
  • dnsServers
  • enableHostMetrics
  • enableMinutelyProbes
  • enableStatsd
  • filesWorldAccessible
  • filterParameters
  • filterSessionData
  • hostname
  • httpProxy
  • ignoreActions
  • ignoreErrors
  • ignoreNamespaces
  • instrumentHttp
  • instrumentPg
  • instrumentRedis
  • log
  • logLevel
  • logPath
  • requestHeaders
  • revision
  • sendEnvironmentMetadata
  • sendParams
  • sendSessionData
  • workingDirectoryPath

active

Description

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

apiKey

Description

Deprecated config option. Use the pushApiKey config option instead.

environment

Description

The environment of the app to be reported to AppSignal.

name

Description

Name of your application as it should be displayed on AppSignal.com.

pushApiKey

Description

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

Read more about the AppSignal Push API key.

caFilePath

Description

Use this option to point to another certificate file if there's a problem connecting to our API.

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.

dnsServers

Description

Configure DNS servers for the AppSignal agent to use.

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 occurred while setting DNS servers.

enableHostMetrics

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.

enableMinutelyProbes

Description

Enables the minutely probes system.

enableStatsd

Description

Enables the StatsD server in the AppSignal agent.

filesWorldAccessible

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

filterParameters

Description

List of parameter keys that should be ignored using AppSignal filtering. Their values will be replaced with [FILTERED] when transmitted to AppSignal.

Read more about parameter filtering.

filterSessionData

Description

List of session data keys that should be ignored using AppSignal filtering. Their values will be replaced with [FILTERED] when transmitted to AppSignal.

Read more about session data filtering.

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.

httpProxy

Description

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

ignoreActions

Description

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

Read more about ignoring actions.

ignoreErrors

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.

ignoreNamespaces

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.

instrumentHttp

Description

Whether to enable instrumentation for HTTP requests, can be true or false. We recommend this remains enabled, because other integrations like Express, Koa.js, etc. rely on it.

instrumentPg

Description

Whether to enable instrumentation for PostgreSQL queries using the pg package, can be true or false.

instrumentRedis

Description

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

log

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.

logLevel

Description

Set the severity level of the AppSignal 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

logPath

Description

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

requestHeaders

Description

The requestHeaders config option contains a list of HTTP request headers which are read and stored by the AppSignal Node.js package.

This requestHeaders 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
8
9
10
11
12
13
client = Appsignal.new(
  // ...Other config opts
  requestHeaders: [
    "accept",
    "accept-charset",
    "accept-encoding",
    "accept-language",
    "cache-control",
    "connection",
    "content-length",
    "range"
  ]
)

To configure AppSignal to not store any HTTP request headers on AppSignal transactions, configure the option with an empty list.

1
2
3
4
client = Appsignal.new(
  // ...Other config opts
  requestHeaders: []
)

revision

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.

When using Heroku with the Heroku Labs: Dyno Metadata enabled it will automatically set the revision config option to to the HEROKU_SLUG_COMMIT system environment variable. This will automatically report new deploys when the Heroku app gets deployed. The revision can still be overwritten by setting the revision config option yourself.

Read more about deploy markers on the deploy markers.

sendEnvironmentMetadata

Description

Send environment metadata about the app.

For more information please read about environment metadata.

sendParams

Description

Whether to skip sending request parameters to AppSignal.

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

sendSessionData

Description

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

workingDirectoryPath

Description

Override the location where AppSignal for Node.js 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
4
5
6
7
// Example: appsignal.js
const { Appsignal } = require("@appsignal/nodejs");

const appsignal = new Appsignal({
  // Other config
  workingDirectoryPath: "/tmp/project_1"
});