AppSignal for JavaScript 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, see our Configuration topic.

`key`

Type: string

This configuration option is required to send data to AppSignal. If this configuration option is not set, AppSignal for JavaScript will run in development mode, and no data will be sent to AppSignal.

The front-end error monitoring API key for your application. You can find this API key under “Front-end error monitoring” in the “Push & Deploy” section of your application’s settings. This is not the same as the organization-level or application-level API key, which is used for monitoring in our back-end integrations.

`namespace`

Type: string
Default value: "frontend"

The default namespace to use to report errors to AppSignal. Read more in our namespaces guide.

`revision`

Type: string

Set the app revision for the currently running version of your app. This is used to create deploy markers and tag all incoming data as belonging to a specific deploy. Use a single value without spaces, such as a Git commit SHA (abc0123) or a version number (1.2.3). Read more about deploy markers and choosing a revision value.

`ignoreErrors`

Type: RegExp[]

An array of regular expressions to check against the message property of any error reported to AppSignal. If any of the regular expressions matches, the error is ignored. Read more in our ignoring errors guide.

`matchBacktracePaths`

Type: RegExp | Function | (RegExp | Function)[]

This configuration option is useful when developing applications for desktop and mobile environments, or when deploying the same application environment to multiple domains. Most applications will not need to use this configuration option.Using this configuration option will break public sourcemap detection. To use this configuration option with a sourcemapped codebase, you must upload private sourcemaps for your application.This configuration option is experimental and may change in future versions.

A regular expression, a function, or an array of one or more regular expressions or functions. Regular expressions need one or more match groups. These regular expressions will be checked against the backtrace line paths of errors reported to AppSignal. If any of the regular expressions matches with one or more non-empty match groups, the path in the backtrace line is replaced with the result of concatenating the match groups. Functions must take a string as an argument and return a string or undefined. These functions will be called with the backtrace line paths of errors reported to AppSignal. If a non-empty string is returned by any of the functions, the path in the backtrace line is replaced with the returned string. This is useful when the path at which your application is deployed is not known ahead of time. For example, the path to an Electron application may be different on each user’s machine. You can match for the part of that path that is known to represent your application. For example, if your application’s source code is located at a path like the following, where ${USERNAME} changes for each user:

/Users/${USERNAME}/Applications/MyApp.app/Contents/Resources/bundle/app.js

Then you can use this configuration option as follows:

const appsignal = new Appsignal({
  // ... other configuration options ...
  matchBacktracePaths: [new RegExp("MyApp.app/Contents/Resources/(.*)")],
});

When an error is reported, the backtrace line paths will be replaced with the result of the match group, which in this example will be bundle/app.js. This ensures that errors reported to AppSignal are grouped correctly when using backtrace line grouping, and allows for private sourcemaps to be uploaded for the cleaned path.

Matching with a function

Use a function to replace the whole path with a name you choose. For example, an Expo app’s bundle path ends in a hash that changes on every device and every update:

/data/user/0/com.example.myapp/files/.expo-internal/0123456789abcdef0123456789abcdef

You can’t upload a sourcemap under a name that keeps changing. The following function renames the path to index.android.bundle on Android and index.ios.bundle on iOS. You then upload each platform’s sourcemap under that name.

import { Platform } from "react-native";

const appsignal = new Appsignal({
  // ... other configuration options ...
  matchBacktracePaths: [
    (path) => {
      if (path.includes("/.expo-internal/")) {
        return `index.${Platform.OS}.bundle`;
      }
    },
  ],
});

For a complete mobile setup, see AppSignal for JavaScript with React Native and Expo.

SDKs & telemetry

Language SDKs

Telemetry tools

AppSignal for JavaScript configuration options

`key`

`namespace`

`revision`

`ignoreErrors`

`matchBacktracePaths`

Matching with a function

​key

​namespace

​revision

​ignoreErrors

​matchBacktracePaths

​Matching with a function

`key`

`namespace`

`revision`

`ignoreErrors`

`matchBacktracePaths`

Matching with a function