github / github/copilot-sdk

Telemetry: add an in-process span sink

未关闭
#2,314 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
Java
星标
10.5k
派生
1.5k
平均合并
1 天 14 小时
30 天内合并 PR
129

描述

`TelemetryConfig` supports `otlp-http` and `file`. Both send spans out of the process. If the app embedding the SDK already has an OpenTelemetry pipeline set up, there's no way to plug the CLI's spans straight into it.

Our stack is Microsoft Agent Framework on top of the Python SDK, running as an Azure AI Foundry hosted agent. The service sets up an OpenTelemetry tracer provider that exports to Azure Monitor, so host-side spans like agent invocations and tool execution land in Application Insights. The CLI's model and tool calls don't, since its spans have nowhere to go except back out over OTLP.

To get them in, we start a loopback HTTP server on an ephemeral port, point `otlp_endpoint` at it, decode the OTLP/JSON, and pass each span to the tracer provider the service already has. It works, but it's an HTTP server and a decoder just to move spans between two objects in the same process.

A sidecar collector was the other option we tried. It means a second exporter and resource to configure, and it doesn't help when running locally.

## What would help

Some way to receive the spans in-process. A callback, or an exporter instance supplied by the host:

```python
CopilotClient(telemetry={"exporter": my_span_exporter})
```

The exact API doesn't matter much to us. What we want is for the CLI's spans to go through the exporter and resource the host already has, instead of a second pipeline alongside it.

贡献指南

打开贡献指南

调研方向

Start at the Python SDK's TelemetryConfig and CopilotClient telemetry configuration, then trace the existing otlp-http and file span paths. Define how a host-supplied exporter or callback would receive spans and resources in process; done means the CLI's model and tool spans can use the host's existing OpenTelemetry pipeline without a loopback server or second exporter.

由索引模型根据 Issue 内容生成。

评估

技术栈
azure, python
领域
backend-api-design, observability
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
冷清
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。