Wrap functions with observe

SDK 0.4.0 observe in atlanai SDK traces a function without restructuring it, and handles sync functions, async functions, and generators. Use it when you want a span per function call with input and output captured automatically. To control the span yourself, use Create spans for agent run.

Before you begin

Before you start, make sure you have:

SDK: atlanai SDK installed with tracing, as in Install atlanai SDK.
Tracing: init configured and exporting, as in Trace first agent run.

Wrap function

Decorate a function in Python, or wrap it in TypeScript. The span name comes from the function unless you set name, and the observation type defaults to task.

Python
TypeScript

from atlanai.tracing import observe

@observe(as_type="tool")
def search_docs(query: str) -> list[str]:
    return index.search(query)

@observe  # bare form: as_type is "task", name is the function name
async def plan(goal: str) -> str:
    ...

import { observe } from "@atlanai/sdk/tracing";

const searchDocs = observe(
  (query: string) => index.search(query),
  { asType: "tool", name: "search_docs" },
);

Limit captured payload

Input and output are captured by default. Turn either off per function when the payload is large or sensitive.

Python
TypeScript

@observe(as_type="tool", capture_input=False, capture_output=False)
def lookup_customer(email: str) -> dict:
    ...

const lookupCustomer = observe(fetchCustomer, {
  asType: "tool",
  captureInput: false,
  captureOutput: false,
});

For one rule across every span, use trace_content instead, as in Control trace privacy.

Verify span

Call the function, flush, and open the trace in Agent Registry. Confirm a span named for the function with the expected type, and input and output present unless you turned them off.If no trace appears, see init() disables tracing and no traces are exported.

Troubleshooting

If traces do not appear, see Install and setup errors.

Next steps

Group runs into sessions: tie spans to a session, user, and tags.

Import traces

Attribute runs

Troubleshoot

Before you begin

Troubleshooting

Next steps

See also

​Before you begin

​Troubleshooting

​Next steps

​See also

Before you begin

Troubleshooting

Next steps

See also