Skip to content

Commit 0a4cccc

Browse files
committed
update KEP-2831
Signed-off-by: Sally O'Malley <somalley@redhat.com>
1 parent 475b18a commit 0a4cccc

File tree

3 files changed

+34
-65
lines changed

3 files changed

+34
-65
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
kep-number: 2831
22
alpha:
33
approver: "@ehashman"
4+
beta:
5+
approver: "@ehashman"
46

keps/sig-instrumentation/2831-kubelet-tracing/README.md

Lines changed: 27 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,16 @@
4343

4444
Items marked with (R) are required *prior to targeting to a milestone / release*.
4545

46-
- [ ] (R) Enhancement issue in release milestone, which links to KEP dir in [kubernetes/enhancements] (not the initial KEP PR)
47-
- [ ] (R) KEP approvers have approved the KEP status as `implementable`
48-
- [ ] (R) Design details are appropriately documented
49-
- [ ] (R) Test plan is in place, giving consideration to SIG Architecture and SIG Testing input
50-
- [ ] (R) Graduation criteria is in place
51-
- [ ] (R) Production readiness review completed
52-
- [ ] Production readiness review approved
53-
- [ ] "Implementation History" section is up-to-date for milestone
54-
- [ ] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
55-
- [ ] Supporting documentation—e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
46+
- [X] (R) Enhancement issue in release milestone, which links to KEP dir in [kubernetes/enhancements] (not the initial KEP PR)
47+
- [X] (R) KEP approvers have approved the KEP status as `implementable`
48+
- [X] (R) Design details are appropriately documented
49+
- [X] (R) Test plan is in place, giving consideration to SIG Architecture and SIG Testing input
50+
- [X] (R) Graduation criteria is in place
51+
- [X] (R) Production readiness review completed
52+
- [X] Production readiness review approved
53+
- [X] "Implementation History" section is up-to-date for milestone
54+
- [X] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
55+
- [X] Supporting documentation—e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
5656

5757
## Summary
5858

@@ -140,6 +140,14 @@ to generate spans for sampled incoming requests and propagate context with clien
140140

141141
OpenTelemetry-Go provides the [propagation package](https://github.com/open-telemetry/opentelemetry-go/blob/main/propagation/propagation.go) with which you can add custom key-value pairs known as [baggage](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/baggage/api.md). Baggage data will be propagated across services within contexts.
142142

143+
### Connected Traces with Nested Spans
144+
145+
Nested spans with top-level traces in the kubelet will connect CRI calls together. Nested spans will be created for the following:
146+
* Sync Loops (e.g. syncPod, eviction manager, various gc routines) where the kubelet initiates new work.
147+
* [top-level traces for pod sync and GC](https://github.com/kubernetes/kubernetes/pull/114504)
148+
* Incoming requests (exec, attach, port-forward, metrics endpoints, podresources)
149+
* Outgoing requests (CNI, CSI, device plugin, k8s API calls)
150+
143151
### Running the OpenTelemetry Collector
144152

145153
Although this proposal focuses on running the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector), note that any
@@ -187,90 +195,47 @@ type TracingConfiguration struct {
187195

188196
### Test Plan
189197

190-
<!--
191-
**Note:** *Not required until targeted at a release.*
192-
The goal is to ensure that we don't accept enhancements with inadequate testing.
193-
All code is expected to have adequate tests (eventually with coverage
194-
expectations). Please adhere to the [Kubernetes testing guidelines][testing-guidelines]
195-
when drafting this test plan.
196-
[testing-guidelines]: https://git.k8s.io/community/contributors/devel/sig-testing/testing.md
197-
-->
198-
199198
[x] I/we understand the owners of the involved components may require updates to
200199
existing tests to make this code solid enough prior to committing the changes necessary
201200
to implement this enhancement.
202201

203202
##### Prerequisite testing updates
204203

205-
<!--
206-
Based on reviewers feedback describe what additional tests need to be added prior
207-
implementing this enhancement to ensure the enhancements have also solid foundations.
208-
-->
209-
210204
An integration test will verify that spans exported by the kubelet match what is
211205
expected from the request. We will also add an integration test that verifies
212206
spans propagated from kubelet to API server match what is expected from the request.
213207

214208
##### Unit tests
215209

216-
<!--
217-
In principle every added code should have complete unit test coverage, so providing
218-
the exact set of tests will not bring additional value.
219-
However, if complete unit test coverage is not possible, explain the reason of it
220-
together with explanation why this is acceptable.
221-
-->
222-
223-
<!--
224-
Additionally, for Alpha try to enumerate the core package you will be touching
225-
to implement this enhancement and provide the current unit coverage for those
226-
in the form of:
227-
- <package>: <date> - <current test coverage>
228-
The data can be easily read from:
229-
https://testgrid.k8s.io/sig-testing-canaries#ci-kubernetes-coverage-unit
230-
This can inform certain test coverage improvements that we want to do before
231-
extending the production code to implement this enhancement.
232-
-->
233-
234210
- `k8s.io/component-base/traces`: no test grid results - k8s.io/component-base/traces/config_test.go
235211

236212
##### Integration tests
237213

238-
<!--
239-
This question should be filled when targeting a release.
240-
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
241-
For Beta and GA, add links to added tests together with links to k8s-triage for those tests:
242-
https://storage.googleapis.com/k8s-triage/index.html
243-
-->
244-
245214
An integration test will verify that spans exported by the kubelet match what is
246215
expected from the request. We will also add an integration test that verifies
247216
spans propagated from kubelet to API server match what is expected from the request.
248217

249218
##### e2e tests
250219

251-
<!--
252-
This question should be filled when targeting a release.
253-
For Alpha, describe what tests will be added to ensure proper quality of the enhancement.
254-
For Beta and GA, add links to added tests together with links to k8s-triage for those tests:
255-
https://storage.googleapis.com/k8s-triage/index.html
256-
We expect no non-infra related flakes in the last month as a GA graduation criteria.
257-
-->
258-
259220
- A test with kubelet-tracing & apiserver-tracing enabled to ensure no issues are introduced, regardless
260221
of whether a tracing backend is configured.
261222

262223
### Graduation Requirements
263224

264225
Alpha
265226

266-
- [] Implement tracing of incoming and outgoing gRPC, HTTP requests in the kubelet
267-
- [] Integration testing of tracing
227+
- [X] Implement tracing of incoming and outgoing gRPC, HTTP requests in the kubelet
228+
- [X] Integration testing of tracing
268229

269230
Beta
270231

271-
- [] Publish examples of how to use the OT Collector with kubernetes
272-
- [] Allow time for feedback
232+
- [X] OpenTelemetry reaches GA
233+
- [X] Publish examples of how to use the OT Collector with kubernetes
234+
- [X] Allow time for feedback
235+
- [] Add top level traces to connect spans in sync loops, incoming requests, and outgoing requests.
236+
- [] Unit/integration test to verify connected traces in kubelet.
273237
- [] Revisit the format used to export spans.
238+
- [] Parity with the old text-based Traces
274239

275240
GA
276241

@@ -442,6 +407,7 @@ _This section must be completed when targeting beta graduation to a release._
442407
- 2022-07-22: KEP merged, targeted at Alpha in 1.24
443408
- 2022-03-29: KEP deemed not ready for Alpha in 1.24
444409
- 2022-06-09: KEP targeted at Alpha in 1.25
410+
- 2023-01-09: KEP targeted at Beta in 1.27
445411

446412
## Drawbacks
447413

keps/sig-instrumentation/2831-kubelet-tracing/kep.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ kep-number: 2831
33
authors:
44
- "@husky-parul"
55
- "@somalley"
6+
- "@dashpole"
67
owning-sig: sig-instrumentation
78
participating-sigs:
89
- sig-architecture
@@ -18,12 +19,12 @@ approvers:
1819
see-also:
1920
- "https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/647-apiserver-tracing"
2021
replaces:
21-
stage: alpha
22-
latest-milestone: "v1.25"
22+
stage: beta
23+
latest-milestone: "v1.27"
2324
milestone:
2425
alpha: "v1.25"
25-
beta: "v1.26"
26-
stable: "v1.27"
26+
beta: "v1.27"
27+
stable: "v1.28"
2728
feature-gates:
2829
- name: KubeletTracing
2930
components:

0 commit comments

Comments
 (0)