Skip to content

Commit da9b664

Browse files
authored
Merge pull request #6463 from logicalhan/annual-report
2021 annual report for SIG instrumentation
2 parents 9b5b842 + 209c604 commit da9b664

File tree

1 file changed

+87
-58
lines changed

1 file changed

+87
-58
lines changed

sig-instrumentation/annual-report-2021.md

Lines changed: 87 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44

55
1. What work did the SIG do this year that should be highlighted?
66

7-
-
8-
-
9-
-
7+
- Formed WG Structured Logging. Successfully migrated multiple components to structured logs and graduated feature to beta.
8+
- Added tracing support to the Kubernetes API server and began work on Kubelet tracing.
9+
- Graduated the metrics stability framework.
1010

1111
2. What initiatives are you working on that aren't being tracked in KEPs?
1212

13-
-
14-
-
15-
-
13+
- Bi-weekly triage meeting
14+
- Subprojects (see below)
1615

1716
3. KEP work in 2021 (1.x, 1.y, 1.z):
1817

@@ -23,81 +22,118 @@ In future, this will be generated from kubernetes/enhancements kep.yaml files
2322
-->
2423

2524
- Stable
26-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable
27-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable
25+
- [1209 - Metrics Stability](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1209-metrics-stability) - 1.21
26+
- [1933 - Prevent logging secrets via static analysis](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1753-logs-sanitization) - 1.23
2827
- Beta
29-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta
30-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta
28+
- [1602 - Structured Logging](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1602-structured-logging) - 1.23
29+
- [1748 - Pod resource requests/limits metrics](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1748-pod-resource-metrics) - 1.22
3130
- Alpha
32-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha
33-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha
31+
- [2305 - Metrics Cardinality Enforcement](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2305-metrics-cardinality-enforcement) - 1.21
32+
- [647 - API Server Tracing](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/647-apiserver-tracing) - 1.22
33+
- [2845 - Deprecate klog-specific flags in k8s components](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2845-deprecate-klog-specific-flags-in-k8s-components) - 1.23
3434
- Pre-alpha
35-
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md)
35+
- [2831 - Kubelet OpenTelemetry Tracing](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2831-kubelet-tracing) - alpha in 1.24
3636

3737
## Project health
3838

3939
1. What areas and/or subprojects does your group need the most help with?
4040
Any areas with 2 or fewer OWNERs? (link to more details)
4141

42-
-
43-
-
44-
-
42+
- [kubernetes-sigs/prometheus-adapter](https://github.com/kubernetes-sigs/prometheus-adapter/blob/master/OWNERS_ALIASES) has 1 active approver
4543

4644
2. What metrics/community health stats does your group care about and/or measure?
4745

48-
-
49-
-
50-
-
46+
- Devstats
47+
- [Review Load](https://k8s.devstats.cncf.io/d/80/pr-workload-per-sig-and-repository-chart?orgId=1&var-sigs=%22instrumentation%22&var-repo_name=kubernetes%2Fkubernetes&var-repo=kuberneteskubernetes&from=now-1y&to=now) has been relatively level over the year
48+
- [Time to Approve and Merge](https://k8s.devstats.cncf.io/d/44/pr-time-to-approve-and-merge?orgId=1&var-period=d7&var-repogroup_name=SIG%20Instrumentation&var-repo_name=kubernetes%2Fkubernetes&var-apichange=All&var-size_name=All&var-kind_name=All) has been relatively low over the last year.
49+
- Meeting attendance
50+
- Meeting attendance is ~10 each week
51+
- Triage attendance is ~5 each week
52+
- Enhancement velocity
53+
- 7 Active enhancements over the year
5154

5255
3. Does your [CONTRIBUTING.md] help **new** contributors engage with your group specifically by pointing
5356
to activities or programs that provide useful context or allow easy participation?
5457

55-
-
58+
- We don't have our own CONTRIBUTING.md as the overall one is suitable for our SIG. However, we have [filed an issue](https://github.com/kubernetes/community/issues/6462) to create one to better document how to get involved with our subprojects.
5659

5760
4. If your group has special training, requirements for reviewers/approvers, or processes beyond the general [contributor guide],
5861
does your [CONTRIBUTING.md] document those to help **existing** contributors grow throughout the [contributor ladder]?
5962

60-
-
63+
- N/A, we don't have special training or requirements
6164

6265
5. Does the group have contributors from multiple companies/affiliations?
6366

64-
-
67+
- Yes: Google, Red Hat, Sony, VMware, Intel, independent contributors, and more
6568

6669
6. Are there ways end users/companies can contribute that they currently are not?
6770
If one of those ways is more full time support, what would they work on and why?
6871

69-
-
70-
-
72+
SIG leads performed a [staffing and gap analysis](https://docs.google.com/document/d/1qeoP6i7GBTVJuJE1AGY5iU9dqmAOxrjqkfNQ2-rBeyI/edit#heading=h.849b7ydpl7ip) for the SIG's projects. We definitely can use more help, and need more part-time/full-time contributors.
73+
74+
### Summary
75+
76+
- **KTLO:** 4 leads at 5%, 2 maintainers at 10% for core, 9-10 maintainers at 5% for 5 subprojects (can have overlap between roles, but need a minimum of 3-4 part-time contributors at 25%)
77+
- **Feature work:** needs significant ongoing additional investment, minimum of 2-3 FT devs or features will continue to slip
78+
79+
### Details
80+
81+
- **KTLO:** Requires two experienced part-time maintainers at 10% (e.g. 2x4h = 8h/wk) in addition to the SIG leadership (chairs/TLs @ minimum of 2h/wk)
82+
- Chairs/TLs currently perform the bulk of this work but even amongst the four of them, **do not** have 8h total weekly allocated
83+
- **Feature work:** requires significantly more investment from development and review time.
84+
- E.g. Structured logging initiative requires a minimum of 2 FT staff for the duration of feature development from beta -> GA
85+
- Additional metric stability classes and graduation: 1PT maintainer at 25% for the duration of feature development
86+
- SIG currently owns a number of KEPs stuck in alpha/beta due to lack of dev resources:
87+
- https://github.com/kubernetes/enhancements/issues/383
88+
- https://github.com/kubernetes/enhancements/issues/1753
89+
- https://github.com/kubernetes/enhancements/issues/2305
90+
91+
### Subprojects
92+
93+
- Subprojects are currently mature/stable and mainly have KTLO needs
94+
- kube-state-metrics: 2-3 experienced maintainers at 5%, currently staffed
95+
- Metrics-server: 2 experienced maintainers at 5%, currently staffed
96+
- Custom-metrics-apiserver: 1 experienced maintainer at 5%, currently staffed
97+
- Klog: 2 experienced maintainers at 5%, has **no current staffing**
98+
- Prometheus-adapter: 2 experienced maintainers at 5%, has **no current staffing**
7199

72100
## Membership
73101

74-
- Primary slack channel member count:
75-
- Primary mailing list member count:
76-
- Primary meeting attendee count (estimated, if needed):
77-
- Primary meeting participant count (estimated, if needed):
78-
- Unique reviewers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
79-
- Unique approvers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
102+
- Primary slack channel member count: 1,740
103+
- Primary mailing list member count: 324
104+
- Primary meeting attendee count (estimated, if needed): 8-12
105+
- Primary meeting participant count (estimated, if needed): 4-6
106+
- Unique reviewers for SIG-owned packages: 24 <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
107+
- Unique approvers for SIG-owned packages: 22 <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
80108

81109
Include any other ways you measure group membership
82110

111+
- We track active members in the SIG primarily based on devstats and meeting participation, and maintain an up-to-date roster of members in [kubernetes/org](https://github.com/kubernetes/org/blob/main/config/kubernetes/sig-instrumentation/teams.yaml). These teams also serve as aliases for GitHub pings.
112+
83113
## Subprojects
84114

85115
<!--
86116
In future, this will be generated from delta of sigs.yaml from $YYYY-01-01 to $YYYY-12-31
87117
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
88118
-->
89119

90-
New in $YYYY:
91-
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
92-
-
120+
New in 2021:
121+
- [instrumentation](https://github.com/kubernetes-sigs/instrumentation)
122+
- [instrumentation-addons](https://github.com/kubernetes-sigs/instrumentation-addons)
93123

94-
Retired in $YYYY:
95-
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
96-
-
124+
Retired in 2021:
125+
- [mutating-trace-admission-controller](https://github.com/kubernetes-retired/mutating-trace-admission-controller)
97126

98127
Continuing:
99-
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
100-
-
128+
- [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics)
129+
- [metrics](https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/metrics)
130+
- [custom-metrics-apiserver](https://github.com/kubernetes-sigs/custom-metrics-apiserver)
131+
- [metrics-server](https://github.com/kubernetes-sigs/metrics-server)
132+
- [prometheus-adapter](https://github.com/kubernetes-sigs/prometheus-adapter)
133+
- [klog](https://github.com/kubernetes/klog)
134+
- [structured-logging](https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/component-base/logs)
135+
- [metric-stability-framework](https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/component-base/metrics)
136+
- [instrumentation-tools](https://github.com/kubernetes-sigs/instrumentation-tools)
101137

102138
## Working groups
103139

@@ -106,38 +142,31 @@ In future, this will be generated from delta of sigs.yaml from $YYYY-01-01 to $Y
106142
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
107143
-->
108144

109-
New in $YYYY:
110-
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
111-
-
112-
113-
Retired in $YYYY:
114-
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
115-
-
116-
117-
Continuing:
118-
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
119-
-
145+
New in 2021:
146+
- [WG Structured Logging](https://github.com/kubernetes/community/tree/master/wg-structured-logging) ([2021 report](https://github.com/kubernetes/community/blob/master/wg-structured-logging/annual-report-2021.md))
120147

121148
## Operational
122149

123150
Operational tasks in [sig-governance.md]:
124151

125152
- [ ] [README.md] reviewed for accuracy and updated if needed
126-
- [ ] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
153+
- [x] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
127154
(or created if missing and your contributor steps and experience are different or more
128155
in-depth than the documentation listed in the general [contributor guide] and [devel] folder.)
129-
- [ ] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
130-
- [ ] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
131-
- [ ] Meeting notes and recordings for 2021 are linked from [README.md] and updated/uploaded if needed
132-
- [ ] Did you have community-wide updates in 2021 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
133-
-
134-
-
156+
- [x] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
157+
- [x] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
158+
- [x] Meeting notes and recordings for 2021 are linked from [README.md] and updated/uploaded if needed
159+
- [x] Did you have community-wide updates in 2021 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
160+
- [KubeCon EU 2021 SIG Update](https://sched.co/iE8c)
161+
- [KubeCon NA 2021 SIG Update](https://sched.co/lV72)
162+
- [Structured logging targeting 1.21 beta (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/vjSqUtPO0hs/m/wF91qunnBQAJ)
163+
- [WG Creation Request: WG Structured Logging (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/y4WIw-ntUR8/m/NaQHu1cnAwAJ)
164+
- [Deprecation: Dynamic log sanitization removal in 1.24 (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/xhQuwdd2Smw/m/L_EyHKbDAAAJ)
135165

136166
[CONTRIBUTING.md]: https://git.k8s.io/community/sig-instrumentation/CONTRIBUTING.md
137167
[contributor ladder]: https://git.k8s.io/community/community-membership.md
138168
[sig-governance.md]: https://git.k8s.io/community/committee-steering/governance/sig-governance.md
139169
[README.md]: https://git.k8s.io/community/sig-instrumentation/README.md
140170
[sigs.yaml]: https://git.k8s.io/community/sigs.yaml
141171
[contributor guide]: https://git.k8s.io/community/contributors/guide/README.md
142-
[devel]: https://git.k8s.io/community/contributors/devel/README.md
143-
172+
[devel]: https://git.k8s.io/community/contributors/devel/README.md

0 commit comments

Comments
 (0)