diff --git a/sig-instrumentation/annual-report-2021.md b/sig-instrumentation/annual-report-2021.md index 6f200a4e5..14e84a6f1 100644 --- a/sig-instrumentation/annual-report-2021.md +++ b/sig-instrumentation/annual-report-2021.md @@ -4,15 +4,14 @@ 1. What work did the SIG do this year that should be highlighted? - - - - - - + - Formed WG Structured Logging. Successfully migrated multiple components to structured logs and graduated feature to beta. + - Added tracing support to the Kubernetes API server and began work on Kubelet tracing. + - Graduated the metrics stability framework. 2. What initiatives are you working on that aren't being tracked in KEPs? - - - - - - + - Bi-weekly triage meeting + - Subprojects (see below) 3. KEP work in 2021 (1.x, 1.y, 1.z): @@ -23,63 +22,94 @@ In future, this will be generated from kubernetes/enhancements kep.yaml files --> - Stable - - [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable - - [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable + - [1209 - Metrics Stability](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1209-metrics-stability) - 1.21 + - [1933 - Prevent logging secrets via static analysis](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1753-logs-sanitization) - 1.23 - Beta - - [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta - - [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta + - [1602 - Structured Logging](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1602-structured-logging) - 1.23 + - [1748 - Pod resource requests/limits metrics](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1748-pod-resource-metrics) - 1.22 - Alpha - - [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha - - [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha + - [2305 - Metrics Cardinality Enforcement](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2305-metrics-cardinality-enforcement) - 1.21 + - [647 - API Server Tracing](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/647-apiserver-tracing) - 1.22 + - [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 - Pre-alpha - - [$kep-number - $title](https://git.k8s.io/community/$link/README.md) + - [2831 - Kubelet OpenTelemetry Tracing](https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/2831-kubelet-tracing) - alpha in 1.24 ## Project health 1. What areas and/or subprojects does your group need the most help with? Any areas with 2 or fewer OWNERs? (link to more details) - - - - - - + - [kubernetes-sigs/prometheus-adapter](https://github.com/kubernetes-sigs/prometheus-adapter/blob/master/OWNERS_ALIASES) has 1 active approver 2. What metrics/community health stats does your group care about and/or measure? - - - - - - + - Devstats + - [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 + - [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. + - Meeting attendance + - Meeting attendance is ~10 each week + - Triage attendance is ~5 each week + - Enhancement velocity + - 7 Active enhancements over the year 3. Does your [CONTRIBUTING.md] help **new** contributors engage with your group specifically by pointing to activities or programs that provide useful context or allow easy participation? - - + - 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. 4. If your group has special training, requirements for reviewers/approvers, or processes beyond the general [contributor guide], does your [CONTRIBUTING.md] document those to help **existing** contributors grow throughout the [contributor ladder]? - - + - N/A, we don't have special training or requirements 5. Does the group have contributors from multiple companies/affiliations? - - + - Yes: Google, Red Hat, Sony, VMware, Intel, independent contributors, and more 6. Are there ways end users/companies can contribute that they currently are not? If one of those ways is more full time support, what would they work on and why? - - - - +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. + +### Summary + +- **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%) +- **Feature work:** needs significant ongoing additional investment, minimum of 2-3 FT devs or features will continue to slip + +### Details + +- **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) + - Chairs/TLs currently perform the bulk of this work but even amongst the four of them, **do not** have 8h total weekly allocated +- **Feature work:** requires significantly more investment from development and review time. + - E.g. Structured logging initiative requires a minimum of 2 FT staff for the duration of feature development from beta -> GA + - Additional metric stability classes and graduation: 1PT maintainer at 25% for the duration of feature development + - SIG currently owns a number of KEPs stuck in alpha/beta due to lack of dev resources: + - https://github.com/kubernetes/enhancements/issues/383 + - https://github.com/kubernetes/enhancements/issues/1753 + - https://github.com/kubernetes/enhancements/issues/2305 + +### Subprojects + +- Subprojects are currently mature/stable and mainly have KTLO needs +- kube-state-metrics: 2-3 experienced maintainers at 5%, currently staffed +- Metrics-server: 2 experienced maintainers at 5%, currently staffed +- Custom-metrics-apiserver: 1 experienced maintainer at 5%, currently staffed +- Klog: 2 experienced maintainers at 5%, has **no current staffing** +- Prometheus-adapter: 2 experienced maintainers at 5%, has **no current staffing** ## Membership -- Primary slack channel member count: -- Primary mailing list member count: -- Primary meeting attendee count (estimated, if needed): -- Primary meeting participant count (estimated, if needed): -- Unique reviewers for SIG-owned packages: -- Unique approvers for SIG-owned packages: +- Primary slack channel member count: 1,740 +- Primary mailing list member count: 324 +- Primary meeting attendee count (estimated, if needed): 8-12 +- Primary meeting participant count (estimated, if needed): 4-6 +- Unique reviewers for SIG-owned packages: 24 +- Unique approvers for SIG-owned packages: 22 Include any other ways you measure group membership +- 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. + ## Subprojects -New in $YYYY: -- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name) -- +New in 2021: +- [instrumentation](https://github.com/kubernetes-sigs/instrumentation) +- [instrumentation-addons](https://github.com/kubernetes-sigs/instrumentation-addons) -Retired in $YYYY: -- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name) -- +Retired in 2021: +- [mutating-trace-admission-controller](https://github.com/kubernetes-retired/mutating-trace-admission-controller) Continuing: -- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name) -- +- [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) +- [metrics](https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/metrics) +- [custom-metrics-apiserver](https://github.com/kubernetes-sigs/custom-metrics-apiserver) +- [metrics-server](https://github.com/kubernetes-sigs/metrics-server) +- [prometheus-adapter](https://github.com/kubernetes-sigs/prometheus-adapter) +- [klog](https://github.com/kubernetes/klog) +- [structured-logging](https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/component-base/logs) +- [metric-stability-framework](https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/component-base/metrics) +- [instrumentation-tools](https://github.com/kubernetes-sigs/instrumentation-tools) ## Working groups @@ -106,32 +142,26 @@ In future, this will be generated from delta of sigs.yaml from $YYYY-01-01 to $Y Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md` --> -New in $YYYY: -- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md)) -- - -Retired in $YYYY: -- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md)) -- - -Continuing: -- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md)) -- +New in 2021: +- [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)) ## Operational Operational tasks in [sig-governance.md]: - [ ] [README.md] reviewed for accuracy and updated if needed -- [ ] [CONTRIBUTING.md] reviewed for accuracy and updated if needed +- [x] [CONTRIBUTING.md] reviewed for accuracy and updated if needed (or created if missing and your contributor steps and experience are different or more in-depth than the documentation listed in the general [contributor guide] and [devel] folder.) -- [ ] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed -- [ ] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed -- [ ] Meeting notes and recordings for 2021 are linked from [README.md] and updated/uploaded if needed -- [ ] Did you have community-wide updates in 2021 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings: - - - - +- [x] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed +- [x] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed +- [x] Meeting notes and recordings for 2021 are linked from [README.md] and updated/uploaded if needed +- [x] Did you have community-wide updates in 2021 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings: + - [KubeCon EU 2021 SIG Update](https://sched.co/iE8c) + - [KubeCon NA 2021 SIG Update](https://sched.co/lV72) + - [Structured logging targeting 1.21 beta (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/vjSqUtPO0hs/m/wF91qunnBQAJ) + - [WG Creation Request: WG Structured Logging (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/y4WIw-ntUR8/m/NaQHu1cnAwAJ) + - [Deprecation: Dynamic log sanitization removal in 1.24 (kubernetes-dev@)](https://groups.google.com/g/kubernetes-dev/c/xhQuwdd2Smw/m/L_EyHKbDAAAJ) [CONTRIBUTING.md]: https://git.k8s.io/community/sig-instrumentation/CONTRIBUTING.md [contributor ladder]: https://git.k8s.io/community/community-membership.md @@ -139,5 +169,4 @@ Operational tasks in [sig-governance.md]: [README.md]: https://git.k8s.io/community/sig-instrumentation/README.md [sigs.yaml]: https://git.k8s.io/community/sigs.yaml [contributor guide]: https://git.k8s.io/community/contributors/guide/README.md -[devel]: https://git.k8s.io/community/contributors/devel/README.md - +[devel]: https://git.k8s.io/community/contributors/devel/README.md \ No newline at end of file