Skip to content

Commit 73d3c0a

Browse files
author
Han Kang
committed
fix links and rename file for 2021 annual SIG instrumentation report
1 parent 9dfe232 commit 73d3c0a

File tree

2 files changed

+89
-232
lines changed

2 files changed

+89
-232
lines changed

sig-instrumentation/annual-report-2021.md

Lines changed: 89 additions & 57 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,121 @@ 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/custom-metrics-apiserver](https://github.com/kubernetes-sigs/custom-metrics-apiserver/blob/master/OWNERS) has 1 active approver
43+
- [kubernetes-sigs/metrics-server](https://github.com/kubernetes-sigs/metrics-server/blob/master/OWNERS) has 1 active approver
44+
- [kubernetes-sigs/prometheus-adapter](https://github.com/kubernetes-sigs/prometheus-adapter/blob/master/OWNERS_ALIASES) has 1 active approver
4545

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

48-
-
49-
-
50-
-
48+
- Devstats
49+
- [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
50+
- [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.
51+
- Meeting attendance
52+
- Meeting attendance is ~10 each week
53+
- Triage attendance is ~5 each week
54+
- Enhancement velocity
55+
- 7 Active enhancements over the year
5156

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

55-
-
60+
- 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.
5661

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

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

6267
5. Does the group have contributors from multiple companies/affiliations?
6368

64-
-
69+
- Yes: Red Hat, Google, Intel, ...
6570

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

69-
-
70-
-
74+
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.
75+
76+
### Summary
77+
78+
- **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%)
79+
- **Feature work:** needs significant ongoing additional investment, minimum of 2-3 FT devs or features will continue to slip
80+
81+
### Details
82+
83+
- **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)
84+
- Chairs/TLs currently perform the bulk of this work but even amongst the four of them, **do not** have 8h total weekly allocated
85+
- **Feature work:** requires significantly more investment from development and review time.
86+
- E.g. Structured logging initiative requires a minimum of 2 FT staff for the duration of feature development from beta -> GA
87+
- Additional metric stability classes and graduation: 1PT maintainer at 25% for the duration of feature development
88+
- SIG currently owns a number of KEPs stuck in alpha/beta due to lack of dev resources:
89+
- https://github.com/kubernetes/enhancements/issues/383
90+
- https://github.com/kubernetes/enhancements/issues/1668
91+
- https://github.com/kubernetes/enhancements/issues/1753
92+
- https://github.com/kubernetes/enhancements/issues/2305
93+
94+
### Subprojects
95+
96+
- Subprojects are currently mature/stable and mainly have KTLO needs
97+
- kube-state-metrics: 2-3 experienced maintainers at 5%, currently staffed
98+
- Metrics-server: 2 experienced maintainers at 5%, currently staffed
99+
- Custom-metrics-apiserver: 1 experienced maintainer at 5%, currently staffed
100+
- Klog: 2 experienced maintainers at 5%, has **no current staffing**
101+
- Prometheus-adapter: 2 experienced maintainers at 5%, has **no current staffing**
71102

72103
## Membership
73104

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 -->
105+
- Primary slack channel member count: 1,740
106+
- Primary mailing list member count: 324
107+
- Primary meeting attendee count (estimated, if needed): 8-12
108+
- Primary meeting participant count (estimated, if needed): 4-6
109+
- Unique reviewers for SIG-owned packages: 24 <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
110+
- Unique approvers for SIG-owned packages: 22 <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
80111

81112
Include any other ways you measure group membership
82113

114+
- 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.
115+
83116
## Subprojects
84117

85118
<!--
86119
In future, this will be generated from delta of sigs.yaml from $YYYY-01-01 to $YYYY-12-31
87120
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
88121
-->
89122

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

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

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

102141
## Working groups
103142

@@ -106,17 +145,8 @@ In future, this will be generated from delta of sigs.yaml from $YYYY-01-01 to $Y
106145
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
107146
-->
108147

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-
-
148+
New in 2021:
149+
- [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))
120150

121151
## Operational
122152

@@ -126,18 +156,20 @@ Operational tasks in [sig-governance.md]:
126156
- [ ] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
127157
(or created if missing and your contributor steps and experience are different or more
128158
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-
-
159+
- [x] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
160+
- [x] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
161+
- [x] Meeting notes and recordings for 2021 are linked from [README.md] and updated/uploaded if needed
162+
- [x] Did you have community-wide updates in 2021 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
163+
- [KubeCon EU 2021 SIG Update](https://sched.co/iE8c)
164+
- [KubeCon NA 2021 SIG Update](https://sched.co/lV72)
165+
- [Structured logging targeting 1.21 beta (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/vjSqUtPO0hs/m/wF91qunnBQAJ)
166+
- [WG Creation Request: WG Structured Logging (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/y4WIw-ntUR8/m/NaQHu1cnAwAJ)
167+
- [Deprecation: Dynamic log sanitization removal in 1.24 (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/xhQuwdd2Smw/m/L_EyHKbDAAAJ)
135168

136169
[CONTRIBUTING.md]: https://git.k8s.io/community/sig-instrumentation/CONTRIBUTING.md
137170
[contributor ladder]: https://git.k8s.io/community/community-membership.md
138171
[sig-governance.md]: https://git.k8s.io/community/committee-steering/governance/sig-governance.md
139172
[README.md]: https://git.k8s.io/community/sig-instrumentation/README.md
140173
[sigs.yaml]: https://git.k8s.io/community/sigs.yaml
141174
[contributor guide]: https://git.k8s.io/community/contributors/guide/README.md
142-
[devel]: https://git.k8s.io/community/contributors/devel/README.md
143-
175+
[devel]: https://git.k8s.io/community/contributors/devel/README.md

0 commit comments

Comments
 (0)