feat: add OpenTelemetry tracing support for CI/CD observability

Chiusa
  • Qualcosa non va?
#364 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
go
Ambito
cli, distributed-systems, observability

Direzione di ricerca

Inizia leggendo cmd/root.go e il codice dei connector sotto pkg/connectors, quindi esamina l’entry point proposto pkg/observability/tracing.go e i requisiti di strumentazione HTTP di OTel. Il lavoro è completo quando il tracing è opt-in tramite OTEL_EXPORTER_OTLP_ENDPOINT, le operazioni di test, poll e upload elencate emettono span, le richieste in uscita trasportano header traceparent e il comportamento esistente rimane invariato quando la variabile è assente.

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

Descrizione

Reason/Context

When microcks test fails in a CI/CD pipeline, platform engineers have no way to correlate the CLI execution with what happened on the Microcks server or the API under test. The CLI is a complete black box — no trace context, no span data, no correlation IDs in logs.

Modern platform teams run observability stacks (Grafana/Tempo, Jaeger, Datadog) and expect every tool in their pipeline to emit trace context. Without it, debugging a failed API test requires manually cross-referencing timestamps across multiple systems.

Since Microcks is a CNCF Sandbox project, adding OTel tracing aligns directly with CNCF's observability principles and makes Microcks significantly more attractive to enterprise platform teams who already run OTel collectors in their infrastructure.

Description

Add opt-in OpenTelemetry (OTel) distributed tracing to microcks-cli so engineers can trace a full test lifecycle from CLI invocation → Microcks server → target API endpoint.

Activation: via standard OTel environment variable — OTEL_EXPORTER_OTLP_ENDPOINT=http://collector:4317

  • If the env var is absent → zero overhead, zero behavior change, no new output
  • If set → CLI initializes an OTLP exporter and emits spans for key operations

Spans emitted:

  • microcks.test.create — when a test result is created on the server
  • microcks.test.poll — each polling iteration waiting for test completion
  • microcks.import.upload — when an artifact is uploaded

W3C Trace Context: injects traceparent headers into all outgoing HTTP requests so the Microcks server can participate in the same trace.

This is a non-breaking change. Fully opt-in via environment variable. Existing users see zero difference unless they explicitly set the OTLP endpoint.

Implementation ideas

New package pkg/observability/tracing.go — initializes the OTel provider and returns a shutdown function:

func InitTracer(serviceName string) (func(context.Context) error, error) {
    // reads OTEL_EXPORTER_OTLP_ENDPOINT from env
    // returns no-op tracer if unset
}

Wire into `cmd/root.go` PersistentPreRun — initialize once, shutdown in PersistentPostRun.

Wrap the HTTP client in `pkg/connectors/` using `otelhttp.NewTransport`:

Dependencies to add:
- go.opentelemetry.io/otel (CNCF graduated project)
- go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Fully opt-in — no Kubernetes or external collector required. Works with any OTLP-compatible backend (Jaeger, Tempo, Datadog). Happy to implement if the approach looks good.
Lingua principale
Go
Stelle
59
Fork
75
Merge medio
4g 5h
PR unite (30g)
15

Preparare l'ambiente

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.

Altre issue di microcks/microcks-cli

Tutte le issue di microcks/microcks-cli

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.