FAQ

Heroku

Scout runs on Heroku without any special configuration. When Scout detects that an app is being served via Heroku:

Configuration

Scout can be configured via environment variables. This means you can use heroku config:set to configure the agent. For example, you can set the application name that appears in the Scout UI with:

heroku config:set SCOUT_NAME='My Heroku App'

See the configuration section for more information on the available config settings and environment variable functionality.

Using the Scout Heroku Add-on

Scout is also available as a Heroku Add-on. The add-on automates setting the proper Heroku config variables during the provisioning process.

Docker

Scout runs within Docker containers without any special configuration.

However, it may be easier to dockerize the core-agent. We suggest using our Docker image for this.

Transactions

What is a transaction

A transaction is anytime that you application handles a request or runs a background job. To get a better understanding of your transaction volume, visit your usage page for more info

Ignoring Transactions

Note: When a transaction is ignored, we will not collect metric data or traces for the request. When ignoring transactions and using sampling, data may be skewed and important traces may be missed.

If you don’t want to track the current transaction, at any point you can call scout.api.ignoreTransaction() to ignore it:

const scout = require("@scout_apm/scout-apm");

if (isHealthCheck) {
  scout.api.ignoreTransaction_transaction()
}

You can use this whether the transaction was started from a built-in integration or custom instrumentation.

You can also ignore a set of URL path prefixes by configuring the ignore setting in your ScoutConfiguration:

scout.buildScoutConfiguration({
  ignore: ["/health-check/", "/admin/"],
});

When specifying this as an environment variable, it should be a comma-separated list:

export SCOUT_IGNORE='/health-check/,/admin/'