Set transaction and span outcome in Python 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 explicitly set outcome overrides the automatic inference.

Compatibility

Requires Python agent version 2.3.1 or higher.

Set transaction outcome

atatus.set_transaction_outcome(outcome=None, http_status_code=None, override=True)

Parameter	Type	Description
outcome	String	One of `success`, `failure`, or `unknown`. An invalid value is normalized to `unknown`.
http_status_code	Integer	Optional. When `outcome` is not given, the outcome is derived from this status code (`success` if `< 500`, else `failure`).
override	Boolean	Optional. Defaults to `True`. When `False`, the outcome is set only if it is not already set.

import atatus

try:
    # ... do work ...
    atatus.set_transaction_outcome("success")
except Exception:
    atatus.set_transaction_outcome("failure")
    raise

Set span outcome

On a span, use the set_success() and set_failure() helpers on the span object returned by capture_span.

span.set_success()
span.set_failure()

from atatus import capture_span

with capture_span("cache.lookup", "cache.redis") as span:
    try:
        # ... do work ...
        span.set_success()
    except Exception:
        span.set_failure()
        raise

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 Python 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