트레이싱

Agents SDK에는 기본 제공 트레이싱 기능이 포함되어 있어 에이전트 실행 중 발생하는 이벤트의 포괄적인 기록을 수집합니다. 여기에는 LLM 생성, 도구 호출, 핸드오프, 가드레일은 물론 발생하는 사용자 지정 이벤트까지 포함됩니다. 트레이스 대시보드를 사용하면 개발 및 프로덕션 환경에서 워크플로를 디버깅하고 시각화하며 모니터링할 수 있습니다.

Note

트레이싱은 기본적으로 활성화되어 있습니다. 다음 세 가지 일반적인 방법으로 비활성화할 수 있습니다.

환경 변수 OPENAI_AGENTS_DISABLE_TRACING=1을 설정하여 트레이싱을 전역적으로 비활성화할 수 있습니다.
코드에서 set_tracing_disabled(True)을 사용하여 트레이싱을 전역적으로 비활성화할 수 있습니다.
agents.run.RunConfig.tracing_disabled를 True으로 설정하여 단일 실행의 트레이싱을 비활성화할 수 있습니다.

Zero Data Retention(ZDR) 정책에 따라 OpenAI API를 사용하는 조직에서는 트레이싱을 사용할 수 없습니다.

트레이스와 스팬

트레이스는 단일 "워크플로"의 시작부터 끝까지 이어지는 작업을 나타냅니다. 트레이스는 여러 스팬으로 구성되며 다음 속성을 가집니다.
- workflow_name: 논리적 워크플로 또는 앱의 이름입니다. 예를 들면 "코드 생성" 또는 "고객 서비스"입니다.
- trace_id: 트레이스의 고유 ID입니다. 전달하지 않으면 자동으로 생성됩니다. 형식은 trace_<32_alphanumeric>이어야 합니다.
- group_id: 동일한 대화의 여러 트레이스를 연결하는 선택적 그룹 ID입니다. 예를 들어 채팅 스레드 ID를 사용할 수 있습니다.
- disabled: True이면 트레이스가 기록되지 않습니다.
- metadata: 트레이스의 선택적 메타데이터입니다.
스팬은 시작 및 종료 시간이 있는 작업을 나타냅니다. 스팬에는 다음 항목이 있습니다.
- started_at 및 ended_at 타임스탬프
- 해당 스팬이 속한 트레이스를 나타내는 trace_id
- 이 스팬의 상위 스팬이 있는 경우 이를 가리키는 parent_id
- 스팬에 관한 정보인 span_data. 예를 들어 AgentSpanData에는 에이전트 정보가, GenerationSpanData에는 LLM 생성 정보 등이 포함됩니다.

기본 트레이싱

SDK는 기본적으로 다음 항목을 트레이싱합니다.

전체 Runner.{run, run_sync, run_streamed}()은 trace()으로 래핑됩니다.
각 러너 호출은 task_span()으로 래핑됩니다.
각 모델 턴은 turn_span()으로 래핑됩니다.
에이전트가 실행될 때마다 agent_span()으로 래핑됩니다.
LLM 생성은 generation_span()으로 래핑됩니다.
각 함수 도구 호출은 function_span()으로 래핑됩니다.
가드레일은 guardrail_span()으로 래핑됩니다.
핸드오프는 handoff_span()로 래핑됩니다.
오디오 입력(음성 텍스트 변환)은 transcription_span()으로 래핑됩니다.
오디오 출력(텍스트 음성 변환)은 speech_span()로 래핑됩니다.
SDK는 관련 오디오 스팬을 speech_group_span() 아래에 배치할 수 있습니다.

기본 트레이스 이름은 리터럴 문자열 Agent workflow입니다. trace을 사용하는 경우 이 이름을 설정할 수 있으며, RunConfig을 사용하여 이름과 기타 속성을 구성할 수도 있습니다.

더 간결한 계층 구조가 필요하다면 해당 실행에서 자동 작업 및 턴 스팬을 비활성화하세요. 에이전트, 생성, 함수, 가드레일, 핸드오프 및 사용자 지정 스팬은 계속 기록됩니다.

from agents import RunConfig, Runner

result = await Runner.run(
    agent,
    "Hello",
    run_config=RunConfig(tracing={"include_task_and_turn_spans": False}),
)

또한 사용자 지정 트레이싱 프로세서를 설정하여 트레이스를 다른 대상으로 전송할 수 있습니다. 기존 대상을 대체하거나 보조 대상으로 사용할 수 있습니다.

장기 실행 워커와 즉시 내보내기

기본 BatchTraceProcessor는 몇 초마다 백그라운드에서 트레이스를 내보내며, 인메모리 큐가 크기 트리거에 도달하면 더 일찍 내보냅니다. 또한 프로세스가 종료될 때 최종 플러시를 수행합니다. Celery, RQ, Dramatiq 또는 FastAPI 백그라운드 작업과 같은 장기 실행 워커에서는 별도의 코드 없이도 일반적으로 트레이스가 자동으로 내보내지지만, 각 작업이 완료된 직후에는 트레이스 대시보드에 표시되지 않을 수 있습니다.

작업 단위가 끝날 때 즉시 전달되는 것을 보장해야 한다면 트레이스 컨텍스트가 종료된 후 flush_traces()을 호출하세요.

from agents import Runner, flush_traces, trace


@celery_app.task
def run_agent_task(prompt: str):
    try:
        with trace("celery_task"):
            result = Runner.run_sync(agent, prompt)
        return result.final_output
    finally:
        flush_traces()

from fastapi import BackgroundTasks, FastAPI
from agents import Runner, flush_traces, trace

app = FastAPI()


def process_in_background(prompt: str) -> None:
    try:
        with trace("background_job"):
            Runner.run_sync(agent, prompt)
    finally:
        flush_traces()


@app.post("/run")
async def run(prompt: str, background_tasks: BackgroundTasks):
    background_tasks.add_task(process_in_background, prompt)
    return {"status": "queued"}

flush_traces()은 현재 버퍼링된 트레이스와 스팬을 내보낼 때까지 실행을 차단합니다. 따라서 일부만 생성된 트레이스를 플러시하지 않도록 trace()가 닫힌 후 호출하세요. 기본 내보내기 지연 시간이 허용 가능한 경우에는 이 호출을 생략할 수 있습니다.

상위 수준 트레이스

여러 run() 호출을 단일 트레이스에 포함해야 하는 경우가 있습니다. 전체 코드를 trace()으로 래핑하면 됩니다.

from agents import Agent, Runner, trace

async def main():
    agent = Agent(name="Joke generator", instructions="Tell funny jokes.")

    with trace("Joke workflow"): # (1)!
        first_result = await Runner.run(agent, "Tell me a joke")
        second_result = await Runner.run(agent, f"Rate this joke: {first_result.final_output}")
        print(f"Joke: {first_result.final_output}")
        print(f"Rating: {second_result.final_output}")

두 Runner.run 호출이 with trace()으로 래핑되므로, 각 실행이 별도의 트레이스를 생성하지 않고 두 실행 모두 하나의 전체 트레이스에 포함됩니다.

트레이스 생성

trace() 함수를 사용하여 트레이스를 생성할 수 있습니다. 트레이스는 시작하고 종료해야 합니다. 다음 두 가지 방법을 사용할 수 있습니다.

권장: 트레이스를 컨텍스트 관리자로 사용합니다. 즉, with trace(...) as my_trace을 사용합니다. 그러면 적절한 시점에 트레이스가 자동으로 시작되고 종료됩니다.
trace.start() 및 trace.finish()를 직접 호출할 수도 있습니다.

현재 트레이스는 Python contextvar를 통해 추적됩니다. 따라서 동시성 환경에서도 자동으로 작동합니다. 트레이스를 직접 시작하고 종료하는 경우 현재 트레이스를 업데이트하려면 mark_as_current를 start()에 전달하고 reset_current을 finish()에 전달하세요.

스팬 생성

다양한 *_span() 메서드를 사용하여 스팬을 생성할 수 있습니다. 일반적으로 스팬을 직접 생성할 필요는 없습니다. 사용자 지정 스팬 정보를 추적할 수 있도록 custom_span() 함수가 제공됩니다.

스팬은 자동으로 현재 트레이스에 포함되며 가장 가까운 현재 스팬 아래에 중첩됩니다. 현재 스팬은 Python contextvar를 통해 추적됩니다.

민감한 데이터

일부 스팬은 잠재적으로 민감한 데이터를 캡처할 수 있습니다.

generation_span()에는 LLM 생성의 입력/출력이 저장되고, function_span()에는 함수 호출의 입력/출력이 저장됩니다. 여기에는 민감한 데이터가 포함될 수 있으므로 RunConfig.trace_include_sensitive_data를 통해 해당 데이터의 캡처를 비활성화할 수 있습니다.

마찬가지로 오디오 스팬에는 기본적으로 입력 및 출력 오디오의 Base64 인코딩 PCM 데이터가 포함됩니다. VoicePipelineConfig.trace_include_sensitive_audio_data를 구성하여 이 오디오 데이터의 캡처를 비활성화할 수 있습니다.

기본적으로 trace_include_sensitive_data은 True입니다. 앱을 실행하기 전에 OPENAI_AGENTS_TRACE_INCLUDE_SENSITIVE_DATA 환경 변수를 true/1 또는 false/0으로 내보내면 코드 없이 기본값을 설정할 수 있습니다.

사용자 지정 트레이싱 프로세서

트레이싱의 상위 수준 아키텍처는 다음과 같습니다.

초기화 시 트레이스 생성을 담당하는 전역 TraceProvider를 생성합니다.
TraceProvider에 BatchTraceProcessor를 구성합니다. 이 프로세서는 트레이스와 스팬을 BackendSpanExporter로 일괄 전송하며, 해당 익스포터는 스팬과 트레이스를 OpenAI 백엔드로 일괄 내보냅니다.

이 기본 설정을 사용자 지정하여 트레이스를 대체 또는 추가 백엔드로 전송하거나 익스포터 동작을 수정하려면 다음 두 가지 방법을 사용할 수 있습니다.

add_trace_processor()을 사용하면 준비된 트레이스와 스팬을 수신할 추가 트레이스 프로세서를 등록할 수 있습니다. 이를 통해 트레이스를 OpenAI 백엔드로 전송하는 동시에 자체 처리를 수행할 수 있습니다.
set_trace_processors()을 사용하면 기본 프로세서를 자체 트레이스 프로세서로 교체할 수 있습니다. 이 경우 이를 수행하는 TracingProcessor을 포함하지 않는 한 트레이스가 OpenAI 백엔드로 전송되지 않습니다.

비 OpenAI 모델을 사용한 트레이싱

비 OpenAI 모델을 사용할 때 트레이싱 익스포터에 OpenAI API 키를 제공하면 트레이싱을 비활성화하지 않고도 OpenAI 트레이스 대시보드에서 무료 트레이싱을 사용할 수 있습니다. 어댑터 선택 및 설정 시 주의 사항은 모델 가이드의 서드 파티 어댑터 섹션을 참조하세요.

import os
from agents import set_tracing_export_api_key, Agent
from agents.extensions.models.any_llm_model import AnyLLMModel

tracing_api_key = os.environ["OPENAI_API_KEY"]
set_tracing_export_api_key(tracing_api_key)

model = AnyLLMModel(
    model="your-provider/your-model-name",
    api_key="your-api-key",
)

agent = Agent(
    name="Assistant",
    model=model,
)

단일 실행에만 다른 트레이싱 키가 필요하다면 전역 익스포터를 변경하는 대신 RunConfig을 통해 전달하세요.

from agents import Runner, RunConfig

await Runner.run(
    agent,
    input="Hello",
    run_config=RunConfig(tracing={"api_key": "sk-tracing-123"}),
)

추가 참고 사항

OpenAI 트레이스 대시보드에서 무료 트레이스를 확인할 수 있습니다.

에코시스템 통합

다음 커뮤니티 및 벤더 통합은 OpenAI Agents SDK의 트레이싱 API 인터페이스를 지원합니다.