buildkite / buildkite/agent

Opentelemetry: Propegate TraceID and SpanID to steps

Aperta
#1,663 6 commenti 6 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Go
Stelle
1.1k
Fork
382
Merge medio
2g 6h
PR unite (30g)
74

Descrizione

Is your feature request related to a problem? Please describe.
The new OpenTelemetry (OTEL) experiment is helpful, but it does not make it possible to get the current traceId and spanId.

If we could get access to these, we can then link our OTEL instrumentation inside each step with the trace that exists for the whole job.

Describe the solution you'd like
Extend the existing BUILDKITE_TRACE_CONTEXT found in https://github.com/buildkite/agent/blob/848a053b3131ebced93d829c3215b31bddd19f72/tracetools/propagate.go to each step, when a tracing backend is used.

Describe alternatives you've considered
I've hacked around the codebase to enable access to TraceID and SpanID as individual variables, but the OTEL libraries are all focussed around propagating from a single trace context.

Additional context
This helps with getting a deeper understanding of what's happening over the course of a whole job. And helps with linking telemetry from each step together.

I'm willing to work on a PR up for this, if it's likely to be merged.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia leggendo tracetools/propagate.go, in particolare come viene creato e propagato BUILDKITE_TRACE_CONTEXT. Traccia il modo in cui gli step ricevono il contesto dell’ambiente quando viene utilizzato un backend di tracing; il lavoro è completato quando ogni step può accedere al contesto di trace esistente, inclusi TraceID e SpanID, per collegare la propria strumentazione OpenTelemetry.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
go
Ambito
ci-cd, observability
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
63/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.