Node.js package configuration options

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

Read more about the AppSignal Push API key.

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

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.

Allows you to denylist the automatic instrumentation of default integrations:

• @opentelemetry/instrumentation-express
• @opentelemetry/instrumentation-fastify
• @opentelemetry/instrumentation-fs
• @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
• @prisma/instrumentation

To disable all instrumentations, set option to true.

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.

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.

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.

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.

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

Read more about ignoring actions.

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.

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

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

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.

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

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

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: []
)

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 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 or Render by manually setting the revision config option to a custom value.

Read more about deploy markers on the deploy markers.

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.

Send environment metadata about the app.

For more information please read about environment metadata.

Whether to skip sending request parameters to AppSignal.

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

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"
});