github / github/copilot-sdk

Telemetry: add an in-process span sink

Ouverte
#2,314 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement
Langage dominant
Java
Étoiles
10.5k
Forks
1.5k
Merge moyen
1 j 11 h
PR mergées (30 j)
128

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
azure, python
Domaine
backend-api-design, observability
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.