Registo e Observabilidade
Nesta página
Registo e Observabilidade
Em produção, precisa de saber exatamente o que está a acontecer com as suas chamadas à API: latência, tokens consumidos, erros e custos. O registo estruturado e a observabilidade conferem-lhe essa visibilidade. A diferença torna-se clara no momento em que um utilizador reporta: «O assistente tem estado lento desde esta manhã». Sem instrumentação, fica limitado a conjecturas. Com ela, consegue ver em trinta segundos que a latência p95 duplicou após uma alteração no prompt que triplicou o tamanho do contexto.
Registo Estruturado Básico
Crie o hábito de medir em torno da chamada, não dentro dela. Registe o relógio antes, leia-o novamente depois e emita uma única linha que descreva todo o evento. O JSON não serve apenas para aparência: permite ao seu agregador filtrar por status, acompanhar duration_ms ao longo do tempo ou procurar um response_id específico — algo que texto em formato livre nunca consegue fazer. O bloco except produz exatamente a mesma estrutura, incluindo o tipo e a mensagem da exceção, e depois relança-a. Registar não é tratar.
import logging
import json
import time
from openai import OpenAI
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s %(levelname)s %(message)s"
)
logger = logging.getLogger("openai_api")
client = OpenAI()
def appel_avec_logging(prompt: str, model: str = "gpt-5.6-terra") -> str:
"""Chamada à API com registo estruturado completo."""
start = time.monotonic()
request_id = None
try:
response = client.responses.create(
model=model,
input=prompt
)
duree = time.monotonic() - start
logger.info(json.dumps({
"event": "api_call",
"status": "success",
"model": response.model,
"response_id": response.id,
"input_tokens": response.usage.input_tokens,
"output_tokens": response.usage.output_tokens,
"total_tokens": response.usage.total_tokens,
"duration_ms": round(duree * 1000),
"prompt_length": len(prompt),
}))
return response.output_text
except Exception as e:
duree = time.monotonic() - start
logger.error(json.dumps({
"event": "api_call",
"status": "error",
"error_type": type(e).__name__,
"error_message": str(e),
"model": model,
"duration_ms": round(duree * 1000),
"prompt_length": len(prompt),
}))
raise
resultat = appel_avec_logging("Hello!")
Repare que registamos prompt_length, e não o próprio prompt. Esta é uma escolha de design, não um descuido: o comprimento é suficiente para correlacionar com a latência, sem exportar dados do utilizador para o seu sistema de registos.
Middleware de Registo
Repetir este bloco em cada função que chama a API garante que se esquecerá dele algures. É melhor envolver o cliente de uma vez por todas. A dataclass APIMetrics define o contrato do que medimos, e ObservableClient preenche esse registo e arquiva-o, quer a chamada tenha sucesso ou falhe. O método rapport transforma depois o histórico em métricas diretamente acionáveis — taxa de sucesso, latência média, latência p95.
Esse último número é o mais importante. Uma média de 450 ms pode esconder o um em cada vinte utilizadores que espera três segundos; o p95 revela-o. Ao ordenar as durações e tomar o valor no percentil 95, descreve a experiência real dos seus utilizadores ativos mais mal servidos.
from dataclasses import dataclass, field
from typing import Optional
import time
import json
@dataclass
class APIMetrics:
"""Métricas recolhidas para cada chamada."""
model: str = ""
input_tokens: int = 0
output_tokens: int = 0
total_tokens: int = 0
duration_ms: int = 0
status: str = "unknown"
error: Optional[str] = None
response_id: Optional[str] = None
class ObservableClient:
"""Cliente OpenAI com observabilidade integrada."""
def __init__(self):
self.client = OpenAI()
self.metrics_history: list[APIMetrics] = []
def create(self, model: str, input: str, **kwargs) -> object:
start = time.monotonic()
metrics = APIMetrics(model=model)
try:
response = self.client.responses.create(
model=model,
input=input,
**kwargs
)
metrics.status = "success"
metrics.response_id = response.id
metrics.input_tokens = response.usage.input_tokens
metrics.output_tokens = response.usage.output_tokens
metrics.total_tokens = response.usage.total_tokens
metrics.duration_ms = round((time.monotonic() - start) * 1000)
self.metrics_history.append(metrics)
return response
except Exception as e:
metrics.status = "error"
metrics.error = str(e)
metrics.duration_ms = round((time.monotonic() - start) * 1000)
self.metrics_history.append(metrics)
raise
def rapport(self) -> dict:
"""Gera um relatório das métricas recolhidas."""
if not self.metrics_history:
return {"message": "No calls recorded"}
total_calls = len(self.metrics_history)
erreurs = sum(1 for m in self.metrics_history if m.status == "error")
total_tokens = sum(m.total_tokens for m in self.metrics_history)
durees = [m.duration_ms for m in self.metrics_history]
return {
"total_appels": total_calls,
"erreurs": erreurs,
"taux_succes": f"{((total_calls - erreurs) / total_calls) * 100:.1f}%",
"total_tokens": total_tokens,
"latence_moyenne_ms": round(sum(durees) / len(durees)),
"latence_p95_ms": sorted(durees)[int(len(durees) * 0.95)],
}
# Utilização
obs_client = ObservableClient()
obs_client.create("gpt-5.6-terra", "Hello!")
obs_client.create("gpt-5.6-terra", "How are you?")
obs_client.create("gpt-5.6-terra", "Thanks!")
print(json.dumps(obs_client.rapport(), indent=2))
# Resultado:
# {
# "total_appels": 3,
# "erreurs": 0,
# "taux_succes": "100.0%",
# "total_tokens": 95,
# "latence_moyenne_ms": 450,
# "latence_p95_ms": 520
# }
Rastreio de Chamadas com Contexto
Numa arquitetura distribuída, uma chamada à API nunca existe isoladamente: é acionada por um pedido HTTP, que por sua vez resulta de uma ação do utilizador, e por vezes é seguido por mais duas chamadas. O trace_id é o fio condutor que une estes eventos. Ao propagá-lo desde a sua camada web — aqui user-123-req-456 — consegue reconstruir uma sessão inteira nos seus registos a partir de uma única reclamação de cliente. São emitidas duas linhas, uma no início e outra na conclusão, o que também ajuda a detetar chamadas que nunca retornaram.
import uuid
class TracingClient:
"""Cliente com rastreio para correlacionar pedidos."""
def __init__(self):
self.client = OpenAI()
def create_with_trace(self, prompt: str, trace_id: str = None,
**kwargs) -> tuple:
"""Chamada com trace_id para correlação."""
if trace_id is None:
trace_id = str(uuid.uuid4())[:8]
start = time.monotonic()
logger.info(json.dumps({
"event": "api_request_start",
"trace_id": trace_id,
"prompt_preview": prompt[:100],
}))
response = self.client.responses.create(
model=kwargs.get("model", "gpt-5.6-terra"),
input=prompt,
**{k: v for k, v in kwargs.items() if k != "model"}
)
duration = time.monotonic() - start
logger.info(json.dumps({
"event": "api_request_complete",
"trace_id": trace_id,
"response_id": response.id,
"tokens": response.usage.total_tokens,
"duration_ms": round(duration * 1000),
}))
return response, trace_id
# Utilização com trace_id para correlacionar nos registos
tracing = TracingClient()
response, trace = tracing.create_with_trace(
"Summarize logging best practices.",
trace_id="user-123-req-456"
)
print(f"Trace: {trace} | Response: {response.output_text[:80]}...")
Tenha cuidado com prompt_preview: esses primeiros cem caracteres vão diretamente para os seus registos tal como estão. Aceitável em desenvolvimento, remova-o assim que houver dados reais a circular.
Exportação para um Sistema de Monitorização
Um histórico em memória desaparece quando o processo reinicia. Para monitorizar um serviço ao longo do tempo, precisa de expor métricas a uma ferramenta externa. O padrão universal assenta em duas famílias: contadores, que apenas aumentam e são derivados em taxas, e histogramas, que retêm uma distribuição para extrair percentis. Esta classe é intencionalmente neutra — só precisa de ligar get_metrics a um endpoint para o Prometheus recolher, ou empurrar o dicionário para o Datadog.
# Padrão para exportação para Prometheus, Datadog, etc.
class MetricsExporter:
"""Exportador de métricas compatível com sistemas de monitorização."""
def __init__(self):
self.counters = {
"api_calls_total": 0,
"api_errors_total": 0,
"tokens_consumed_total": 0,
}
self.histograms = {
"api_latency_ms": [],
}
def record_success(self, tokens: int, latency_ms: int):
self.counters["api_calls_total"] += 1
self.counters["tokens_consumed_total"] += tokens
self.histograms["api_latency_ms"].append(latency_ms)
def record_error(self):
self.counters["api_calls_total"] += 1
self.counters["api_errors_total"] += 1
def get_metrics(self) -> dict:
latencies = self.histograms["api_latency_ms"]
return {
**self.counters,
"latency_avg_ms": round(sum(latencies) / max(len(latencies), 1)),
"error_rate": self.counters["api_errors_total"] /
max(self.counters["api_calls_total"], 1),
}
exporter = MetricsExporter()
# Chame exporter.record_success() ou exporter.record_error()
# após cada chamada à API
Pontos-chave
- Registe cada chamada com: modelo, tokens, latência, estado, response_id
- Utilize JSON estruturado para registos que as suas ferramentas possam analisar
- Recolha métricas chave: taxa de sucesso, latência p95, consumo de tokens
- Adicione um
trace_idpara correlacionar pedidos em sistemas distribuídos - Exporte métricas para o seu sistema de monitorização (Prometheus, Datadog, etc.)
- Nunca registe o conteúdo do prompt em produção (dados sensíveis)