posit-dev / posit-dev/team-operator

team-operator: Add OpenTelemetry tracing

Open
#133 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement observability
Dominant language
Go
Stars
10
Forks
1
Avg merge
1d 8h
Merged PRs (30d)
4

Description

Summary

Add OTel traces for Reconcile calls, with operator-rooted spans, optional inbound trace context propagation via annotation, and outbound trace IDs surfaced in CR status.

Acceptance Criteria

  • One root span per Reconcile; Site reconciler emits child spans for each sub-dispatcher
  • .status.observability.lastTraceID populated on errors and meaningful changes
  • Optional posit.co/traceparent annotation parsed as an OTel Link if present
  • Default off (--observability-traces-enabled=false); flag flip enables
  • Active span's trace_id injected into existing zap log fields

Design: https://github.com/posit-dev/team-operator/issues/7#issuecomment-4379428412 (Phase 3 section)

Phase 3 of three. Phase 1: #7. Phase 2: #132.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Phase 3 section of the linked design, then inspect the Reconcile and Site reconciler entry points. Trace how the observability flag, CR status, annotations, and existing zap log fields are handled. Done means every listed acceptance criterion is met, including default-off behavior and trace IDs on errors and meaningful changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kubernetes
Domain
infrastructure, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.