.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 <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Robert Findley <rfindley@google.com>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
This commit is contained in:
Robert Findley 2024-05-06 17:01:35 -04:00 committed by Gopher Robot
parent 9c4849bf20
commit 9d54d5466b

View File

@ -1,68 +1,33 @@
name: Go Telemetry Proposals 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" title: "x/telemetry/config: proposal title"
labels: ["Telemetry-Proposal"] labels: ["Telemetry-Proposal"]
projects: ["golang/29"] projects: ["golang/29"]
body: body:
- type: textarea - type: textarea
attributes: attributes:
label: Counter names label: Summary
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
description: | description: |
Why is the counter important? What change are you proposing to the upload configuration, and why?
For example, what new insights will it provide, and how will that information be used? For new upload configuration, which new counters will be collected, what
If this is about updating existing counters, why is the change necessary? 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: validations:
required: true required: true
- type: textarea - type: input
attributes: attributes:
label: Do the counters carry sensitive user information? label: Proposed Config Change
validations:
required: true
- type: textarea
attributes:
label: How?
description: | description: |
How do we plan to compute the info? A CL containing proposed changes to the
If available, include the code location or cl that uses the golang.org/x/telemetry/counter API. [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: validations:
required: true 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