Set Transaction Name

The current transaction name is used to group transactions in our Performance product, as well as annotate error events with their point of failure.

The transaction name can reference the current web app route, or the current task being executed. For example:

  • GET /api/{version}/users/
  • UserListView
  • myapp.tasks.renew_all_subscriptions

Ideally, the transaction name does not contain variable values such as user IDs but has rather low cardinality while still uniquely identifying a piece of code you care about.

A lot of our framework integrations already set a transaction name, though you can set one yourself.

You'll first need to import the SDK, as usual:

import * as Sentry from "@sentry/node";

To override the name of the currently running transaction:

Sentry.configureScope(scope => scope.setTransactionName("UserListView"));

Please refer to the tracing documentation for how to start and stop transactions.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").