Skip to content

Commit c5ffc6f

Browse files
adrielpniwoernermartincostello
authored
[cicd] add phase 2 proposal for the CICD SIG (#2884)
* [cicd] add phase 2 proposal for the CICD SIG * chore: updates * [chore] updates based on feedback * [chore] changes from pr feedback * [chore] update tc sponsors * Update projects/ci-cd-phase-2.md Co-authored-by: Nicolas <[email protected]> * Update projects/ci-cd-phase-2.md Co-authored-by: Martin Costello <[email protected]> * chore: small adjustment with company --------- Co-authored-by: Nicolas <[email protected]> Co-authored-by: Martin Costello <[email protected]>
1 parent 55c5835 commit c5ffc6f

File tree

2 files changed

+116
-11
lines changed

2 files changed

+116
-11
lines changed

projects/ci-cd-phase-2.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
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

projects/ci-cd.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -137,22 +137,22 @@ Estimated time-frame: 6-12 Months
137137
- [x] Semantic Conventions
138138
- [x] Specifications
139139
- [ ] Prototype Developments
140-
- [ ] Q3 TBD
141-
- [ ] (cont) Semantic Conventions
142-
- [ ] More Registry Additions
143-
- [ ] Signal specific conventions
144-
- [ ] (cont) Prototype Development
145-
- [ ] OTEP Environment Variable Specification Approval
146-
- [ ] Q4 TBD
147-
- [ ] (cont) Semantic Conventions
140+
- [x] Q3 TBD
141+
- [x] (cont) Semantic Conventions
142+
- [x] More Registry Additions
143+
- [x] Signal specific conventions
144+
- [x] (cont) Prototype Development
145+
- [x] OTEP Environment Variable Specification Approval
146+
- [x] Q4 TBD
147+
- [x] (cont) Semantic Conventions
148148
- [ ] Registry Stability Updates
149149
- [ ] (cont) Signal specific conventions
150-
- [ ] Environment Variable Specification Updated and Released
151-
- [ ] Determine next steps for 2025
150+
- [x] Environment Variable Specification Updated and Released
151+
- [x] Determine next steps for 2025
152152

153153
### 2025
154154

155-
- [ ] TBD
155+
- [x] Propose phase 2 of the CICD SIG
156156

157157
> Note: The SIG's intent is to be nimble and able to adjust quickly.
158158

0 commit comments

Comments
 (0)