|
| 1 | +# CI/CD Observability SIG Phase 2 |
| 2 | + |
| 3 | +<!-- TODO: Potentially create a new project board --> |
| 4 | +[**CI/CD Project Board**](https://github.com/orgs/open-telemetry/projects/79) |
| 5 | + |
| 6 | +## Overview |
| 7 | + |
| 8 | +The initial founding of the CI/CD Observability SIG produced multiple outcomes |
| 9 | +and improvements in the OpenTelemetry space. To capture a few, the group: |
| 10 | + |
| 11 | +- Created multiple foundational sets of attributes related to CI/CD in the |
| 12 | + registry across multiple versions of Semantic Conventions. |
| 13 | +- Added span attribute conventions for CI/CD pipelines. |
| 14 | +- Added metric attribute conventions around CI/CD systems. |
| 15 | +- Created the OTEP for Environment Variable Context Propagation and drove it |
| 16 | + through approval. |
| 17 | +- Based on the OTEP, updated the specification to include support with |
| 18 | + supplementary guidance. |
| 19 | +- Wrote a Python draft prototype to implement the specification. |
| 20 | +- Updated and supported the GitHub and GitLab OpenTelemetry Collector |
| 21 | + components. |
| 22 | +- Delivered multiple talks around the CI/CD SIG. |
| 23 | +- Worked with Jenkins, Team City, and OpenTofu around adoption within those |
| 24 | + technologies. |
| 25 | + |
| 26 | +There is still a lot of things to accomplish, and as such, we propose |
| 27 | +implementing phase two of the CI/CD Observability SIG. |
| 28 | + |
| 29 | +### Phase Two Goals |
| 30 | + |
| 31 | +This phase targets three core areas for immediate impact: |
| 32 | + |
| 33 | +1. **SDK Environment Variable Context Propagation**: Implement the spec across |
| 34 | + multiple OpenTelemetry languages for first class, native support. |
| 35 | + - Python |
| 36 | + - Go |
| 37 | + - C# |
| 38 | + - Javascript |
| 39 | +2. **Enhanced Signal Attribute Conventions**: Establish additional attribute |
| 40 | + conventions for CI/CD-specific trace, metrics, and logs telemetry for the |
| 41 | + following namespaces and domains: |
| 42 | + - build |
| 43 | + - deployment |
| 44 | + - issues |
| 45 | + - incidents |
| 46 | + - test |
| 47 | + - pipeline |
| 48 | +3. **Beta Stabilization**: Move core CI/CD semantic conventions and collector |
| 49 | + implementations from experimental to beta status |
| 50 | +4. **Increase Adoption**: Work towards getting one or more new technologies |
| 51 | + adoption of the OpenTelemetry conventions. |
| 52 | +5. **Stretch Goal**: Figure out how to enable better support for long running |
| 53 | + traces via [Issue #1648](https://github.com/open-telemetry/semantic-conventions/issues/1648). |
| 54 | + |
| 55 | + |
| 56 | +## Phase 2 Staffing & Responsibilities |
| 57 | + |
| 58 | +### GC Liaison |
| 59 | + |
| 60 | +* @danielgblanco (GC Liaison) |
| 61 | + |
| 62 | +### TC Sponsorship |
| 63 | + |
| 64 | +* @carlosalberto (TC Sponsor) |
| 65 | + |
| 66 | +### Phase 2 Team Structure |
| 67 | + |
| 68 | +**Project Leadership**: |
| 69 | +* @horovits Project Lead (AWS) |
| 70 | +* @adrielp Project Lead (Grainger) |
| 71 | + |
| 72 | +**Approvers**: |
| 73 | +* @open-telemetry/semconv-cicd-approvers |
| 74 | + |
| 75 | +**Project Members**: |
| 76 | +* @martincostello (Grafana Labs) |
| 77 | +* @kamphaus |
| 78 | +* @niwoerner (OllyGarden) |
| 79 | + |
| 80 | +### Phase 2 Resource Requirements |
| 81 | + |
| 82 | +**Critical Needs**: |
| 83 | +- [ ] SDK maintainer commitment for environment variable context propagation |
| 84 | + implementation |
| 85 | +- [ ] Platform integration testing resources |
| 86 | + |
| 87 | +**Success Dependencies**: |
| 88 | +- Dedicated engineering time from SDK teams (guesstimated 2-3 months per SDK) |
| 89 | +- Platform vendor collaboration for integration testing |
| 90 | +- Community feedback and early adoption validation |
| 91 | + |
| 92 | +## Meeting Times |
| 93 | + |
| 94 | +This SIG will meet weekly on Wednesdays at 06:00 PT. (Tentative) |
| 95 | + |
| 96 | +## Phase 2 Timeline |
| 97 | + |
| 98 | +**Duration**: 6 months (targeting completion by mid-2026) |
| 99 | + |
| 100 | +> Note: The timeline is aggressive but achievable with focused scope and dedicated |
| 101 | +> resources and we will continue to be agile/nimble. |
| 102 | +
|
| 103 | +## Labels |
| 104 | + |
| 105 | +* cicd |
0 commit comments