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
  • environment
  • name
  • pushApiKey
• Options
  • additionalInstrumentations
  • bindAddress
  • caFilePath
  • cpuCount
  • debug
  • disableDefaultInstrumentations
  • dnsServers
  • enableHostMetrics
  • enableMinutelyProbes
  • enableNginxMetrics
  • enableOpentelemetryHttp
  • enableStatsd
  • filesWorldAccessible
  • filterParameters
  • filterSessionData
  • hostname
  • hostRole
  • httpProxy
  • ignoreActions
  • ignoreErrors
  • ignoreLogs
  • ignoreNamespaces
  • log
  • logLevel
  • logPath
  • opentelemetry_port
  • requestHeaders
  • revision
  • runningInContainer
  • sendEnvironmentMetadata
  • sendParams
  • sendSessionData
  • statsdPort
  • workingDirectoryPath

active

Description

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

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.

additionalInstrumentations

Description

List of additional OpenTelemetry instrumentations to use with AppSignal, via third-party libraries or your own integrations.

bindAddress

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

caFilePath

Description

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

cpuCount

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.

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.

disableDefaultInstrumentations

Description

Allows you to disable the automatic instrumentation of default integrations:

• @appsignal/opentelemetry-instrumentation-bullmq
• @opentelemetry/instrumentation-amqplib
• @opentelemetry/instrumentation-express
• @opentelemetry/instrumentation-fastify
• @opentelemetry/instrumentation-graphql
• @opentelemetry/instrumentation-http
• @opentelemetry/instrumentation-ioredis
• @opentelemetry/instrumentation-knex
• @opentelemetry/instrumentation-koa
• @opentelemetry/instrumentation-mongodb
• @opentelemetry/instrumentation-mongoose
• @opentelemetry/instrumentation-mysql2
• @opentelemetry/instrumentation-mysql
• @opentelemetry/instrumentation-nestjs-core
• @opentelemetry/instrumentation-pg
• @opentelemetry/instrumentation-redis
• @opentelemetry/instrumentation-redis-4
• @opentelemetry/instrumentation-restify
• @opentelemetry/instrumentation-undici
• @prisma/instrumentation

To disable all instrumentations, set the value to true.

dnsServers

Description

Configure DNS servers for the AppSignal agent to use.

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

enableNginxMetrics

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.

enableOpentelemetryHttp

Description

Set this option to true to enable the OpenTelemetry HTTP server.

When enabled, the AppSignal agent will listen to a localhost-bound server on port 8099. If you're running several AppSignal-instrumented applications in the same server, this configuration option can only be enabled in one of them.

This is required for apps using the OpenTelemetry HTTP exporter to report data to AppSignal.

enableStatsd

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.

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.

hostRole

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.

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.

ignoreLogs

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.

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.

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.

logLevel

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

logPath

Description

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

opentelemetry_port

Description

Set this option to configure the OpenTelemetry 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.

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.

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.

client = Appsignal.new(
  // ...Other config opts
  requestHeaders: []
)

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 on the deploy markers.

runningInContainer

Description

AppSignal expects to be running on the same machine between different deploys. Set this key to true if the application or agent 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.

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.

statsdPort

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.

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.

// Example: appsignal.js
const { Appsignal } = require("@appsignal/nodejs");
 
const appsignal = new Appsignal({
  // Other config
  workingDirectoryPath: "/tmp/project_1"
});