From 9d54d5466ba1f649398c620ecd4ab6b4230be754 Mon Sep 17 00:00:00 2001 From: Robert Findley Date: Mon, 6 May 2024 17:01:35 -0400 Subject: [PATCH] .github: simplify the telemetry proposal template Reduce the telemetry proposal template to make it easier to file telemetry proposals. At a high level, the proposal is just a request to merge a specific configuration change, so a free text rationale as well as proposed CL link should suffice. The proposal committee can make sure that all concerns about new uploading are addressed. Also, fix links to the chartconfig package documentation, as well as the config.txt file, and reference the new go.dev/doc/telemetry. Change-Id: I9eefba14967a18327abfcb2de427dc4bec6d659f Reviewed-on: https://go-review.googlesource.com/c/go/+/583496 LUCI-TryBot-Result: Go LUCI Auto-Submit: Robert Findley Reviewed-by: Hyang-Ah Hana Kim --- .github/ISSUE_TEMPLATE/12-telemetry.yml | 73 +++++++------------------ 1 file changed, 19 insertions(+), 54 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/12-telemetry.yml b/.github/ISSUE_TEMPLATE/12-telemetry.yml index 4215abfa99..5524659136 100644 --- a/.github/ISSUE_TEMPLATE/12-telemetry.yml +++ b/.github/ISSUE_TEMPLATE/12-telemetry.yml @@ -1,68 +1,33 @@ name: Go Telemetry Proposals -description: New telemetry counter or update on an existing one +description: | + Modify the telemetry upload configuration, by adding new counters to upload, + or refining or removing existing upload configuration. title: "x/telemetry/config: proposal title" labels: ["Telemetry-Proposal"] projects: ["golang/29"] body: - type: textarea attributes: - label: Counter names - description: Names of counters to add or update. - validations: - required: true -- type: textarea - attributes: - label: Description - description: What do these counters measure? - validations: - required: true -- type: textarea - attributes: - label: Rationale + label: Summary description: | - Why is the counter important? - For example, what new insights will it provide, and how will that information be used? - If this is about updating existing counters, why is the change necessary? - validations: - required: true -- type: textarea - attributes: - label: Do the counters carry sensitive user information? + What change are you proposing to the upload configuration, and why? + For new upload configuration, which new counters will be collected, what + do they measure, and why is it important to collect them? + All counters must already be instrumented in the target program. + Note that uploaded data must not carry sensitive user information. + See [go.dev/doc/telemetry#proposals](https://go.dev/doc/telemetry#proposals) + for more details on telemetry proposals. validations: required: true -- type: textarea +- type: input attributes: - label: How? + label: Proposed Config Change description: | - How do we plan to compute the info? - If available, include the code location or cl that uses the golang.org/x/telemetry/counter API. + A CL containing proposed changes to the + [config.txt](https://go.googlesource.com/telemetry/+/master/internal/chartconfig/config.txt) + chart configuration. + See the [chartconfig](https://pkg.go.dev/golang.org/x/telemetry/internal/chartconfig) + package for an explanation of the chart config format. + For an example change, see [CL 564619](https://go.dev/cl/564619). validations: required: true -- type: textarea - attributes: - label: Proposed Graph Config - description: | - Approved telemetry counters are maintained as [Go Telemetry Graph Config](https://golang.org/x/telemetry/internal/graphconfig) records. - Please draft the record entry for your proposal here. - If multiple records need to be included, separate them with `---` lines. - You can check the list of the approved counters and their current configuration in [config.txt](https://go.googlesource.com/telemetry/+/master/internal/configgen/config.txt). - render: Text - value: | - counter: gopls/bug - title: Gopls bug reports - description: Stacks of bugs encountered on the gopls server. - type: partition, histogram, stack # choose only one. - program: golang.org/x/tools/gopls - counter: gopls/bug - depth: 16 # only if type is stack. - version: v0.13.0 # the first binary version containing this counter. - validations: - required: true -- type: dropdown - attributes: - label: New or Update - description: Is this a new counter? See [config.txt](https://go.googlesource.com/telemetry/+/master/internal/configgen/config.txt) for the list of approved counters. - options: - - New - - Update - default: 0 -- 2.48.1