Set transaction and span outcome in Node.js APM agent

The outcome marks whether a transaction or span succeeded or failed. Atatus records one of three values (success, failure, or unknown) and infers it automatically from the HTTP status code or a captured error. For custom or non-HTTP work such as background jobs, queue consumers, database, or RPC calls, set the outcome explicitly. An outcome set through the API is frozen and is not overridden by the automatic inference.

Compatibility

Requires Node.js agent version 3.12.0 or higher.

Set transaction outcome

transaction.setOutcome(outcome)
atatus.setTransactionOutcome(outcome)

Parameter	Type	Description
outcome	String (Required)	One of `success`, `failure`, or `unknown`. Invalid values are ignored.

import atatus from "atatus-nodejs";

const transaction = atatus.startTransaction("process-order", "job");
try {
  // ... do work ...
  transaction.setOutcome("success");
} catch (err) {
  transaction.setOutcome("failure");
} finally {
  transaction.end();
}

// Or, on the current transaction:
atatus.setTransactionOutcome("failure");

Set span outcome

span.setOutcome(outcome)
atatus.setSpanOutcome(outcome)

Parameter	Type	Description
outcome	String (Required)	One of `success`, `failure`, or `unknown`.

import atatus from "atatus-nodejs";

const span = transaction.startSpan("cache.lookup");
span.setOutcome("failure");
span.end();

// Or, on the current span:
atatus.setSpanOutcome("success");

Accepted values

Value	Meaning
`success`	The operation completed successfully.
`failure`	The operation failed.
`unknown`	The outcome could not be determined. This is the default until set or inferred.

Atatus Docs

Set transaction and span outcome in Node.js APM agent

Compatibility

Set transaction outcome

Set span outcome

Accepted values

See also

​Compatibility

​Set transaction outcome

​Set span outcome

​Accepted values

​See also

Compatibility

Set transaction outcome

Set span outcome

Accepted values

See also