github / github/copilot-sdk

Telemetry: add an in-process span sink

Open
#2,314 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
10.5k
Forks
1.5k
Avg merge
1d 11h
Merged PRs (30d)
127

Description

`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.

Contributor guide

Open the contributing guide

Research direction

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.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, python
Domain
backend-api-design, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.