aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorHana (Hyang-Ah) Kim <hyangah@gmail.com>2023-09-13 20:52:51 -0400
committerHyang-Ah Hana Kim <hyangah@gmail.com>2023-09-14 21:29:10 +0000
commita278550c40ef3f01a5fcbef43414dc49009201f8 (patch)
treefce46da959f69228dab905435a0052cb256e0297 /.github
parente356aa656d92ffd551e89edd9ed6ac00ea0278ef (diff)
downloadgo-a278550c40ef3f01a5fcbef43414dc49009201f8.tar.gz
go-a278550c40ef3f01a5fcbef43414dc49009201f8.zip
.github: issue template for telemetry proposals
This uses the github's newer template syntax. https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms See https://github.com/hyangah/go/issues/new?assignees=&labels=Telemetry-Proposal&projects=hyangah%2F3&template=12-telemetry.yml&title=x%2Ftelemetryconfig%3A+ for demo. Change-Id: I13105711b1fe97680b505eefa1f0e7082e76e92c Reviewed-on: https://go-review.googlesource.com/c/go/+/528357 Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Robert Findley <rfindley@google.com>
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/12-telemetry.yml68
1 files changed, 68 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/12-telemetry.yml b/.github/ISSUE_TEMPLATE/12-telemetry.yml
new file mode 100644
index 0000000000..7f1a29c634
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/12-telemetry.yml
@@ -0,0 +1,68 @@
+name: Go Telemetry Proposals
+description: New telemetry counter or update on an existing one
+title: "x/telemetry/config: "
+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
+ 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?
+ validations:
+ required: true
+- type: textarea
+ attributes:
+ label: How?
+ 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.
+ 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